public class HttpInboundRequest extends Request implements InboundRequest
Constructor and Description |
---|
HttpInboundRequest(Context context,
Connection<Server> connection,
String methodName,
String resourceUri,
String protocol)
Constructor.
|
HttpInboundRequest(HttpInboundRequest request)
Copy constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
abort()
Ask the connector to attempt to abort the related network connection, for
example immediately closing the socket.
|
static void |
addHeader(Request request,
String headerName,
String headerValue)
Adds a new header to the given request.
|
void |
commit(Response response)
Asks the server connector to immediately commit the given response
associated to this request, making it ready to be sent back to the
client.
|
void |
flushBuffers()
Asks the underlying connector to immediately flush the network buffers.
|
Set<String> |
getAccessControlRequestHeaders()
Returns the modifiable set of headers the client is willing to send in
future request to this resource.
|
Method |
getAccessControlRequestMethod()
Returns the method the client is willing to use in future request to this
resource.
|
List<CacheDirective> |
getCacheDirectives()
Returns the cache directives.
Note that when used with HTTP connectors, this property maps to the "Cache-Control" header. |
ChallengeResponse |
getChallengeResponse()
Returns the authentication response sent by a client to an origin server.
|
ClientInfo |
getClientInfo()
Returns the client-specific information.
|
Conditions |
getConditions()
Returns the condition data applying to this call.
|
Connection<Server> |
getConnection()
Returns the related connection.
|
Series<Cookie> |
getCookies()
Returns the cookies provided by the client.
|
Series<Header> |
getHeaders()
Returns the series of lower-level HTTP headers.
|
ChallengeResponse |
getProxyChallengeResponse()
Returns the authentication response sent by a client to a proxy.
|
List<Range> |
getRanges()
Returns the ranges to return from the target resource's representation.
|
List<RecipientInfo> |
getRecipientsInfo()
Returns the intermediary recipient information.
Note that when used with HTTP connectors, this property maps to the "Via" headers. |
Reference |
getReferrerRef()
Returns the referrer reference if available.
|
Principal |
getUserPrincipal()
Returns the associated user principal.
|
List<Warning> |
getWarnings()
Returns the additional warnings information.
Note that when used with HTTP connectors, this property maps to the "Warning" headers. |
void |
setAccessControlRequestHeaders(Set<String> accessControlRequestHeaders)
Sets the set of headers the client is willing to use in future request to
this resource.
|
void |
setAccessControlRequestMethod(Method accessControlRequestMethod)
Sets the method the client is willing to use in future request to this
resource.
|
void |
setChallengeResponse(ChallengeResponse response)
Sets the authentication response sent by a client to an origin server.
|
void |
setHeaders(Series<Header> headers)
Put the headers in the request's attributes map.
|
void |
setProxyChallengeResponse(ChallengeResponse response)
Sets the authentication response sent by a client to a proxy.
|
void |
setRecipientsInfo(List<RecipientInfo> recipientsInfo)
Sets the modifiable list of intermediary recipients.
|
void |
setWarnings(List<Warning> warnings)
Sets the additional warnings information.
|
getCurrent, getHostRef, getMaxForwards, getMethod, getOnResponse, getOriginalRef, getProtocol, getResourceRef, getRootRef, isAsynchronous, isConfidential, isEntityAvailable, isExpectingResponse, isLoggable, isSynchronous, setClientInfo, setConditions, setCookies, setHostRef, setHostRef, setLoggable, setMaxForwards, setMethod, setOnResponse, setOriginalRef, setProtocol, setRanges, setReferrerRef, setReferrerRef, setResourceRef, setResourceRef, setRootRef, toString
bufferEntity, getAttributes, getDate, getEntity, getEntityAsText, getOnError, getOnSent, release, setAttributes, setCacheDirectives, setDate, setEntity, setEntity, setOnError, setOnSent
public HttpInboundRequest(Context context, Connection<Server> connection, String methodName, String resourceUri, String protocol)
context
- The context of the parent connector.connection
- The associated network connection.methodName
- The protocol method name.resourceUri
- The target resource URI.protocol
- The protocol name and version.public HttpInboundRequest(HttpInboundRequest request)
request
- The request to copy.public static void addHeader(Request request, String headerName, String headerValue)
request
- The request to update.headerName
- The header name to add.headerValue
- The header value to add.public boolean abort()
Request
public void commit(Response response)
Request
public void flushBuffers()
Message
flushBuffers
in class Message
public Set<String> getAccessControlRequestHeaders()
Request
getAccessControlRequestHeaders
in class Request
public Method getAccessControlRequestMethod()
Request
getAccessControlRequestMethod
in class Request
public List<CacheDirective> getCacheDirectives()
Message
getCacheDirectives
in class Message
public ChallengeResponse getChallengeResponse()
Request
getChallengeResponse
in class Request
public ClientInfo getClientInfo()
getClientInfo
in class Request
public Conditions getConditions()
getConditions
in class Request
public Connection<Server> getConnection()
getConnection
in interface InboundRequest
public Series<Cookie> getCookies()
getCookies
in class Request
public Series<Header> getHeaders()
Message
getHeaders
in interface InboundRequest
getHeaders
in class Message
public ChallengeResponse getProxyChallengeResponse()
Request
getProxyChallengeResponse
in class Request
public List<Range> getRanges()
Request
public List<RecipientInfo> getRecipientsInfo()
Message
getRecipientsInfo
in class Message
public Reference getReferrerRef()
getReferrerRef
in class Request
public Principal getUserPrincipal()
public List<Warning> getWarnings()
Message
getWarnings
in class Message
public void setAccessControlRequestHeaders(Set<String> accessControlRequestHeaders)
Request
setAccessControlRequestHeaders
in class Request
accessControlRequestHeaders
- The set of headers the client is willing to send in future
request to this resource. Useful for CORS support.public void setAccessControlRequestMethod(Method accessControlRequestMethod)
Request
setAccessControlRequestMethod
in class Request
accessControlRequestMethod
- The method the client is willing to send in future request to
this resource. Useful for CORS support.public void setChallengeResponse(ChallengeResponse response)
Request
setChallengeResponse
in class Request
response
- The authentication response sent by a client to an origin
server.public void setHeaders(Series<Header> headers)
InboundRequest
setHeaders
in interface InboundRequest
headers
- The headers.public void setProxyChallengeResponse(ChallengeResponse response)
Request
setProxyChallengeResponse
in class Request
response
- The authentication response sent by a client to a proxy.public void setRecipientsInfo(List<RecipientInfo> recipientsInfo)
Message
setRecipientsInfo
in class Message
recipientsInfo
- A list of intermediary recipients.public void setWarnings(List<Warning> warnings)
Message
setWarnings
in class Message
warnings
- The warnings.Copyright © 2005–2016. All rights reserved.