com.ibm.tivoli.oslc

Class RESTRequest

java.lang.Object

com.ibm.tivoli.oslc.RESTRequest

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BaseResourceRequest

public abstract class RESTRequest
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HTTP_DELETE
static java.lang.String	HTTP_GET
static java.lang.String	HTTP_HEAD
static java.lang.String	HTTP_PATCH
static java.lang.String	HTTP_POST
static java.lang.String	HTTP_PUT

Constructor Summary

Constructors

Constructor and Description
RESTRequest(javax.servlet.http.HttpServletRequest request)
RESTRequest(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers, java.util.Map<java.lang.String,java.lang.String[]> queryParams, java.lang.String httpMethod, java.lang.String clientAddr, java.lang.String clientHost)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getBooleanQueryParam(java.lang.String param, boolean def)
java.lang.String	getClientAddr()
java.lang.String	getClientHost()
abstract java.lang.String	getDefaultFormat()
BaseHttpHeaders	getHeaderParams()
java.lang.String	getHttpMethod()
java.lang.Integer	getIntegerQueryParam(java.lang.String param)
java.security.Principal	getPrincipal()
java.lang.String	getQueryParam(java.lang.String param)
java.lang.String	getQueryParam(java.lang.String param, java.lang.String def)
java.util.Map<java.lang.String,java.lang.String[]>	getQueryParams()
java.lang.String	getRequestFormat()
abstract java.util.Map<java.lang.String,java.lang.String>	getRequestFormatMimeTypeMap()
java.lang.String	getRequestMIMEType()
java.lang.String	getResponseFormat()
abstract java.util.Map<java.lang.String,java.lang.String>	getResponseFormatMimeTypeMap()
java.lang.String	getResponseMIMEType()
boolean	isDELETE()
boolean	isGET()
boolean	isHEAD()
boolean	isPATCH()
boolean	isPOST()
boolean	isPUT()

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_GET

public static final java.lang.String HTTP_GET

See Also:

Constant Field Values

HTTP_POST

public static final java.lang.String HTTP_POST

See Also:

Constant Field Values

HTTP_PUT

public static final java.lang.String HTTP_PUT

See Also:

Constant Field Values

HTTP_DELETE

public static final java.lang.String HTTP_DELETE

See Also:

Constant Field Values

HTTP_PATCH

public static final java.lang.String HTTP_PATCH

See Also:

Constant Field Values

HTTP_HEAD

public static final java.lang.String HTTP_HEAD

See Also:

Constant Field Values

Constructor Detail

RESTRequest

public RESTRequest(java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers,
                   java.util.Map<java.lang.String,java.lang.String[]> queryParams,
                   java.lang.String httpMethod,
                   java.lang.String clientAddr,
                   java.lang.String clientHost)

RESTRequest

public RESTRequest(javax.servlet.http.HttpServletRequest request)

Method Detail

getPrincipal

public java.security.Principal getPrincipal()

getHeaderParams

public BaseHttpHeaders getHeaderParams()

getHttpMethod

public java.lang.String getHttpMethod()

getResponseFormat

public java.lang.String getResponseFormat()

getRequestFormat

public java.lang.String getRequestFormat()

getQueryParams

public java.util.Map<java.lang.String,java.lang.String[]> getQueryParams()

Returns:

the query/form params

isPOST

public boolean isPOST()

isPUT

public boolean isPUT()

isDELETE

public boolean isDELETE()

isGET

public boolean isGET()

isPATCH

public boolean isPATCH()

isHEAD

public boolean isHEAD()

getResponseMIMEType

public java.lang.String getResponseMIMEType()

getRequestMIMEType

public java.lang.String getRequestMIMEType()

getQueryParam

public java.lang.String getQueryParam(java.lang.String param)

getIntegerQueryParam

public java.lang.Integer getIntegerQueryParam(java.lang.String param)

getBooleanQueryParam

public java.lang.Boolean getBooleanQueryParam(java.lang.String param,
                                              boolean def)

getQueryParam

public java.lang.String getQueryParam(java.lang.String param,
                                      java.lang.String def)

getClientAddr

public java.lang.String getClientAddr()

getClientHost

public java.lang.String getClientHost()

getResponseFormatMimeTypeMap

public abstract java.util.Map<java.lang.String,java.lang.String> getResponseFormatMimeTypeMap()

getRequestFormatMimeTypeMap

public abstract java.util.Map<java.lang.String,java.lang.String> getRequestFormatMimeTypeMap()

getDefaultFormat

public abstract java.lang.String getDefaultFormat()