com.ibm.tivoli.maximo.rest

Class ResourceRequest

java.lang.Object

com.ibm.tivoli.maximo.rest.ResourceRequest

All Implemented Interfaces:

RestConstants, java.io.Serializable

Direct Known Subclasses:

ChainedResourceRequest

public class ResourceRequest
extends java.lang.Object
implements java.io.Serializable, RestConstants

The REST request class which encapsulates the REST session along with the request resource path and query/form parameters as well as the header parameters.

Author:

Anamitra

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_POST
static java.lang.String	HTTP_PUT

Fields inherited from interface com.ibm.tivoli.maximo.rest.RestConstants

COMPACT, DROPNULLS, ENDSWITH, EQUALS, EXACTMATCH, EXCLUDECOLS, FILTERDOMAIN, FILTERDOMAIN_ORG, FILTERDOMAIN_SITE, FORM_PARAM_ROWSTAMP, GENERIC, GLCOMP, GRATERTHAN, GRATERTHANEQUALS, INCLUDECOLS, KEYS, LANGCODE, LESSTHAN, LESSTHANEQUALS, LOCALE, LOGINID, LOGINPASSWORD, MAXAUTHTOKEN, MAXITEMS, MAXUSER, METADATA, MXRESTSESSION, NOTEQUALS, OPERATION_PARAM_NS, OPMODEOR, ORDERBY, ORDERBYASC, ORDERBYDESC, PAGE, QUERY_OPERATION, REFRESH_LOCALE, RELATED_ATTRBUTE, RELEASE_RESOURCE_REQUEST, RESOURCE_LOCATOR_ID, REST_LOGGER, RESTSESSION, RETAINMBOS, ROOTONLY, RSSTART, SESSION_OSMSGTYPE, STARTSSWITH, TENANTCODE, TIMEZONE, USE_LOCATION_FOR_CREATE, USE_SESSION_FOR_COLLECTION, USE_TOTAL_COUNT, USER_WHERE, USER_WHERE_POLICY_ALLOW, USER_WHERE_POLICY_BLOCK, USER_WHERE_POLICY_PARSE, USEROWSTAMP, VALIDATE_XML_TEXT, VERBOSE

Constructor Summary

Constructors

Constructor and Description
ResourceRequest(ResourceRequest req)
ResourceRequest(java.lang.String resourceType, java.util.List<java.lang.String> resourcePath, java.util.Map<java.lang.String,java.lang.String[]> queryParams, HttpHeaders headerParams, RESTSession session, java.lang.String httpMethod, java.lang.String format, java.lang.String reqURL)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientAddr()
java.lang.String	getClientHost()
java.lang.String	getFormat()
HttpHeaders	getHeaderParams()
java.lang.String	getHttpMethod()
MXSession	getMXSession()
java.util.Map<java.lang.String,java.lang.String[]>	getQueryParams()
java.lang.String	getRequestURL()
java.lang.String	getResourceLocatorId()
java.util.List<java.lang.String>	getResourcePath()
java.lang.String	getResourceType()
RESTSession	getSession()
boolean	isDELETE()
boolean	isGET()
boolean	isPOST()
boolean	isPUT()
boolean	isReleaseResourceRequest()
boolean	isUseLocationForCreate()
boolean	isUseSessionForCollection()
void	setClientAddr(java.lang.String remoteAddr)
void	setClientHost(java.lang.String remoteHost)

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

Constructor Detail

ResourceRequest

public ResourceRequest(java.lang.String resourceType,
                       java.util.List<java.lang.String> resourcePath,
                       java.util.Map<java.lang.String,java.lang.String[]> queryParams,
                       HttpHeaders headerParams,
                       RESTSession session,
                       java.lang.String httpMethod,
                       java.lang.String format,
                       java.lang.String reqURL)

ResourceRequest

public ResourceRequest(ResourceRequest req)

Method Detail

isReleaseResourceRequest

public boolean isReleaseResourceRequest()

isUseSessionForCollection

public boolean isUseSessionForCollection()

getResourceLocatorId

public java.lang.String getResourceLocatorId()

getRequestURL

public java.lang.String getRequestURL()

getResourceType

public java.lang.String getResourceType()

Returns:

the resource type [for example "mbo" or "os"]

getFormat

public java.lang.String getFormat()

Returns:

the request format [the value of _format]. If not specified will return "default"

isUseLocationForCreate

public boolean isUseLocationForCreate()

Returns:

boolean true if use the location header for create - false will return the create resource represenattion

getResourcePath

public java.util.List<java.lang.String> getResourcePath()

Returns:

the resourcePath from the http request as List

getQueryParams

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

Returns:

the query/form params

getHeaderParams

public HttpHeaders getHeaderParams()

Returns:

the header params from the http request

getSession

public RESTSession getSession()

Returns:

the REST session. This is associated with the HttpSession instance.

getHttpMethod

public java.lang.String getHttpMethod()

Returns:

the http method. Can be HTTP_GET/HTTP_POST/HTTP_PUT/HTTP_DELETE.

isPOST

public boolean isPOST()

isPUT

public boolean isPUT()

isDELETE

public boolean isDELETE()

isGET

public boolean isGET()

setClientAddr

public void setClientAddr(java.lang.String remoteAddr)

getClientAddr

public java.lang.String getClientAddr()

setClientHost

public void setClientHost(java.lang.String remoteHost)

getClientHost

public java.lang.String getClientHost()

getMXSession

public MXSession getMXSession()