Package org.apache.juneau.rest.server.httppart

Class RequestHeader

java.lang.Object

org.apache.juneau.rest.server.httppart.RequestHttpPart

org.apache.juneau.rest.server.httppart.RequestHeader

All Implemented Interfaces:

HttpHeader

public class RequestHeader
extends RequestHttpPart
implements HttpHeader

Represents a single header on an HTTP request.

Typically accessed through the RequestHeaderList 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()
    • asCsvHeader()
    • asDate()
    • asDateHeader()
    • asEntityTagsHeader()
    • asEntityTagHeader()
    • asInteger()
    • asIntegerHeader()
    • asLong()
    • asLongHeader()
    • asMatcher(Pattern)
    • asMatcher(String)
    • asMatcher(String,int)
    • asStringHeader()
    • asStringRangesHeader()
    • 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 in REST servers

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
HttpBooleanHeader	asBooleanHeader()	Returns the value of this header as an HttpBooleanHeader.
HttpCsvHeader	asCsvHeader()	Returns the value of this header as an HttpCsvHeader.
HttpDateHeader	asDateHeader()	Returns the value of this header as an HttpDateHeader.
HttpEntityTagHeader	asEntityTagHeader()	Returns the value of this header as an HttpEntityTagHeader.
HttpEntityTagsHeader	asEntityTagsHeader()	Returns the value of this header as an HttpEntityTagsHeader.
HttpIntegerHeader	asIntegerHeader()	Returns the value of this header as an HttpIntegerHeader.
HttpLongHeader	asLongHeader()	Returns the value of this header as an HttpLongHeader.
HttpStringHeader	asStringHeader()	Returns the value of this header as an HttpStringHeader.
HttpStringRangesHeader	asStringRangesHeader()	Returns the value of this header as an HttpStringRangesHeader.
HttpUriHeader	asUriHeader()	Returns the value of this header as an HttpUriHeader.
RequestHeader	def(String def)	Sets a default value for this part.
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.server.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, equals, get, getName, getRequest, getValue, hashCode, isPresent, orElse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.juneau.http.HttpHeader

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 HttpBooleanHeader asBooleanHeader()

Returns the value of this header as an HttpBooleanHeader.

Returns:

The value of this header as an HttpBooleanHeader, never null.

asCsvHeader

public HttpCsvHeader asCsvHeader()

Returns the value of this header as an HttpCsvHeader.

Returns:

The value of this header as an HttpCsvHeader, never null.

asDateHeader

public HttpDateHeader asDateHeader()

Returns the value of this header as an HttpDateHeader.

Returns:

The value of this header as an HttpDateHeader, never null.

asEntityTagHeader

public HttpEntityTagHeader asEntityTagHeader()

Returns the value of this header as an HttpEntityTagHeader.

Returns:

The value of this header as an HttpEntityTagHeader, never null.

asEntityTagsHeader

public HttpEntityTagsHeader asEntityTagsHeader()

Returns the value of this header as an HttpEntityTagsHeader.

Returns:

The value of this header as an HttpEntityTagsHeader, never null.

asIntegerHeader

public HttpIntegerHeader asIntegerHeader()

Returns the value of this header as an HttpIntegerHeader.

Returns:

The value of this header as an HttpIntegerHeader, never null.

asLongHeader

public HttpLongHeader asLongHeader()

Returns the value of this header as an HttpLongHeader.

Returns:

The value of this header as an HttpLongHeader, never null.

asStringHeader

public HttpStringHeader asStringHeader()

Returns the value of this header as an HttpStringHeader.

Returns:

The value of this header as an HttpStringHeader, never null.

asStringRangesHeader

public HttpStringRangesHeader asStringRangesHeader()

Returns the value of this header as an HttpStringRangesHeader.

Returns:

The value of this header as an HttpStringRangesHeader, never null.

asUriHeader

public HttpUriHeader asUriHeader()

Returns the value of this header as an HttpUriHeader.

Returns:

The value of this header as an HttpUriHeader, 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.

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 resource via @Rest(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