Package com.authlete.http

Class ForwardedPair

java.lang.Object
com.authlete.http.ForwardedPair
All Implemented Interfaces:
Serializable
public class ForwardedPair extends Object implements Serializable
This class represents the forwarded pair as defined in RFC 7239: Forwarded HTTP Extension, Section 4. Forwarded HTTP Header Field.

Definition

 Forwarded   = 1#forwarded-element

 forwarded-element =
     [ forwarded-pair ] *( ";" [ forwarded-pair ] )

 forwarded-pair = token "=" value
 value          = token / quoted-string

 token = <Defined in [RFC7230], Section 3.2.6>
 quoted-string = <Defined in [RFC7230], Section 3.2.6>

Sample Code 1

 // Parse the string as a forwarded pair.
 ForwardedPair pair = ForwardedPair.parse("name=value");
 assertNotNull(pair);

 // The name of the forwarded pair.
 Token name = pair.getName();
 assertNotNull(name);
 assertEquals("name", name.getValue());

 // The value of the forwarded pair.
 Object value = pair.getValue();
 assertNotNull(value);
 assertEquals(Token.class, value.getClass());
 assertEquals("value", ((Token)value).getValue());

Sample Code 2

 // Parse the string as a forwarded pair.
 ForwardedPair pair = ForwardedPair.parse("name=\"value\"");
 assertNotNull(pair);

 // The name of the forwarded pair.
 Token name = pair.getName();
 assertNotNull(name);
 assertEquals("name", name.getValue());

 // The value of the forwarded pair. Note that this time
 // the getValue() method returns a QuotedString instance.
 Object value = pair.getValue();
 assertNotNull(value);
 assertEquals(QuotedString.class, value.getClass());
 assertEquals("value", ((QuotedString)value).getValue());
See Also: