Package org.apache.juneau.http.classic.header

Class ContentLocation

java.lang.Object
org.apache.juneau.http.classic.header.BasicHeader
org.apache.juneau.http.classic.header.BasicUriHeader
org.apache.juneau.http.classic.header.ContentLocation
All Implemented Interfaces:
Serializable, Header, NameValuePair
@Header("Content-Location") public class ContentLocation extends BasicUriHeader
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:

  • Constructor Details

    • ContentLocation

      public ContentLocation(String value)
      Constructor.
      Parameters:
      value - The header value.
      Must be parsable by URI.create(String).
      Can be null to create a header with no value.

    • ContentLocation

      public ContentLocation(Supplier<URI> value)
      Constructor with delayed value.

      Header value is re-evaluated on each call to BasicUriHeader.getValue().

      Parameters:
      value - The supplier of the header value.
      Can be null to create a header with no value.

    • ContentLocation

      public ContentLocation(URI value)
      Constructor.
      Parameters:
      value - The header value.
      Can be null to create a header with no value.

  • Method Details

    • of

      public static ContentLocation of(String value)
      Static creator.
      Parameters:
      value - The header value.
      Must be parsable by URI.create(String).
      Can be null.
      Returns:
      A new header bean, or null if the value is null.

    • of

      public static ContentLocation of(Supplier<URI> value)
      Static creator with delayed value.

      Header value is re-evaluated on each call to BasicUriHeader.getValue().

      Parameters:
      value - The supplier of the header value.
      Can be null.
      Returns:
      A new header bean, or null if the value is null.

    • of

      public static ContentLocation of(URI value)
      Static creator.
      Parameters:
      value - The header value.
      Can be null.
      Returns:
      A new header bean, or null if the value is null.