OslcRequest (Maximo API)

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.maximo.rest.BaseResourceRequest
  session
- Fields inherited from class com.ibm.tivoli.oslc.RESTRequest
  clientAddr, clientHost, headerParams, HTTP_DELETE, HTTP_GET, HTTP_HEAD, HTTP_PATCH, HTTP_POST, HTTP_PUT, httpMethod, queryParams, request, requestFormat, requestMIMEType, requestMIMETypePropertyMap, responseFormat, responseMIMEType, responseMIMETypePropertyMap

Constructor Summary

Constructors
Constructor and Description
`OslcRequest(javax.servlet.http.HttpServletRequest request)`
`OslcRequest(java.util.Map headers, java.util.Map queryParams, java.lang.String httpMethod, java.lang.String clientAddr, java.lang.String clientHost, java.util.List resPath, java.lang.String requestURL)`
`OslcRequest(java.util.Map headers, java.util.Map queryParams, java.lang.String httpMethod, java.lang.String clientAddr, java.lang.String clientHost, java.util.List resPath, java.lang.String requestURL, UserInfo userInfo)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 bulkHeaders, java.util.Map bulkQueryParams)`
`void`	`createParallelDMLUserInfo(java.lang.String loginid)`
`java.util.List`	`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()`
`int[]`	`getBytesRange()`
`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`	`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`	`getMetricContext()`
`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`	`getRequestFormatMimeTypeMap()`
`java.lang.String`	`getRequestPublicURI()`
`java.lang.String`	`getRequestURL()`
`java.util.List`	`getResourcePath()`
`java.util.Map`	`getResourceQBE()`
`java.util.Map`	`getResponseCookiesToSet()`
`java.util.Map`	`getResponseFormatMimeTypeMap()`
`java.lang.String`	`getSavedQuery()`
`java.util.Map`	`getSavedQueryParams()`
`java.lang.String`	`getSchemaOrderBy()`
`java.lang.String`	`getSchemaSearchTerm()`
`java.lang.String`	`getSelfRef()`
`protected java.lang.String`	`getSessionBindingName()`
`java.util.Map`	`getSetValueEvalChild()`
`java.lang.String`	`getStableResourceId()`
`java.util.Map`	`getSubSelectRefs()`
`java.lang.String`	`getTemplate()`
`java.lang.Integer`	`getThumbNailHeight()`
`java.lang.Integer`	`getThumbNailSize()`
`java.lang.Integer`	`getThumbNailWidth()`
`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`	`isAddTransLang()`
`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`	`isParallelDML()`
`boolean`	`isProcessAsSelfReferencing()`
`boolean`	`isQueryLocalized()`
`boolean`	`isQueryTemplate()`
`boolean`	`isRangeRequest()`
`boolean`	`isRegUserSession()`
`boolean`	`isRelatedRef()`
`boolean`	`isResourceMeta()`
`boolean`	`isResourceMetaList()`
`protected boolean`	`isRetainsMbos()`
`boolean`	`isSetLocalizedRep()`
`boolean`	`isSetValueMode()`
`boolean`	`isShowHidden()`
`boolean`	`isStrictSchema()`
`boolean`	`isSubmitSession()`
`boolean`	`isThumbNail()`
`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 parts)`
`void`	`setProcessUserInfo(UserInfo processUserInfo)`
`void`	`setResourcePath(java.util.List 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, getMimeTypeForFormat, getPrincipal, getQueryParam, getQueryParam, getQueryParams, getRequestFormat, getRequestMIMEType, getResponseFormat, getResponseMIMEType, isDELETE, isGET, isHEAD, isPATCH, isPOST, isPUT

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OslcRequest

public OslcRequest(java.util.Map headers,
                   java.util.Map queryParams,
                   java.lang.String httpMethod,
                   java.lang.String clientAddr,
                   java.lang.String clientHost,
                   java.util.List resPath,
                   java.lang.String requestURL)
            throws MXException,
                   java.rmi.RemoteException

Throws:: MXException; java.rmi.RemoteException

OslcRequest

public OslcRequest(java.util.Map headers,
                   java.util.Map queryParams,
                   java.lang.String httpMethod,
                   java.lang.String clientAddr,
                   java.lang.String clientHost,
                   java.util.List 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)

createParallelDMLUserInfo

public void createParallelDMLUserInfo(java.lang.String loginid)
                               throws MXException

Throws:: MXException

getInputStream

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

Throws:: java.io.IOException

setParts

public void setParts(java.util.Map parts)

isRangeRequest
```
public boolean isRangeRequest()
```

getBytesRange
```
public int[] getBytesRange()
```

isBranchFilterOn
```
public boolean isBranchFilterOn()
```

isAddTransLang
```
public boolean isAddTransLang()
```

isIgnoreRowstamp
```
public boolean isIgnoreRowstamp()
```

isThumbNail
```
public boolean isThumbNail()
```

getThumbNailWidth

public java.lang.Integer getThumbNailWidth()

getThumbNailSize

public java.lang.Integer getThumbNailSize()

getThumbNailHeight

public java.lang.Integer getThumbNailHeight()

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

isRetainsMbos

protected boolean isRetainsMbos()
                         throws MXException

Throws:: MXException

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 bulkHeaders,
                        java.util.Map 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 resPath)

addIDToURI

public void addIDToURI(java.lang.String id)

replaceIDToURI

public void replaceIDToURI(java.lang.String id)

getAbsolutePath

public java.util.List 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 getResourcePath()

getRequestURL

public java.lang.String getRequestURL()
                               throws MXException

Throws:: MXException

isLeanJSON
```
public boolean isLeanJSON()
```

getAttachmentDocType

public java.lang.String[] getAttachmentDocType()
                                        throws java.io.UnsupportedEncodingException

Throws:: java.io.UnsupportedEncodingException

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 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 getResourceQBE()
```

getSessionBindingName
```
protected java.lang.String getSessionBindingName()
```
Specified by:

getSessionBindingName in class BaseResourceRequest

isGETByPOST
```
public boolean isGETByPOST()
```

getResponseFormatMimeTypeMap
```
public java.util.Map getResponseFormatMimeTypeMap()
```
Specified by:

getResponseFormatMimeTypeMap in class RESTRequest

getRequestFormatMimeTypeMap
```
public java.util.Map 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 getDependentSubSelects()
                                     throws MXException

Throws:: MXException

getSubSelectRefs

public java.util.Map 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 getSetValueEvalChild()

isTlModeDate
```
public boolean isTlModeDate()
```

isStrictSchema
```
public boolean isStrictSchema()
```

getMetricContext

public java.lang.String getMetricContext()

isParallelDML
```
public boolean isParallelDML()
```

isResourceMetaList
```
public boolean isResourceMetaList()
```

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

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

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

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

Methods inherited from class java.lang.Object

OslcRequest

OslcRequest

OslcRequest

setProcessUserInfo

createParallelDMLUserInfo

getInputStream

setParts

isRangeRequest

getBytesRange

isBranchFilterOn

isAddTransLang

isIgnoreRowstamp

isThumbNail

getThumbNailWidth

getThumbNailSize

getThumbNailHeight

isIgnoreKeyref

getPart

isAddSchema

isAddAction

isEnableSession

isNewSession

isAddLocalizedRep

getUseView

getApiKey

getApps

isApiCall

isClientCertMode

isBatchError

verifyCsrfToken

getCsrfTokenFromRequest

getCsrfToken

getGuestId

isQueryLocalized

isCsrfSession

isProcessAsSelfReferencing

isAllowSelfRefDup

getProcessAsSelfRefRelName

isLocalizedDate

getResponseCookiesToSet

serializeToBytes

getTransactionId

resurrectRequest

getHttpServletRequest

setInteractiveRequest

isFileLoad

isAsyncRequest

isInteractiveRequest

isCheckEsig

isIgnoreCollectionRef

isInlineDoc

getUserInfo

readRequestBody

setHttpServletResponse

getHttpServletResponse

isRetainsMbos

setInMemorySort

isInMemorySort

invlaidateSession

bindMboToSession

unbindMboFromSession

getHeader

copy

isRelatedRef

isLocalRef

getAbsoluteURI

getDistinctClause

isDistinct

isAction

isMaxSSO

isCollectionCount

getAction

getTemplate

isBulkOperation

setResourcePath