psdi.iface.mos

Class MOSStAXStructure

java.lang.Object

psdi.iface.mos.StAXStructure

psdi.iface.mos.MOSStAXStructure

All Implemented Interfaces:

MosConstants

Direct Known Subclasses:

RESTOSStAXStructure

public class MOSStAXStructure
extends StAXStructure

The XML serialization class for Object Structures.

Field Summary

Fields

Modifier and Type	Field and Description
static int	WRITE_ALL
static int	WRITE_KEYS
static int	WRITE_SKIP

Fields inherited from class psdi.iface.mos.StAXStructure

binaryText, bo, dropNullCols, externalWriter, integrationLogger, INTEGRATIONLOGGER, localizedRep, oslcRequest, outputFactory, retainMbos, userInfo, useRowStamp, useScientificNotation, validateXMLText, writer

Fields inherited from interface psdi.iface.mos.MosConstants

ACTION, ACTIONADD, ACTIONADDUPDATE, ACTIONDELETE, ACTIONREPLACE, ACTIONUPDATE, ADAPTER_INSTALL, ADD, ADDATEND, BASELANGUAGE, BYPASS, COMPANYSETID_NAME, COMPLETE, CONFIGFILENAME, CREATIONDATETIME, DELETEFORINSERT, DEPLOYMENT_MANAGER, ENTERPRISE_SERVICE, ERRORTAG, ESCAPECHAR, EVENT, FILTERMBOKEY, INVOKE_CHANNEL, ITEMSETID_NAME, MAXIMO_NS_PREFIX, MAXIMOVERSION, MESSAGEID, MESSAGETYPE_CREATE, MESSAGETYPE_DELETE, MESSAGETYPE_INITIATE, MESSAGETYPE_INVOKE, MESSAGETYPE_MERGE, MESSAGETYPE_PATCH, MESSAGETYPE_PROCESS, MESSAGETYPE_PUBLISH, MESSAGETYPE_QUERY, MESSAGETYPE_RESPONSE, MESSAGETYPE_SYNC, MESSAGETYPE_UPDATE, MESSAGETYPE_WAKEUP, OBJECT_STRUCTURE_SERVICE, ORGID_NAME, OVERRIDEALWAYS, OVERRIDENULLONLY, PROCESS, SITEID_NAME, SKIP, SKIPMBO, SKIPMBOKEY, STANDARD_SERVICE, TRANSLANGUAGE, UPDATE, XSI_NS, XSI_NS_PREFIX

Constructor Summary

Constructors

Constructor and Description
MOSStAXStructure(java.util.Map defnMetaData, java.lang.String mosName, boolean retainMbos, boolean updatesOnly)
MOSStAXStructure(java.util.Map defnMetaData, java.lang.String mosName, boolean event, boolean retainMbos, java.lang.String operationName, boolean response, boolean updatesOnly)
MOSStAXStructure(java.util.Map defnMetaData, java.lang.String mosName, boolean event, java.lang.String operationName, boolean response)
MOSStAXStructure(java.lang.String defClassName, java.util.Map defnMetaData, java.lang.String mosName, boolean event, boolean retainMbos, boolean ignoreActions, java.lang.String operationName, boolean response, boolean updatesOnly)
MOSStAXStructure(java.lang.String defClassName, java.util.Map defnMetaData, java.lang.String mosName, boolean event, boolean retainMbos, boolean ignoreActions, java.lang.String operationName, boolean response, boolean updatesOnly, java.lang.String inputAction)
MOSStAXStructure(java.lang.String defClassName, java.util.Map defnMetaData, java.lang.String mosName, boolean event, boolean retainMbos, boolean ignoreActions, java.lang.String operationName, boolean response, boolean updatesOnly, java.lang.String inputAction, boolean dropNullCols)
MOSStAXStructure(java.lang.String defClassName, java.util.Map defnMetaData, java.lang.String mosName, boolean event, boolean retainMbos, java.lang.String operationName, boolean response, boolean updatesOnly)
MOSStAXStructure(java.lang.String defClassName, java.util.Map defnMetaData, java.lang.String mosName, boolean event, java.lang.String operationName, boolean response)

Method Summary

Modifier and Type	Method and Description
protected void	addObjectExtensibilityAttributes(MboRemote mbo)
protected void	applyFilterMbosetExpr(MboSetRemote childMboSet)
protected int	createStructure(MboRemote mbo, MosDetailInfo info, boolean headerObject, java.util.Map resourceProperties)
protected byte[]	createXML(MboIterator mboSet, int startIndex, int maxCount) Create the outbound XML.
protected byte[]	createXML(MboRemote mbo, boolean asSet)
boolean	evaluateMboXmlType()
protected java.lang.String	getAction(MboRemote mbo, boolean headerObject) This will return the action indicator depending on mbo action and updatesonly flag for the integration point
protected java.util.Map	getDefinitionMetadata(java.util.Map defnMetaData) Get definition meta data
protected int	getMboXmlType(MboRemote mbo, MosDetailInfo info, boolean evaluateXmlType)
MosDefinitionImpl	getMosDefinitionImpl()
int	getSerializedMboCount()
java.util.List	getUsedMboList()
protected void	init(MboRemote mbo, javax.xml.stream.XMLStreamWriter writer, java.util.Map externalPrefixNSMap)
protected void	initSerialization(MboSetRemote mboOrSet)
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
boolean	isAllowSkipRows()
void	setAllowEmptyXML(boolean emptyXML)
void	setAllowSkipRows(boolean allowSkipRows)
void	setEvaluateMboXmlType(boolean evaluateXMLType)
void	setInitialResolvedCount(int initialResolvedCount)
protected void	setMboActionAttribute(MboRemote mbo, boolean headerObject)
void	setProcessAsSelfRefRelName(java.lang.String relName, boolean allowSelfRefDup)
void	setResolvedStartCount(int resolvedStartCount)
void	setResolvedTotalCount(int resolvedTotalCount)
void	setResourceProperties(java.util.Map resourceProperties)
void	setTotalCount(java.lang.Integer totCount)

Methods inherited from class psdi.iface.mos.StAXStructure

addExtensibilityAttributes, init, isGLCompRequired, isMaxValueRequired, isRequiresChangeIndicator, isUseRowStamp, isUseTotalCount, isValidateXMLText, serializeMbo, serializeMbo, serializeMboArray, serializeMboArray, serializeMboArray, serializeMboAsSet, serializeMboAsSet, serializeMboIterator, serializeMboIterator, serializeMboIterator, serializeMboList, serializeMboList, serializeMboList, serializeMboSet, serializeMboSet, serializeMboSet, setAllowBinaryText, setDefaultNS, setJsonRequest, setLocalizedRep, setMboColumnElement, setUseRowStamp, setXSINS, useMboValueForSendersysid, writeCharacters, writeDefaultNS, writeXSINS

Methods inherited from class java.lang.Object

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

Field Detail

WRITE_ALL

public static final int WRITE_ALL

See Also:

Constant Field Values

WRITE_SKIP

public static final int WRITE_SKIP

See Also:

Constant Field Values

WRITE_KEYS

public static final int WRITE_KEYS

See Also:

Constant Field Values

Constructor Detail

MOSStAXStructure

public MOSStAXStructure(java.util.Map defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        boolean retainMbos,
                        java.lang.String operationName,
                        boolean response,
                        boolean updatesOnly)
                 throws MXException

Parameters:

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

retainMbos - if set to true will not discard the Mbos that are being serialized.

operationName - the operation name

response - true if serilization needs to be done for response of the operation

updatesOnly - send only updated fields out if set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.lang.String defClassName,
                        java.util.Map defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        boolean retainMbos,
                        java.lang.String operationName,
                        boolean response,
                        boolean updatesOnly)
                 throws MXException

Parameters:

defClassName - the object structure defintion class name. This is the call back class for OS xml creation.

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

retainMbos - if set to true will not discard the Mbos that are being serialized.

operationName - the operation name

response - true if serilization needs to be done for response of the operation

updatesOnly - send only updated fields out if set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.lang.String defClassName,
                        java.util.Map defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        boolean retainMbos,
                        boolean ignoreActions,
                        java.lang.String operationName,
                        boolean response,
                        boolean updatesOnly)
                 throws MXException

Parameters:

defClassName - the object structure defintion class name. This is the call back class for OS xml creation.

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

retainMbos - if set to true will not discard the Mbos that are being serialized.

operationName - the operation name

response - true if serilization needs to be done for response of the operation

updatesOnly - send only updated fields out if set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.lang.String defClassName,
                        java.util.Map defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        boolean retainMbos,
                        boolean ignoreActions,
                        java.lang.String operationName,
                        boolean response,
                        boolean updatesOnly,
                        java.lang.String inputAction)
                 throws MXException

Parameters:

defClassName - the object structure defintion class name. This is the call back class for OS xml creation.

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

retainMbos - if set to true will not discard the Mbos that are being serialized.

operationName - the operation name

response - true if serilization needs to be done for response of the operation

updatesOnly - send only updated fields out if set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.lang.String defClassName,
                        java.util.Map defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        boolean retainMbos,
                        boolean ignoreActions,
                        java.lang.String operationName,
                        boolean response,
                        boolean updatesOnly,
                        java.lang.String inputAction,
                        boolean dropNullCols)
                 throws MXException

Parameters:

defClassName - the object structure defintion class name. This is the call back class for OS xml creation.

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

ignoreActions - true implies that this request for serialization will ignore all Mbo actions even if the Mbos are modified

retainMbos - if set to true will not discard the Mbos that are being serialized.

operationName - the operation name

response - true if serilization needs to be done for response of the operation

updatesOnly - send only updated fields out if set to true.

dropNullCols - drops null value clumns from xml if this is set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.util.Map defnMetaData,
                        java.lang.String mosName,
                        boolean retainMbos,
                        boolean updatesOnly)
                 throws MXException

Parameters:

defnMetaData - the Metadata for serialization

mosName - the object structure name

retainMbos - if set to true will not discard the Mbos that are being serialized.

updatesOnly - send only updated fields out if set to true.

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.lang.String defClassName,
                        java.util.Map defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        java.lang.String operationName,
                        boolean response)
                 throws MXException

Parameters:

defClassName - the object structure defintion class name. This is the call back class for OS xml creation.

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

operationName - the operation name

response - true if serilization needs to be done for response of the operation

Throws:

MXException

MOSStAXStructure

public MOSStAXStructure(java.util.Map defnMetaData,
                        java.lang.String mosName,
                        boolean event,
                        java.lang.String operationName,
                        boolean response)
                 throws MXException

Parameters:

defnMetaData - the Metadata for serialization

mosName - the object structure name

event - true implies that this request for serialization is based on an Mbo event

operationName - the operation name

response - true if serilization needs to be done for response of the operation

Throws:

MXException

Method Detail

setProcessAsSelfRefRelName

public void setProcessAsSelfRefRelName(java.lang.String relName,
                                       boolean allowSelfRefDup)

setResourceProperties

public void setResourceProperties(java.util.Map resourceProperties)

setAllowEmptyXML

public void setAllowEmptyXML(boolean emptyXML)

setEvaluateMboXmlType

public void setEvaluateMboXmlType(boolean evaluateXMLType)

evaluateMboXmlType

public boolean evaluateMboXmlType()

setAllowSkipRows

public void setAllowSkipRows(boolean allowSkipRows)

isAllowSkipRows

public boolean isAllowSkipRows()

getMosDefinitionImpl

public MosDefinitionImpl getMosDefinitionImpl()

Returns:

return the callback class handle

getUsedMboList

public java.util.List getUsedMboList()

Returns:

the list of primary Mbos that were actually serialized

getSerializedMboCount

public int getSerializedMboCount()

Returns:

the count of Mbos serialized

init

protected void init(MboRemote mbo,
                    javax.xml.stream.XMLStreamWriter writer,
                    java.util.Map externalPrefixNSMap)
             throws MXException,
                    java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setMboActionAttribute

protected void setMboActionAttribute(MboRemote mbo,
                                     boolean headerObject)
                              throws java.rmi.RemoteException,
                                     javax.xml.stream.XMLStreamException

Throws:

java.rmi.RemoteException

javax.xml.stream.XMLStreamException

applyFilterMbosetExpr

protected void applyFilterMbosetExpr(MboSetRemote childMboSet)
                              throws java.rmi.RemoteException,
                                     MXException

Throws:

java.rmi.RemoteException

MXException

getMboXmlType

protected int getMboXmlType(MboRemote mbo,
                            MosDetailInfo info,
                            boolean evaluateXmlType)
                     throws java.rmi.RemoteException,
                            MXException

Throws:

java.rmi.RemoteException

MXException

createStructure

protected int createStructure(MboRemote mbo,
                              MosDetailInfo info,
                              boolean headerObject,
                              java.util.Map resourceProperties)
                       throws MXException,
                              java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

addObjectExtensibilityAttributes

protected void addObjectExtensibilityAttributes(MboRemote mbo)
                                         throws java.rmi.RemoteException,
                                                MXException,
                                                javax.xml.stream.XMLStreamException

Throws:

java.rmi.RemoteException

MXException

javax.xml.stream.XMLStreamException

createXML

protected byte[] createXML(MboRemote mbo,
                           boolean asSet)
                    throws MXException,
                           java.rmi.RemoteException

Specified by:

createXML in class StAXStructure

Parameters:

mbo - the Mbo to serialize

asSet - if set to true will serialize this Mbo as a MboSet with one Mbo.

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

setTotalCount

public void setTotalCount(java.lang.Integer totCount)

createXML

protected byte[] createXML(MboIterator mboSet,
                           int startIndex,
                           int maxCount)
                    throws MXException,
                           java.rmi.RemoteException

Create the outbound XML. This method should be used by Data Export / WebServices response (when there can be multiple records in outbound XML)

Specified by:

createXML in class StAXStructure

Parameters:

mboSet - mboSet

startIndex - the start index of the mboSet

maxCount - the maximum number of records to be sent out

Returns:

the resultant XML document as bytes

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getAction

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

This will return the action indicator depending on mbo action and updatesonly flag for the integration point

Parameters:

mbo - the mbo

headerObject - true if its the root object

Returns:

the action for the mbo

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

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

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

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

getDefinitionMetadata

protected java.util.Map getDefinitionMetadata(java.util.Map defnMetaData)
                                       throws java.rmi.RemoteException

Get definition meta data

Returns:

definition meta data

Throws:

java.rmi.RemoteException

setResolvedTotalCount

public void setResolvedTotalCount(int resolvedTotalCount)

setInitialResolvedCount

public void setInitialResolvedCount(int initialResolvedCount)

setResolvedStartCount

public void setResolvedStartCount(int resolvedStartCount)

initSerialization

protected void initSerialization(MboSetRemote mboOrSet)
                          throws java.rmi.RemoteException,
                                 MXException

Overrides:

initSerialization in class StAXStructure

Throws:

java.rmi.RemoteException

MXException