org.apache.juneau.http.ContentLocation Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.http;
import org.apache.juneau.http.annotation.*;
/**
* Represents a parsed Content-Location HTTP response header.
*
*
* An alternate location for the returned data.
*
*
Example
*
* Content-Location: /index.htm
*
*
* RFC2616 Specification
*
* The Content-Location entity-header field MAY be used to supply the resource location for the entity enclosed in the
* message when that entity is accessible from a location separate from the requested resource's URI.
* A server SHOULD provide a Content-Location for the variant corresponding to the response entity; especially in the
* case where a resource has multiple entities associated with it, and those entities actually have separate locations
* by which they might be individually accessed, the server SHOULD provide a Content-Location for the particular variant
* which is returned.
*
* Content-Location = "Content-Location" ":"
* ( absoluteURI | relativeURI )
*
*
*
* The value of Content-Location also defines the base URI for the entity.
*
*
* The Content-Location value is not a replacement for the original requested URI; it is only a statement of the
* location of the resource corresponding to this particular entity at the time of the request.
* Future requests MAY specify the Content-Location URI as the request- URI if the desire is to identify the source of
* that particular entity.
*
*
* A cache cannot assume that an entity with a Content-Location different from the URI used to retrieve it can be used
* to respond to later requests on that Content-Location URI.
* However, the Content- Location can be used to differentiate between multiple entities retrieved from a single
* requested resource, as described in section 13.6.
*
*
* If the Content-Location is a relative URI, the relative URI is interpreted relative to the Request-URI.
*
*
* The meaning of the Content-Location header in PUT or POST requests is undefined; servers are free to ignore it in
* those cases.
*
*
See Also:
*
* - {@doc RFC2616}
*
*/
@Header("Content-Location")
public final class ContentLocation extends HeaderUri {
/**
* Returns a parsed Content-Location header.
*
* @param value The Content-Location header string.
* @return The parsed Content-Location header, or null if the string was null.
*/
public static ContentLocation forString(String value) {
if (value == null)
return null;
return new ContentLocation(value);
}
private ContentLocation(String value) {
super(value);
}
}