com.ibm.tivoli.maximo.oslc.provider

Class OslcRequest

java.lang.Object

com.ibm.tivoli.oslc.RESTRequest

com.ibm.tivoli.maximo.rest.BaseResourceRequest

com.ibm.tivoli.maximo.oslc.provider.OslcRequest

All Implemented Interfaces:

java.io.Serializable

public class OslcRequest
extends BaseResourceRequest
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.tivoli.oslc.RESTRequest

HTTP_DELETE, HTTP_GET, HTTP_HEAD, HTTP_PATCH, HTTP_POST, HTTP_PUT

Constructor Summary

Constructors

Constructor and Description
OslcRequest(javax.servlet.http.HttpServletRequest request)
OslcRequest(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, java.util.List<java.lang.String> resPath, java.lang.String requestURL)
OslcRequest(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, java.util.List<java.lang.String> resPath, java.lang.String requestURL, UserInfo userInfo)

Method Summary

Modifier and Type	Method and Description
void	addIDToURI(java.lang.String id)
java.lang.String	bindMboToSession(java.lang.String osName, MboRemote mbo)
OslcRequest	copy(java.util.Map<java.lang.String,java.util.List<java.lang.String>> bulkHeaders, java.util.Map<java.lang.String,java.lang.String[]> bulkQueryParams)
java.util.List<java.lang.String>	getAbsolutePath()
java.lang.String	getAbsoluteURI()
java.lang.String	getAction()
java.lang.String	getApiKey()
java.lang.String	getApps()
java.lang.String	getAttachmentDescription()
java.lang.String[]	getAttachmentDocType()
java.lang.String	getAttachmentEncDescription()
java.lang.String	getAttachmentExternalID()
java.lang.String[]	getCanChangeExternalStatus(java.lang.String objectName)
java.lang.String[]	getCanChangeMaxStatus(java.lang.String objectName)
java.lang.String	getContentLocationHeader()
java.lang.String	getCsrfToken()
java.lang.String	getCsrfTokenFromRequest()
java.lang.String	getDefaultFormat()
java.util.Map<java.lang.String,java.lang.String>	getDependentSubSelects()
java.lang.String	getDistinctClause()
java.lang.String	getGBFilter()
java.lang.String	getGroupByAttributes()
java.lang.String	getGroupByRange()
java.lang.String	getGroupByRelationProperties()
java.lang.String	getGroupByRelations()
java.lang.String	getGroupBySortOrder()
java.lang.String	getGroupByTemplate()
java.lang.String	getGuestId()
java.lang.String	getHeader(java.lang.String headerName)
javax.servlet.http.HttpServletRequest	getHttpServletRequest()
javax.servlet.http.HttpServletResponse	getHttpServletResponse()
java.io.InputStream	getInputStream()
java.lang.String	getLinkHeader()
java.lang.Long	getMaxRowStamp()
java.lang.String	getNpFilter()
OslcQuery	getOslcQuery()
java.lang.String	getOslcRequestURI()
java.lang.String	getOslcResourceURI()
MPPartInfo	getPart(java.lang.String partKey)
java.lang.String	getProcessAsSelfRefRelName()
java.lang.String	getQbeFilter()
java.lang.Object	getQueryString()
java.lang.String	getQueryTemplate()
java.util.Map<java.lang.String,java.lang.String>	getRequestFormatMimeTypeMap()
java.lang.String	getRequestPublicURI()
java.lang.String	getRequestURL()
java.util.List<java.lang.String>	getResourcePath()
java.util.Map<java.lang.String,java.lang.String>	getResourceQBE()
java.util.Map<java.lang.String,java.lang.String>	getResponseCookiesToSet()
java.util.Map<java.lang.String,java.lang.String>	getResponseFormatMimeTypeMap()
java.lang.String	getSavedQuery()
java.util.Map<java.lang.String,java.lang.String>	getSavedQueryParams()
java.lang.String	getSchemaOrderBy()
java.lang.String	getSchemaSearchTerm()
java.lang.String	getSelfRef()
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getSetValueEvalChild()
java.lang.String	getStableResourceId()
java.util.Map<java.lang.String,java.lang.String[]>	getSubSelectRefs()
java.lang.String	getTemplate()
java.lang.String	getTimeLineAttribute()
java.lang.String	getTimeLineFilter()
java.lang.String	getTimeLineRange()
java.lang.String	getTransactionId()
UserInfo	getUserInfo()
java.lang.String	getUserWhere()
java.lang.String	getUseView()
boolean	internalValues()
void	invalidateSession()
void	invlaidateSession()
boolean	isAction()
boolean	isAddAction()
boolean	isAddDomainMeta()
boolean	isAddID()
boolean	isAddLocalizedRep()
boolean	isAddQueryMeta()
boolean	isAddSchema()
boolean	isAllowedActions()
boolean	isAllowEvents()
boolean	isAllowSelfRefDup()
boolean	isApiCall()
boolean	isAsyncRequest()
boolean	isBatchError()
boolean	isBranchFilterOn()
boolean	isBulkOperation()
boolean	isChangePasswordSession()
boolean	isCheckEsig()
boolean	isClientCertMode()
boolean	isCollectionCount()
boolean	isContentLocalized()
boolean	isCount()
boolean	isCsrfSession()
boolean	isDistinct()
boolean	isDropNulls()
boolean	isEditMode()
boolean	isEnableSession()
boolean	isFetchModeDelta()
boolean	isFileLoad()
boolean	isGETByPOST()
boolean	isGroupBy()
boolean	isIgnoreCollectionRef()
boolean	isIgnoreKeyref()
boolean	isIgnoreRowstamp()
boolean	isInitiateStablePaging()
boolean	isInlineDoc()
boolean	isInMemorySort()
boolean	isInteractiveRequest()
boolean	isLeanJSON()
boolean	isListTemplate()
boolean	isLocalizedDate()
boolean	isLocalRef()
boolean	isMaxSSO()
boolean	isNewSession()
boolean	isProcessAsSelfReferencing()
boolean	isQueryLocalized()
boolean	isQueryTemplate()
boolean	isRegUserSession()
boolean	isRelatedRef()
boolean	isResourceMeta()
boolean	isSetLocalizedRep()
boolean	isSetValueMode()
boolean	isShowHidden()
boolean	isSubmitSession()
boolean	isTlModeDate()
boolean	isWhoAmIApi()
byte[]	readRequestBody()
void	replaceIDToURI(java.lang.String id)
static OslcRequest	resurrectRequest(byte[] reqBytes)
byte[]	serializeToBytes()
void	setHttpServletResponse(javax.servlet.http.HttpServletResponse response)
void	setInMemorySort(boolean inmemsort)
void	setInteractiveRequest()
void	setParts(java.util.Map<java.lang.String,MPPartInfo> parts)
void	setProcessUserInfo(UserInfo processUserInfo)
void	setResourcePath(java.util.List<java.lang.String> resPath)
void	truncateAbsolutePath(int num)
MboRemote	unbindMboFromSession(MboRemote mbo)
boolean	useFetchLimit()
boolean	verifyCsrfToken()

Methods inherited from class com.ibm.tivoli.maximo.rest.BaseResourceRequest

getForUser, getMXSession, getRequestTenantCode, getRESTSession, setForUser, unbindRESTSession

Methods inherited from class com.ibm.tivoli.oslc.RESTRequest

getBooleanQueryParam, getClientAddr, getClientHost, getHeaderParams, getHttpMethod, getIntegerQueryParam, getPrincipal, getQueryParam, getQueryParam, getQueryParams, getRequestFormat, getRequestMIMEType, getResponseFormat, getResponseMIMEType, isDELETE, isGET, isHEAD, isPATCH, isPOST, isPUT

Methods inherited from class java.lang.Object

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

Constructor Detail

OslcRequest

public OslcRequest(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,
                   java.util.List<java.lang.String> resPath,
                   java.lang.String requestURL)
            throws MXException,
                   java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

OslcRequest

public OslcRequest(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,
                   java.util.List<java.lang.String> resPath,
                   java.lang.String requestURL,
                   UserInfo userInfo)
            throws MXException,
                   java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

OslcRequest

public OslcRequest(javax.servlet.http.HttpServletRequest request)
            throws MXException,
                   java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

Method Detail

setProcessUserInfo

public void setProcessUserInfo(UserInfo processUserInfo)

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Throws:

java.io.IOException

setParts

public void setParts(java.util.Map<java.lang.String,MPPartInfo> parts)

isBranchFilterOn

public boolean isBranchFilterOn()

isIgnoreRowstamp

public boolean isIgnoreRowstamp()

isIgnoreKeyref

public boolean isIgnoreKeyref()

getPart

public MPPartInfo getPart(java.lang.String partKey)

isAddSchema

public boolean isAddSchema()

isAddAction

public boolean isAddAction()

isEnableSession

public boolean isEnableSession()

isNewSession

public boolean isNewSession()

isAddLocalizedRep

public boolean isAddLocalizedRep()

getUseView

public java.lang.String getUseView()

getApiKey

public java.lang.String getApiKey()

getApps

public java.lang.String getApps()

isApiCall

public boolean isApiCall()

isClientCertMode

public boolean isClientCertMode()

isBatchError

public boolean isBatchError()

verifyCsrfToken

public boolean verifyCsrfToken()

getCsrfTokenFromRequest

public java.lang.String getCsrfTokenFromRequest()

getCsrfToken

public java.lang.String getCsrfToken()

getGuestId

public java.lang.String getGuestId()

isQueryLocalized

public boolean isQueryLocalized()

isCsrfSession

public boolean isCsrfSession()

isProcessAsSelfReferencing

public boolean isProcessAsSelfReferencing()

isAllowSelfRefDup

public boolean isAllowSelfRefDup()

getProcessAsSelfRefRelName

public java.lang.String getProcessAsSelfRefRelName()

isLocalizedDate

public boolean isLocalizedDate()

getResponseCookiesToSet

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

serializeToBytes

public byte[] serializeToBytes()

getTransactionId

public java.lang.String getTransactionId()

resurrectRequest

public static OslcRequest resurrectRequest(byte[] reqBytes)
                                    throws java.io.IOException,
                                           MXException

Throws:

java.io.IOException

MXException

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

setInteractiveRequest

public void setInteractiveRequest()
                           throws MXApplicationException

Throws:

MXApplicationException

isFileLoad

public boolean isFileLoad()

isAsyncRequest

public boolean isAsyncRequest()

isInteractiveRequest

public boolean isInteractiveRequest()

isCheckEsig

public boolean isCheckEsig()

isIgnoreCollectionRef

public boolean isIgnoreCollectionRef()

isInlineDoc

public boolean isInlineDoc()

getUserInfo

public UserInfo getUserInfo()

Overrides:

getUserInfo in class BaseResourceRequest

readRequestBody

public byte[] readRequestBody()
                       throws java.io.IOException

Throws:

java.io.IOException

setHttpServletResponse

public void setHttpServletResponse(javax.servlet.http.HttpServletResponse response)

getHttpServletResponse

public javax.servlet.http.HttpServletResponse getHttpServletResponse()

setInMemorySort

public void setInMemorySort(boolean inmemsort)

isInMemorySort

public boolean isInMemorySort()

invlaidateSession

public void invlaidateSession()

bindMboToSession

public java.lang.String bindMboToSession(java.lang.String osName,
                                         MboRemote mbo)

unbindMboFromSession

public MboRemote unbindMboFromSession(MboRemote mbo)

getHeader

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

copy

public OslcRequest copy(java.util.Map<java.lang.String,java.util.List<java.lang.String>> bulkHeaders,
                        java.util.Map<java.lang.String,java.lang.String[]> bulkQueryParams)
                 throws MXException,
                        java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

isRelatedRef

public boolean isRelatedRef()

isLocalRef

public boolean isLocalRef()

getAbsoluteURI

public java.lang.String getAbsoluteURI()
                                throws MXException

Throws:

MXException

getDistinctClause

public java.lang.String getDistinctClause()

isDistinct

public boolean isDistinct()

isAction

public boolean isAction()

isMaxSSO

public boolean isMaxSSO()

isCollectionCount

public boolean isCollectionCount()

getAction

public java.lang.String getAction()

getTemplate

public java.lang.String getTemplate()

isBulkOperation

public boolean isBulkOperation()

setResourcePath

public void setResourcePath(java.util.List<java.lang.String> resPath)

addIDToURI

public void addIDToURI(java.lang.String id)

replaceIDToURI

public void replaceIDToURI(java.lang.String id)

getAbsolutePath

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

truncateAbsolutePath

public void truncateAbsolutePath(int num)

getRequestPublicURI

public java.lang.String getRequestPublicURI()

isAllowEvents

public boolean isAllowEvents()

isListTemplate

public boolean isListTemplate()
                       throws MXException

Throws:

MXException

isChangePasswordSession

public boolean isChangePasswordSession()

isRegUserSession

public boolean isRegUserSession()

getResourcePath

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

getRequestURL

public java.lang.String getRequestURL()
                               throws MXException

Throws:

MXException

isLeanJSON

public boolean isLeanJSON()

getAttachmentDocType

public java.lang.String[] getAttachmentDocType()

getLinkHeader

public java.lang.String getLinkHeader()

getContentLocationHeader

public java.lang.String getContentLocationHeader()

getAttachmentDescription

public java.lang.String getAttachmentDescription()

getAttachmentEncDescription

public java.lang.String getAttachmentEncDescription()

getAttachmentExternalID

public java.lang.String getAttachmentExternalID()

isEditMode

public boolean isEditMode()
                   throws MXException

Throws:

MXException

isSetValueMode

public boolean isSetValueMode()
                       throws MXException

Throws:

MXException

getSelfRef

public java.lang.String getSelfRef()

isShowHidden

public boolean isShowHidden()

isDropNulls

public boolean isDropNulls()

getSavedQueryParams

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

isSubmitSession

public boolean isSubmitSession()

isInitiateStablePaging

public boolean isInitiateStablePaging()

isCount

public boolean isCount()

isAllowedActions

public boolean isAllowedActions()
                         throws MXException

Throws:

MXException

getSavedQuery

public java.lang.String getSavedQuery()

getOslcResourceURI

public java.lang.String getOslcResourceURI()

getOslcRequestURI

public java.lang.String getOslcRequestURI()
                                   throws MXException

Throws:

MXException

getOslcQuery

public OslcQuery getOslcQuery()

getResourceQBE

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

isGETByPOST

public boolean isGETByPOST()

getResponseFormatMimeTypeMap

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

Specified by:

getResponseFormatMimeTypeMap in class RESTRequest

getRequestFormatMimeTypeMap

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

Specified by:

getRequestFormatMimeTypeMap in class RESTRequest

getDefaultFormat

public java.lang.String getDefaultFormat()

Specified by:

getDefaultFormat in class RESTRequest

getStableResourceId

public java.lang.String getStableResourceId()

useFetchLimit

public boolean useFetchLimit()

getGBFilter

public java.lang.String getGBFilter()

getGroupByAttributes

public java.lang.String getGroupByAttributes()

getGroupBySortOrder

public java.lang.String getGroupBySortOrder()

getGroupByRelations

public java.lang.String getGroupByRelations()

getGroupByRelationProperties

public java.lang.String getGroupByRelationProperties()

getGroupByTemplate

public java.lang.String getGroupByTemplate()

getGroupByRange

public java.lang.String getGroupByRange()

getQueryTemplate

public java.lang.String getQueryTemplate()

getSchemaSearchTerm

public java.lang.String getSchemaSearchTerm()

getSchemaOrderBy

public java.lang.String getSchemaOrderBy()

isGroupBy

public boolean isGroupBy()

isQueryTemplate

public boolean isQueryTemplate()

internalValues

public boolean internalValues()
                       throws MXApplicationException

Throws:

MXApplicationException

getDependentSubSelects

public java.util.Map<java.lang.String,java.lang.String> getDependentSubSelects()
                                                                        throws MXException

Throws:

MXException

getSubSelectRefs

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

invalidateSession

public void invalidateSession()

getQueryString

public java.lang.Object getQueryString()

getTimeLineAttribute

public java.lang.String getTimeLineAttribute()

getTimeLineRange

public java.lang.String getTimeLineRange()

isSetLocalizedRep

public boolean isSetLocalizedRep()

getUserWhere

public java.lang.String getUserWhere()

getMaxRowStamp

public java.lang.Long getMaxRowStamp()

isFetchModeDelta

public boolean isFetchModeDelta()

isAddQueryMeta

public boolean isAddQueryMeta()

getNpFilter

public java.lang.String getNpFilter()

isAddID

public boolean isAddID()

getTimeLineFilter

public java.lang.String getTimeLineFilter()

isResourceMeta

public boolean isResourceMeta()

isContentLocalized

public boolean isContentLocalized()

getQbeFilter

public java.lang.String getQbeFilter()

isAddDomainMeta

public boolean isAddDomainMeta()

getCanChangeExternalStatus

public java.lang.String[] getCanChangeExternalStatus(java.lang.String objectName)

getCanChangeMaxStatus

public java.lang.String[] getCanChangeMaxStatus(java.lang.String objectName)

isWhoAmIApi

public boolean isWhoAmIApi()

getSetValueEvalChild

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getSetValueEvalChild()

isTlModeDate

public boolean isTlModeDate()