core.tut.pori.http

Class ServiceRequest

java.lang.Object

core.tut.pori.http.ServiceRequest

public class ServiceRequest
extends java.lang.Object

A service request definitions, which can be passed to ServiceHandler for service invocation.

Constructor Summary

Constructors

Constructor and Description
ServiceRequest()

Method Summary

Modifier and Type	Method and Description
static ServiceRequest	createRequest(UserIdentity authenticatedUser, javax.servlet.http.HttpServletRequest httpServletRequest)
UserIdentity	getAuthenticatedUser()
java.io.InputStream	getBody() Note: you can only read the body once.
java.lang.String	getHeaderValue(java.lang.String headerName)
java.lang.String	getHttpMethod()
java.lang.String	getMethodName()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRawParameters()
javax.servlet.http.HttpServletRequest	getRequest()
java.lang.String	getServiceName()
javax.servlet.http.HttpSession	getSession()
boolean	isBodyRequested()
static boolean	isValid(ServiceRequest request)
void	setAuthenticatedUser(UserIdentity authenticatedUser)
void	setHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Set/override the previously set headers.
void	setHttpMethod(java.lang.String method)
void	setMethodName(java.lang.String methodName)
void	setServiceName(java.lang.String serviceName)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServiceRequest

public ServiceRequest()

Method Detail

isValid

public static boolean isValid(ServiceRequest request)

Parameters:

request -

Returns:

true if the given request was valid and != null

createRequest

public static ServiceRequest createRequest(UserIdentity authenticatedUser,
                                           javax.servlet.http.HttpServletRequest httpServletRequest)

Parameters:

authenticatedUser -

httpServletRequest -

Returns:

new request or null on failure

getBody

public java.io.InputStream getBody()

Note: you can only read the body once. Further attempts will return null

Returns:

body or null if none available

getServiceName

public java.lang.String getServiceName()

Returns:

the serviceName

getSession

public javax.servlet.http.HttpSession getSession()

Returns:

the http session for this request. A new session will be created if one does not already exist. Returns null if no HttpRequest is associated with this request.

setServiceName

public void setServiceName(java.lang.String serviceName)

Parameters:

serviceName - the serviceName to set

getMethodName

public java.lang.String getMethodName()

Returns:

the methodName

setMethodName

public void setMethodName(java.lang.String methodName)

Parameters:

methodName - the methodName to set

getRawParameters

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRawParameters()

Returns:

the raw URL encoded parameters

getAuthenticatedUser

public UserIdentity getAuthenticatedUser()

Returns:

the authenticatedUser

setAuthenticatedUser

public void setAuthenticatedUser(UserIdentity authenticatedUser)

Parameters:

authenticatedUser - the authenticatedUser to set

isBodyRequested

public boolean isBodyRequested()

Returns:

the bodyRequested

getHttpMethod

public java.lang.String getHttpMethod()

Returns:

the method, e.g. GET, POST

setHttpMethod

public void setHttpMethod(java.lang.String method)

Parameters:

method - the method to set, e.g. GET, POST

setHeaders

public void setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Set/override the previously set headers. Note that HTTP headers are case insensitive and thus duplicate header names with only difference being the case will be removed.

Parameters:

headers - the map of header names/values, note that the passed list will NOT be used, and an internal copy of the map will be made.

getHeaderValue

public java.lang.String getHeaderValue(java.lang.String headerName)

Parameters:

headerName -

Returns:

the value of header or null if the header does not exist

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns:

the request