com.ibm.tivoli.maximo.oslc.provider

Class OSOslcSerializer

java.lang.Object

com.ibm.tivoli.maximo.oslc.provider.OSOslcSerializer

Direct Known Subclasses:

OSOslcJsonSerializer, OSRDFModelGenerator

public abstract class OSOslcSerializer
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addAction
protected boolean	addRowStamp
protected boolean	addSchema
protected boolean	addSchemaUrl
protected boolean	addTransLang
protected boolean	allowSkipRows
protected boolean	bcollectionTotalCount
protected java.util.Map	branchFilter
protected java.lang.String	contentType
protected java.util.Map	descendentProperties
protected AttachmentStorage	docStore
protected boolean	dropNulls
static java.lang.String	DROPNULLS
protected boolean	ignoreKeyRef
protected boolean	inlineAttachment
protected boolean	leanJson
protected java.lang.String	loggerName
protected LocalURIGenerator	luriGen
protected MosInfo	mosInfo
protected MosDefinitionImpl	msi
protected java.lang.String	osApp
protected java.lang.String	oslcBaseOSURI
protected OslcRequest	oslcRequest
protected java.lang.String	osName
protected boolean	pagedExport
protected int	pageNum
protected int	pageSize
protected boolean	paging
protected java.lang.String	resDfltNsURI
protected OslcResourceInfo	resourceInfo
protected java.util.Map	resourceProperties
protected java.lang.String	resURI
protected boolean	retainMbos
static java.lang.String	RETAINMBOS
protected java.lang.StringBuilder	rsBuffer
protected java.lang.String	selfrefRelation
protected boolean	setValueMode
protected boolean	showHidden

Constructor Summary

Constructors

Constructor and Description
OSOslcSerializer(java.lang.String osName, OslcRequest oslcRequest)

Method Summary

Modifier and Type	Method and Description
protected void	cleanUpMboSet(MboSetResource msr, MboIterator mboSet)
protected void	debug(java.lang.String debug)
java.lang.String	deriveCollectionURIFromMemberURI(java.lang.String resMemberURI)
protected java.lang.String	getAction(MboRemote mbo, boolean headerObject)
protected byte[]	getAttachment(java.lang.String uri, MboRemote doclinkMbo)
protected long	getAttachmentSize(MboRemote doclinkMbo)
abstract java.lang.String	getContentType()
java.lang.String	getETag()
protected java.lang.String	getLocalRef(MboRemote mbo, java.lang.Integer index, MosDetailInfo mosDetailInfo, java.lang.String subjectURI, java.lang.String parentPath)
protected MXLogger	getLogger()
protected int	getMaxFetchLimit(OslcResourceInfo resourceInfo)
protected Mbo	getMboFromKeyValueMap(java.lang.String osName, java.util.Map keyValueMap, UserInfo userInfo)
protected java.util.Map	getPropertiesFromRequest(boolean queryResource)
java.lang.Integer	getQueryLimit()
protected boolean	isActionDelete(MboRemote mbo) Check if the action is delete
protected boolean	isActionInsert(MboRemote mbo) Check if the action is add/insert
protected boolean	isActionUpdate(MboRemote mbo) Check if the action is update
protected boolean	isAddPrefixes()
boolean	isAddTransLang()
boolean	isAllowSkipRows()
protected boolean	isAvailableFromSourceResource(java.lang.String osName, java.util.Set srcRes, java.util.Map requestedProps)
protected boolean	isDropNulls(OslcQuery oslcQuery)
protected boolean	isExcludeNS()
protected boolean	isIndexOnLocalResource()
protected boolean	isNull(java.lang.String astr)
boolean	isPagedExport()
protected boolean	isRetainsMbos(OslcQuery oslcQuery)
protected java.util.Map	prepareCachedResource(java.util.Map prefixNsMap, java.lang.String osName, java.lang.String uri, java.util.Map keyValueMap)
protected java.util.List	resolveRelatedReference(MboRemote mbo, java.lang.String refValue)
abstract OslcResourceResponse	serializeResource(Mbo mbo)
abstract OslcResourceResponse	serializeResource(MboIterator mboSet)
void	setAddAction(boolean addAction)
void	setAddRowStamp(boolean addRowStamp)
void	setAddTransLang(boolean addTransLang)
void	setAllowSkipRows(boolean allowSkipRows)
void	setIgnoreKeyRef(boolean keyRef)
void	setInlineAttachment(boolean bool)
void	setPagedExport(boolean pagedExport)

Methods inherited from class java.lang.Object

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

Field Detail

osName

protected java.lang.String osName

mosInfo

protected MosInfo mosInfo

resourceInfo

protected OslcResourceInfo resourceInfo

msi

protected MosDefinitionImpl msi

retainMbos

protected boolean retainMbos

dropNulls

protected boolean dropNulls

loggerName

protected java.lang.String loggerName

allowSkipRows

protected boolean allowSkipRows

oslcBaseOSURI

protected java.lang.String oslcBaseOSURI

pageNum

protected int pageNum

paging

protected boolean paging

pageSize

protected int pageSize

oslcRequest

protected OslcRequest oslcRequest

osApp

protected java.lang.String osApp

resDfltNsURI

protected java.lang.String resDfltNsURI

descendentProperties

protected java.util.Map descendentProperties

inlineAttachment

protected boolean inlineAttachment

addRowStamp

protected boolean addRowStamp

ignoreKeyRef

protected boolean ignoreKeyRef

resourceProperties

protected java.util.Map resourceProperties

RETAINMBOS

public static final java.lang.String RETAINMBOS

See Also:

Constant Field Values

DROPNULLS

public static final java.lang.String DROPNULLS

See Also:

Constant Field Values

rsBuffer

protected java.lang.StringBuilder rsBuffer

contentType

protected java.lang.String contentType

bcollectionTotalCount

protected boolean bcollectionTotalCount

showHidden

protected boolean showHidden

selfrefRelation

protected java.lang.String selfrefRelation

luriGen

protected LocalURIGenerator luriGen

resURI

protected java.lang.String resURI

leanJson

protected boolean leanJson

addSchema

protected boolean addSchema

addSchemaUrl

protected boolean addSchemaUrl

setValueMode

protected boolean setValueMode

docStore

protected AttachmentStorage docStore

addAction

protected boolean addAction

pagedExport

protected boolean pagedExport

addTransLang

protected boolean addTransLang

branchFilter

protected java.util.Map branchFilter

Constructor Detail

OSOslcSerializer

public OSOslcSerializer(java.lang.String osName,
                        OslcRequest oslcRequest)
                 throws MXException,
                        java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

Method Detail

getContentType

public abstract java.lang.String getContentType()

serializeResource

public abstract OslcResourceResponse serializeResource(MboIterator mboSet)
                                                throws MXException,
                                                       java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

serializeResource

public abstract OslcResourceResponse serializeResource(Mbo mbo)
                                                throws MXException,
                                                       java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setPagedExport

public void setPagedExport(boolean pagedExport)

isPagedExport

public boolean isPagedExport()

isAddTransLang

public boolean isAddTransLang()

setAddTransLang

public void setAddTransLang(boolean addTransLang)

setAddRowStamp

public void setAddRowStamp(boolean addRowStamp)

setAddAction

public void setAddAction(boolean addAction)

setIgnoreKeyRef

public void setIgnoreKeyRef(boolean keyRef)

resolveRelatedReference

protected java.util.List resolveRelatedReference(MboRemote mbo,
                                                 java.lang.String refValue)
                                          throws java.lang.NumberFormatException,
                                                 java.rmi.RemoteException,
                                                 MXException

Throws:

java.lang.NumberFormatException

java.rmi.RemoteException

MXException

setInlineAttachment

public void setInlineAttachment(boolean bool)

isExcludeNS

protected boolean isExcludeNS()

debug

protected void debug(java.lang.String debug)

getQueryLimit

public java.lang.Integer getQueryLimit()

deriveCollectionURIFromMemberURI

public java.lang.String deriveCollectionURIFromMemberURI(java.lang.String resMemberURI)

getLocalRef

protected java.lang.String getLocalRef(MboRemote mbo,
                                       java.lang.Integer index,
                                       MosDetailInfo mosDetailInfo,
                                       java.lang.String subjectURI,
                                       java.lang.String parentPath)
                                throws java.rmi.RemoteException,
                                       MXException

Throws:

java.rmi.RemoteException

MXException

getPropertiesFromRequest

protected java.util.Map getPropertiesFromRequest(boolean queryResource)
                                          throws MXException,
                                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getMaxFetchLimit

protected int getMaxFetchLimit(OslcResourceInfo resourceInfo)

isNull

protected boolean isNull(java.lang.String astr)

isIndexOnLocalResource

protected boolean isIndexOnLocalResource()

isRetainsMbos

protected boolean isRetainsMbos(OslcQuery oslcQuery)
                         throws MXException

Throws:

MXException

getETag

public java.lang.String getETag()

setAllowSkipRows

public void setAllowSkipRows(boolean allowSkipRows)

isAllowSkipRows

public boolean isAllowSkipRows()

isAvailableFromSourceResource

protected boolean isAvailableFromSourceResource(java.lang.String osName,
                                                java.util.Set srcRes,
                                                java.util.Map requestedProps)

isDropNulls

protected boolean isDropNulls(OslcQuery oslcQuery)
                       throws MXException

Throws:

MXException

cleanUpMboSet

protected void cleanUpMboSet(MboSetResource msr,
                             MboIterator mboSet)
                      throws java.rmi.RemoteException,
                             MXException

Throws:

java.rmi.RemoteException

MXException

getMboFromKeyValueMap

protected Mbo getMboFromKeyValueMap(java.lang.String osName,
                                    java.util.Map keyValueMap,
                                    UserInfo userInfo)
                             throws MXException,
                                    java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

prepareCachedResource

protected java.util.Map prepareCachedResource(java.util.Map prefixNsMap,
                                              java.lang.String osName,
                                              java.lang.String uri,
                                              java.util.Map keyValueMap)

getAttachment

protected byte[] getAttachment(java.lang.String uri,
                               MboRemote doclinkMbo)
                        throws java.rmi.RemoteException,
                               MXException

Throws:

java.rmi.RemoteException

MXException

getAttachmentSize

protected long getAttachmentSize(MboRemote doclinkMbo)
                          throws java.rmi.RemoteException,
                                 MXException

Throws:

java.rmi.RemoteException

MXException

getLogger

protected MXLogger getLogger()

isAddPrefixes

protected boolean isAddPrefixes()

isActionUpdate

protected boolean isActionUpdate(MboRemote mbo)
                          throws java.rmi.RemoteException

Check if the action is update

Returns:

true/false depending on if the action is update

Throws:

java.rmi.RemoteException

isActionInsert

protected boolean isActionInsert(MboRemote mbo)
                          throws java.rmi.RemoteException

Check if the action is add/insert

Returns:

true/false depending on if the action is add

Throws:

java.rmi.RemoteException

isActionDelete

protected boolean isActionDelete(MboRemote mbo)
                          throws java.rmi.RemoteException

Check if the action is delete

Returns:

true/false depending on if the action is delete

Throws:

java.rmi.RemoteException

getAction

protected java.lang.String getAction(MboRemote mbo,
                                     boolean headerObject)
                              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException