Top Description Inners Fields Constructors Methods
org.eclipse.jetty.http

public Class MetaData

extends Object
implements Iterable<HttpField>
Class Inheritance
All Implemented Interfaces
java.lang.Iterable
Known Direct Subclasses
org.eclipse.jetty.http.MetaData.Request, org.eclipse.jetty.http.MetaData.Response
Imports
java.util.Iterator, .Objects, java.util.function.Supplier, org.eclipse.jetty.util.NanoTime

Immutable common HTTP information for requests and responses.

Specific HTTP request information is captured by Request.

Specific HTTP response information is captured by Response.

HTTP trailers information is captured by MetaData.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
MetaData.ConnectRequest

Immutable HTTP CONNECT request information.

public static class
MetaData.Request

Immutable HTTP request information.

public static class
MetaData.Response

Immutable HTTP response information.

Field Summary

Modifier and TypeField and Description
private final long
_contentLength

private final HttpFields
_httpFields

private final HttpVersion
_httpVersion

private final Supplier<HttpFields>
_trailers

Constructor Summary

AccessConstructor and Description
public
MetaData(HttpVersion version, HttpFields fields)

public
MetaData(HttpVersion version, HttpFields fields, long contentLength)

public
MetaData(HttpVersion version, HttpFields headers, long contentLength, Supplier<HttpFields> trailersSupplier)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the length of the content in bytes
getContentLength()

Get the length of the content in bytes.

public HttpFields

Returns:

the HTTP headers or HTTP trailers
getHttpFields()

Get the HTTP headers or HTTP trailers.

public HttpVersion

Returns:

the HTTP protocol version
getHttpVersion()

Get the HTTP protocol version.

public Supplier<HttpFields>
getTrailersSupplier()

Returns: a supplier for the HTTP trailers

public boolean
isRequest()

Returns: whether this object is a Request

public boolean
isResponse()

Returns: whether this object is a Response

public static boolean

Returns:

whether method and status identify a successful HTTP CONNECT tunnel
isTunnel(String
the HTTP request method
method, int
the HTTP response status code
status)

Returns whether the given HTTP request method and HTTP response status code identify a successful HTTP CONNECT tunnel.

public Iterator<HttpField>
iterator()

Implements java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

_contentLengthback to summary
private final long _contentLength
_httpFieldsback to summary
private final HttpFields _httpFields
_httpVersionback to summary
private final HttpVersion _httpVersion
_trailersback to summary
private final Supplier<HttpFields> _trailers

Constructor Detail

MetaDataback to summary
public MetaData(HttpVersion version, HttpFields fields)
MetaDataback to summary
public MetaData(HttpVersion version, HttpFields fields, long contentLength)
MetaDataback to summary
public MetaData(HttpVersion version, HttpFields headers, long contentLength, Supplier<HttpFields> trailersSupplier)

Method Detail

getContentLengthback to summary
public long getContentLength()

Get the length of the content in bytes.

Returns:long

the length of the content in bytes

getHttpFieldsback to summary
public HttpFields getHttpFields()

Get the HTTP headers or HTTP trailers.

Returns:HttpFields

the HTTP headers or HTTP trailers

getHttpVersionback to summary
public HttpVersion getHttpVersion()

Get the HTTP protocol version.

Returns:HttpVersion

the HTTP protocol version

getTrailersSupplierback to summary
public Supplier<HttpFields> getTrailersSupplier()
Returns:Supplier<HttpFields>

a supplier for the HTTP trailers

isRequestback to summary
public boolean isRequest()
Returns:boolean

whether this object is a Request

isResponseback to summary
public boolean isResponse()
Returns:boolean

whether this object is a Response

isTunnelback to summary
public static boolean isTunnel(String method, int status)

Returns whether the given HTTP request method and HTTP response status code identify a successful HTTP CONNECT tunnel.

Parameters
method:String

the HTTP request method

status:int

the HTTP response status code

Returns:boolean

whether method and status identify a successful HTTP CONNECT tunnel

iteratorback to summary
public Iterator<HttpField> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Returns:Iterator<HttpField>

an Iterator.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
org.eclipse.jetty.http back to summary

public Class MetaData.ConnectRequest

extends Request
Class Inheritance

Immutable HTTP CONNECT request information.

Field Summary

Modifier and TypeField and Description
private final String
_protocol

Constructor Summary

AccessConstructor and Description
public
ConnectRequest(HttpScheme scheme, HostPortHttpField authority, String pathQuery, HttpFields headers, String protocol)

public
ConnectRequest(long beginNanoTime, HttpScheme scheme, HostPortHttpField authority, String pathQuery, HttpFields headers, String protocol)

public
ConnectRequest(String scheme, HostPortHttpField authority, String pathQuery, HttpFields headers, String protocol)

public
ConnectRequest(long beginNanoTime, String scheme, HostPortHttpField authority, String pathQuery, HttpFields headers, String protocol)

Method Summary

Modifier and TypeMethod and Description
public String
getProtocol()

Overrides org.eclipse.jetty.http.MetaData.Request.getProtocol.

Inherited from org.eclipse.jetty.http.MetaData.Request:
getBeginNanoTimegetHttpURIgetMethodis100ContinueExpectedisRequesttoString

Field Detail

_protocolback to summary
private final String _protocol

Constructor Detail

ConnectRequestback to summary
public ConnectRequest(HttpScheme scheme, HostPortHttpField authority, String pathQuery, HttpFields headers, String protocol)
ConnectRequestback to summary
public ConnectRequest(long beginNanoTime, HttpScheme scheme, HostPortHttpField authority, String pathQuery, HttpFields headers, String protocol)
ConnectRequestback to summary
public ConnectRequest(String scheme, HostPortHttpField authority, String pathQuery, HttpFields headers, String protocol)
ConnectRequestback to summary
public ConnectRequest(long beginNanoTime, String scheme, HostPortHttpField authority, String pathQuery, HttpFields headers, String protocol)

Method Detail

getProtocolback to summary
public String getProtocol()

Overrides org.eclipse.jetty.http.MetaData.Request.getProtocol.

Returns:String

Doc from org.eclipse.jetty.http.MetaData.Request.getProtocol.

the protocol associated with tunnel requests, if any

Annotations
@Override
org.eclipse.jetty.http back to summary

public Class MetaData.Request

extends MetaData
Class Inheritance
Known Direct Subclasses
org.eclipse.jetty.http.MetaData.ConnectRequest

Immutable HTTP request information.

Field Summary

Modifier and TypeField and Description
private final long
_beginNanoTime

private final String
_method

private final HttpURI
_uri

Constructor Summary

AccessConstructor and Description
public
Request(String method, HttpURI uri, HttpVersion version, HttpFields headers)

public
Request(long beginNanoTime, String method, HttpURI uri, HttpVersion version, HttpFields headers)

public
Request(String method, String scheme, HostPortHttpField authority, String uri, HttpVersion version, HttpFields headers, long contentLength)

public
Request(long beginNanoTime, String method, String scheme, HostPortHttpField authority, String uri, HttpVersion version, HttpFields headers, long contentLength)

public
Request(String method, HttpURI uri, HttpVersion version, HttpFields headers, long contentLength)

public
Request(long beginNanoTime, String method, HttpURI uri, HttpVersion version, HttpFields headers, long contentLength)

public
Request(String method, HttpURI uri, HttpVersion version, HttpFields headers, long contentLength, Supplier<HttpFields> trailers)

public
Request(long beginNanoTime, String method, HttpURI uri, HttpVersion version, HttpFields headers, long contentLength, Supplier<HttpFields> trailers)

Method Summary

Modifier and TypeMethod and Description
public long
getBeginNanoTime()

public HttpURI
getHttpURI()

Returns: the HTTP URI

public String
getMethod()

Returns: the HTTP method

public String
getProtocol()

Returns: the protocol associated with tunnel requests, if any

public boolean
is100ContinueExpected()

public boolean
isRequest()

Overrides org.eclipse.jetty.http.MetaData.isRequest.

public String
toString()

Overrides org.eclipse.jetty.http.MetaData.toString.

Returns a string representation of the object.

Inherited from org.eclipse.jetty.http.MetaData:
getContentLengthgetHttpFieldsgetHttpVersiongetTrailersSupplierisResponseisTunneliterator

Field Detail

_beginNanoTimeback to summary
private final long _beginNanoTime
_methodback to summary
private final String _method
_uriback to summary
private final HttpURI _uri

Constructor Detail

Requestback to summary
public Request(String method, HttpURI uri, HttpVersion version, HttpFields headers)
Requestback to summary
public Request(long beginNanoTime, String method, HttpURI uri, HttpVersion version, HttpFields headers)
Requestback to summary
public Request(String method, String scheme, HostPortHttpField authority, String uri, HttpVersion version, HttpFields headers, long contentLength)
Requestback to summary
public Request(long beginNanoTime, String method, String scheme, HostPortHttpField authority, String uri, HttpVersion version, HttpFields headers, long contentLength)
Requestback to summary
public Request(String method, HttpURI uri, HttpVersion version, HttpFields headers, long contentLength)
Requestback to summary
public Request(long beginNanoTime, String method, HttpURI uri, HttpVersion version, HttpFields headers, long contentLength)
Requestback to summary
public Request(String method, HttpURI uri, HttpVersion version, HttpFields headers, long contentLength, Supplier<HttpFields> trailers)
Requestback to summary
public Request(long beginNanoTime, String method, HttpURI uri, HttpVersion version, HttpFields headers, long contentLength, Supplier<HttpFields> trailers)

Method Detail

getBeginNanoTimeback to summary
public long getBeginNanoTime()
getHttpURIback to summary
public HttpURI getHttpURI()
Returns:HttpURI

the HTTP URI

getMethodback to summary
public String getMethod()
Returns:String

the HTTP method

getProtocolback to summary
public String getProtocol()
Returns:String

the protocol associated with tunnel requests, if any

is100ContinueExpectedback to summary
public boolean is100ContinueExpected()
isRequestback to summary
public boolean isRequest()

Overrides org.eclipse.jetty.http.MetaData.isRequest.

Returns:boolean

Doc from org.eclipse.jetty.http.MetaData.isRequest.

whether this object is a Request

Annotations
@Override
toStringback to summary
public String toString()

Overrides org.eclipse.jetty.http.MetaData.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override
org.eclipse.jetty.http back to summary

public Class MetaData.Response

extends MetaData
Class Inheritance

Immutable HTTP response information.

Field Summary

Modifier and TypeField and Description
private final String
_reason

private final int
_status

Constructor Summary

AccessConstructor and Description
public
Response(int status, String reason, HttpVersion version, HttpFields headers)

public
Response(int status, String reason, HttpVersion version, HttpFields headers, long contentLength)

public
Response(int status, String reason, HttpVersion version, HttpFields headers, long contentLength, Supplier<HttpFields> trailers)

Method Summary

Modifier and TypeMethod and Description
public String
getReason()

Returns: the HTTP reason

public int
getStatus()

Returns: the HTTP status

public boolean
isResponse()

Overrides org.eclipse.jetty.http.MetaData.isResponse.

public String
toString()

Overrides org.eclipse.jetty.http.MetaData.toString.

Returns a string representation of the object.

Inherited from org.eclipse.jetty.http.MetaData:
getContentLengthgetHttpFieldsgetHttpVersiongetTrailersSupplierisRequestisTunneliterator

Field Detail

_reasonback to summary
private final String _reason
_statusback to summary
private final int _status

Constructor Detail

Responseback to summary
public Response(int status, String reason, HttpVersion version, HttpFields headers)
Responseback to summary
public Response(int status, String reason, HttpVersion version, HttpFields headers, long contentLength)
Responseback to summary
public Response(int status, String reason, HttpVersion version, HttpFields headers, long contentLength, Supplier<HttpFields> trailers)

Method Detail

getReasonback to summary
public String getReason()
Returns:String

the HTTP reason

getStatusback to summary
public int getStatus()
Returns:int

the HTTP status

isResponseback to summary
public boolean isResponse()

Overrides org.eclipse.jetty.http.MetaData.isResponse.

Returns:boolean

Doc from org.eclipse.jetty.http.MetaData.isResponse.

whether this object is a Response

Annotations
@Override
toStringback to summary
public String toString()

Overrides org.eclipse.jetty.http.MetaData.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override