com.ibm.tivoli.maximo.rest

Class BaseResourceRequestHandler

java.lang.Object

com.ibm.tivoli.maximo.rest.BaseResourceRequestHandler

All Implemented Interfaces:

ResourceRequestHandler, RestConstants

Direct Known Subclasses:

MaxServiceResourceRequestHandler, MboResourceRequestHandler

public abstract class BaseResourceRequestHandler
extends java.lang.Object
implements ResourceRequestHandler, RestConstants

The base resource request handler.

Author:

Anamitra

Field Summary

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
BaseResourceRequestHandler()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDelagateHandler(java.lang.String resourceType, java.lang.String resourceName)
ResourceResponse	handleRequest(ResourceRequest req) This method will be called to handle the REST resquest for POST/GET/PUT/DELETE
boolean	isRequestNoCache(ResourceRequest req)
boolean	isResourceModified(Resource resource, ResourceRequest request)
boolean	isRoot()
boolean	isUseCache(Resource res, ResourceRequest req)
void	setBlockAccessList(java.util.Set<java.lang.String> blockAccessList)
void	setHandlerName(java.lang.String handlerName)
void	setMXSession(MXSession mxSession)
void	setRoot(boolean rootHandler)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseResourceRequestHandler

public BaseResourceRequestHandler()

Method Detail

setBlockAccessList

public void setBlockAccessList(java.util.Set<java.lang.String> blockAccessList)

Specified by:

setBlockAccessList in interface ResourceRequestHandler

isRequestNoCache

public boolean isRequestNoCache(ResourceRequest req)

isUseCache

public boolean isUseCache(Resource res,
                 ResourceRequest req)
                   throws java.rmi.RemoteException,
                          MXApplicationException

Throws:

java.rmi.RemoteException

MXApplicationException

isResourceModified

public boolean isResourceModified(Resource resource,
                         ResourceRequest request)

setMXSession

public void setMXSession(MXSession mxSession)

Specified by:

setMXSession in interface ResourceRequestHandler

See Also:

ResourceRequestHandler.setMXSession(psdi.util.MXSession)

setHandlerName

public void setHandlerName(java.lang.String handlerName)

Specified by:

setHandlerName in interface ResourceRequestHandler

getDelagateHandler

public java.lang.String getDelagateHandler(java.lang.String resourceType,
                                  java.lang.String resourceName)

handleRequest

public ResourceResponse handleRequest(ResourceRequest req)
                               throws java.rmi.RemoteException,
                                      MXException

Description copied from interface: ResourceRequestHandler

This method will be called to handle the REST resquest for POST/GET/PUT/DELETE

Specified by:

handleRequest in interface ResourceRequestHandler

Parameters:

req - The REST request object which contains information from the HttpServletRequest object

Returns:

The REST response as a ResourceResponse object

Throws:

java.rmi.RemoteException

MXException

isRoot

public boolean isRoot()

Specified by:

isRoot in interface ResourceRequestHandler

setRoot

public void setRoot(boolean rootHandler)

Specified by:

setRoot in interface ResourceRequestHandler