Package com.yahoo.application.container.handler

Class Request

java.lang.Object

com.yahoo.application.container.handler.Request

@Immutable
@Beta
public class Request
extends Object

A request for use with JDisc.handleRequest(Request).

Author:

Einar M R Rosenvinge

See Also:

Response

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Request.Method

Constructor Summary

Constructors

Constructor	Description
Request(String uri)	Creates a Request with an empty body.
Request(String uri, byte[] body)	Creates a GET Request with a message body.
Request(String uri, byte[] body, Request.Method method)	Creates a Request with a message body.
Request(String uri, byte[] body, Request.Method method, Principal principal)	Creates a Request with a message body, method and user principal.
Request(String uri, String body)	Creates a GET Request with a message body.
Request(String uri, String body, Request.Method method)	Creates a Request with a message body.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getAttributes()
byte[]	getBody()	Returns the body of this Request.
Headers	getHeaders()	Returns a mutable multi-map of headers for this Request.
Request.Method	getMethod()
String	getUri()	Returns the URI of this Request.
Optional<Principal>	getUserPrincipal()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Request

public Request(String uri)

Creates a Request with an empty body.

Parameters:

uri - the URI of the request

Request

public Request(String uri,
               byte[] body)

Creates a GET Request with a message body.

Parameters:

uri - the URI of the request

body - the body of the request

Request

public Request(String uri,
               String body)

Creates a GET Request with a message body.

Parameters:

uri - the URI of the request

body - the body of the request as a UTF-8 string

Request

public Request(String uri,
               byte[] body,
               Request.Method method)

Creates a Request with a message body.

Parameters:

uri - the URI of the request

body - the body of the request

Request

public Request(String uri,
               byte[] body,
               Request.Method method,
               Principal principal)

Creates a Request with a message body, method and user principal.

Parameters:

uri - the URI of the request

body - the body of the request

method - the method of the request

principal - the user principal of the request

Request

public Request(String uri,
               String body,
               Request.Method method)

Creates a Request with a message body.

Parameters:

uri - the URI of the request

body - the body of the request as a UTF-8 string

Method Detail

getHeaders

public Headers getHeaders()

Returns a mutable multi-map of headers for this Request.

Returns:

a mutable multi-map of headers for this Request

getBody

public byte[] getBody()

Returns the body of this Request.

Returns:

the body of this Request

getUri

public String getUri()

Returns the URI of this Request.

Returns:

the URI of this Request

getAttributes

public Map<String,Object> getAttributes()

Returns:

a mutable attribute map for this request.

toString

public String toString()

Overrides:

toString in class Object

getMethod

public Request.Method getMethod()

getUserPrincipal

public Optional<Principal> getUserPrincipal()