Package org.apache.juneau.rest.httppart

Class RequestHeader

java.lang.Object

org.apache.juneau.rest.httppart.RequestHttpPart

org.apache.juneau.rest.httppart.RequestHeader

All Implemented Interfaces:

Header, NameValuePair

public class RequestHeader
extends RequestHttpPart
implements Header

Represents a single header on an HTTP request.

Typically accessed through the RequestHeaders class.

Some important methods on this class are:

• RequestHeader
  • Methods for retrieving simple string values:
    • asString()
    • get()
    • isPresent()
    • orElse(String)
  • Methods for retrieving as other common types:
    • asBoolean()
    • asBooleanHeader()
    • asCsvArray()
    • asCsvArrayHeader()
    • asDate()
    • asDateHeader()
    • asEntityTagArrayHeader()
    • asEntityTagHeader()
    • asInteger()
    • asIntegerHeader()
    • asLong()
    • asLongHeader()
    • asMatcher(Pattern)
    • asMatcher(String)
    • asMatcher(String,int)
    • asStringHeader()
    • asStringRangeArrayHeader()
    • asUriHeader()
  • Methods for retrieving as custom types:
    • as(Class)
    • as(ClassMeta)
    • as(Type,Type...)
    • parser(HttpPartParserSession)
    • schema(HttpPartSchema)
  • Methods for performing assertion checks:
    • assertCsvArray()
    • assertDate()
    • assertInteger()
    • assertLong()
    • assertString()
  • Other methods:
    • getName()
    • getValue()

  See Also:

  • HTTP Parts

Constructor Summary

Constructors

Constructor	Description
RequestHeader(RestRequest request, String name, String value)	Constructor.

Method Summary

Modifier and Type	Method	Description
BasicBooleanHeader	asBooleanHeader()	Returns the value of this header as a BasicBooleanHeader.
BasicCsvHeader	asCsvHeader()	Returns the value of this header as a BasicCsvHeader.
BasicDateHeader	asDateHeader()	Returns the value of this header as a BasicDateHeader.
BasicEntityTagHeader	asEntityTagHeader()	Returns the value of this header as a BasicEntityTagHeader.
BasicEntityTagsHeader	asEntityTagsHeader()	Returns the value of this header as a BasicEntityTagsHeader.
BasicIntegerHeader	asIntegerHeader()	Returns the value of this header as a BasicIntegerHeader.
BasicLongHeader	asLongHeader()	Returns the value of this header as a BasicLongHeader.
BasicStringHeader	asStringHeader()	Returns the value of this header as a BasicStringHeader.
BasicStringRangesHeader	asStringRangesHeader()	Returns the value of this header as a BasicStringRangesHeader.
BasicUriHeader	asUriHeader()	Returns the value of this header as a BasicUriHeader.
RequestHeader	def(String def)	Sets a default value for this part.
HeaderElement[]	getElements()	Parses the value.
RequestHeader	parser(HttpPartParserSession value)	Specifies the part parser to use for this part.
RequestHeader	schema(HttpPartSchema value)	Specifies the part schema for this part.
String	toString()

Methods inherited from class org.apache.juneau.rest.httppart.RequestHttpPart

as, as, as, asBoolean, asBooleanPart, asCsvArray, asCsvArrayPart, asDate, asDatePart, asInteger, asIntegerPart, asLong, asLongPart, asMatcher, asMatcher, asMatcher, assertCsvArray, assertDate, assertInteger, assertLong, assertString, asString, asStringPart, asUriPart, get, getName, getRequest, getValue, isPresent, orElse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.http.NameValuePair

getName, getValue

Constructor Details

RequestHeader

public RequestHeader(RestRequest request,
 String name,
 String value)

Constructor.

Parameters:

request - The request object.

name - The header name.

value - The header value.

Method Details

asBooleanHeader

public BasicBooleanHeader asBooleanHeader()

Returns the value of this header as a BasicBooleanHeader.

Returns:

The value of this header as a BasicBooleanHeader, never null.

asCsvHeader

public BasicCsvHeader asCsvHeader()

Returns the value of this header as a BasicCsvHeader.

Returns:

The value of this header as a BasicCsvHeader, never null.

asDateHeader

public BasicDateHeader asDateHeader()

Returns the value of this header as a BasicDateHeader.

Returns:

The value of this header as a BasicDateHeader, never null.

asEntityTagHeader

public BasicEntityTagHeader asEntityTagHeader()

Returns the value of this header as a BasicEntityTagHeader.

Returns:

The value of this header as a BasicEntityTagHeader, never null.

asEntityTagsHeader

public BasicEntityTagsHeader asEntityTagsHeader()

Returns the value of this header as a BasicEntityTagsHeader.

Returns:

The value of this header as a BasicEntityTagsHeader, never null.

asIntegerHeader

public BasicIntegerHeader asIntegerHeader()

Returns the value of this header as a BasicIntegerHeader.

Returns:

The value of this header as a BasicIntegerHeader, never null.

asLongHeader

public BasicLongHeader asLongHeader()

Returns the value of this header as a BasicLongHeader.

Returns:

The value of this header as a BasicLongHeader, never null.

asStringHeader

public BasicStringHeader asStringHeader()

Returns the value of this header as a BasicStringHeader.

Returns:

The value of this header as a BasicStringHeader, never null.

asStringRangesHeader

public BasicStringRangesHeader asStringRangesHeader()

Returns the value of this header as a BasicStringRangesHeader.

Returns:

The value of this header as a BasicStringRangesHeader, never null.

asUriHeader

public BasicUriHeader asUriHeader()

Returns the value of this header as a BasicUriHeader.

Returns:

The value of this header as a BasicUriHeader, never null.

def

public RequestHeader def(String def)

Description copied from class: RequestHttpPart

Sets a default value for this part.

Overrides:

def in class RequestHttpPart

Parameters:

def - The default value.

Returns:

This object.

getElements

public HeaderElement[] getElements()
                            throws BasicHttpException

Parses the value.

Specified by:

getElements in interface Header

Returns:

An array of HeaderElement entries, may be empty, but is never null.

Throws:

BasicHttpException - In case of a parsing error.

parser

public RequestHeader parser(HttpPartParserSession value)

Description copied from class: RequestHttpPart

Specifies the part parser to use for this part.

If not specified, uses the part parser defined on the client by calling RestContext.Builder.partParser().

Overrides:

parser in class RequestHttpPart

Parameters:

value - The new part parser to use for this part.
If null, SimplePartParser.DEFAULT will be used.

Returns:

This object.

schema

public RequestHeader schema(HttpPartSchema value)

Description copied from class: RequestHttpPart

Specifies the part schema for this part.

Used by schema-based part parsers such as OpenApiParser.

Overrides:

schema in class RequestHttpPart

Parameters:

value - The part schema.

Returns:

This object.

toString

public String toString()

Overrides:

toString in class RequestHttpPart