Package org.forgerock.http.header

Class LocationHeader

  • public final class LocationHeader
extends Header
    Processes the Location message header. For more information see RFC 2616 ยง14.30.

    • Constructor Detail

      • LocationHeader

        public LocationHeader()
        Constructs a new empty header whose location is null.

      • LocationHeader

        public LocationHeader​(String locationUri)
        Constructs a new header with the provided location URI.
        Parameters:
        locationUri - The location URI, or null if no location has been set.

    • Method Detail

      • valueOf

        public static LocationHeader valueOf​(Message<?> message)
        Constructs a new header, initialized from the specified message.
        Parameters:
        message - The message to initialize the header from.
        Returns:
        The parsed header.

      • valueOf

        public static LocationHeader valueOf​(String string)
        Constructs a new header, initialized from the specified string value.
        Parameters:
        string - The value to initialize the header from.
        Returns:
        The parsed header.

      • getLocationUri

        public String getLocationUri()
        Returns the location URI or null if empty.
        Returns:
        The location URI or null if empty.

      • getName

        public String getName()
        Description copied from class: Header
        Returns the name of the header, as it would canonically appear within an HTTP message.
        Specified by:
        getName in class Header
        Returns:
        The name of the header, as it would canonically appear within an HTTP message.

      • getValues

        public List<String> getValues()
        Description copied from class: Header
        Returns the header as a list of strings. If the header has no values then it must return an empty list, never null. Each String should represent the value component of the key-value pair that makes up the HTTP header - as such, for some Header implementations each String in this List may contain multiple token-separated values.

        The List returned from this method should not be expected to be mutable. However, some subclasses of Header may choose to implement it as such.

        Specified by:
        getValues in class Header
        Returns:
        The header as a non-null list of string values. Can be an empty list.