psdi.iface.mos

Class StAXStructure

java.lang.Object

psdi.iface.mos.StAXStructure

All Implemented Interfaces:

MosConstants

Direct Known Subclasses:

MBOStAXStructure, MOSStAXStructure

public abstract class StAXStructure
extends java.lang.Object
implements MosConstants

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	binaryText
protected java.io.ByteArrayOutputStream	bo
protected boolean	dropNullCols
protected boolean	externalWriter
protected static MXLogger	integrationLogger
protected static MXLogger	INTEGRATIONLOGGER
protected boolean	localizedRep
protected OslcRequest	oslcRequest
protected static javax.xml.stream.XMLOutputFactory	outputFactory
protected boolean	retainMbos
protected UserInfo	userInfo UserInfo of the user who initiated transaction
protected boolean	useRowStamp
protected boolean	useScientificNotation
protected boolean	validateXMLText
protected javax.xml.stream.XMLStreamWriter	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
StAXStructure()
StAXStructure(boolean dropNullCols)
StAXStructure(boolean dropNullCols, boolean retainMbos)

Method Summary

Modifier and Type	Method and Description
protected void	addExtensibilityAttributes(java.lang.String name, MboRemote mbo, java.lang.Object ovrdColValue, boolean overridden)
protected abstract byte[]	createXML(MboIterator mboSet, int startIndex, int maxCount)
protected abstract byte[]	createXML(MboRemote mbo, boolean asSet)
protected void	init(java.lang.Object mboOrSet, javax.xml.stream.XMLStreamWriter writer)
protected void	initSerialization(MboSetRemote mboOrSet)
protected boolean	isGLCompRequired(java.lang.String mboAttrName, MboRemote mbo)
protected boolean	isMaxValueRequired(java.lang.String mboAttrName, MboRemote mbo)
protected boolean	isRequiresChangeIndicator(java.lang.String mboAttrName, MboRemote mbo)
boolean	isUseRowStamp()
protected boolean	isUseTotalCount()
protected boolean	isValidateXMLText(java.lang.String mboAttrName, MboRemote mbo)
byte[]	serializeMbo(MboRemote mbo)
void	serializeMbo(javax.xml.stream.XMLStreamWriter writer, MboRemote mbo)
byte[]	serializeMboArray(MboRemote[] mboArray)
byte[]	serializeMboArray(MboRemote[] mboArray, int startIndex, int maxCount)
void	serializeMboArray(javax.xml.stream.XMLStreamWriter writer, MboRemote[] mboArray)
byte[]	serializeMboAsSet(MboRemote mbo)
void	serializeMboAsSet(javax.xml.stream.XMLStreamWriter writer, MboRemote mbo)
byte[]	serializeMboIterator(MboIterator mboSet)
byte[]	serializeMboIterator(MboIterator mboSet, int startIndex, int maxCount)
void	serializeMboIterator(javax.xml.stream.XMLStreamWriter writer, MboIterator mboSet)
byte[]	serializeMboList(java.util.List mboList)
byte[]	serializeMboList(java.util.List mboList, int startIndex, int maxCount)
void	serializeMboList(javax.xml.stream.XMLStreamWriter writer, java.util.List mboList)
byte[]	serializeMboSet(MboSetRemote mboSet)
byte[]	serializeMboSet(MboSetRemote mboSet, int startIndex, int maxCount)
void	serializeMboSet(javax.xml.stream.XMLStreamWriter writer, MboSetRemote mboSet)
void	setAllowBinaryText(boolean binaryText)
protected void	setDefaultNS()
void	setJsonRequest(OslcRequest jsonRequest)
void	setLocalizedRep(boolean localizedRep)
protected void	setMboColumnElement(java.lang.String xmlTagName, java.lang.String mboAttrName, MboValueInfo mboValueInfo, MboRemote mbo, java.lang.Object ovrdColValue, boolean overridden)
void	setUseRowStamp(boolean useRowStamp)
protected void	setXSINS()
protected boolean	useMboValueForSendersysid()
protected void	writeCharacters(java.lang.String mboAttrName, MboValueInfo mboValueInfo, MboRemote mbo, java.lang.String xmlTagName, java.lang.String tagValue)
protected void	writeDefaultNS()
protected void	writeXSINS()

Methods inherited from class java.lang.Object

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

Field Detail

INTEGRATIONLOGGER

protected static final MXLogger INTEGRATIONLOGGER

dropNullCols

protected boolean dropNullCols

validateXMLText

protected boolean validateXMLText

retainMbos

protected boolean retainMbos

userInfo

protected UserInfo userInfo

UserInfo of the user who initiated transaction

writer

protected javax.xml.stream.XMLStreamWriter writer

bo

protected java.io.ByteArrayOutputStream bo

integrationLogger

protected static final MXLogger integrationLogger

outputFactory

protected static javax.xml.stream.XMLOutputFactory outputFactory

externalWriter

protected boolean externalWriter

useScientificNotation

protected boolean useScientificNotation

binaryText

protected boolean binaryText

useRowStamp

protected boolean useRowStamp

localizedRep

protected boolean localizedRep

oslcRequest

protected OslcRequest oslcRequest

Constructor Detail

StAXStructure

public StAXStructure()

StAXStructure

public StAXStructure(boolean dropNullCols)

Parameters:

dropNullCols - ignore null value columns while serializing

StAXStructure

public StAXStructure(boolean dropNullCols,
                     boolean retainMbos)

Parameters:

dropNullCols - ignore null value columns while serializing

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

Method Detail

isUseRowStamp

public boolean isUseRowStamp()

setUseRowStamp

public void setUseRowStamp(boolean useRowStamp)

setLocalizedRep

public void setLocalizedRep(boolean localizedRep)

init

protected void init(java.lang.Object mboOrSet,
                    javax.xml.stream.XMLStreamWriter writer)
             throws MXException,
                    java.rmi.RemoteException

Parameters:

mboOrSet - the Mbo/Set to serialize as XML.

writer - the XMLStreamWriter to which to write the serialized XML bytes

Throws:

MXException

java.rmi.RemoteException

initSerialization

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

Throws:

MXException

java.rmi.RemoteException

setAllowBinaryText

public void setAllowBinaryText(boolean binaryText)

serializeMbo

public byte[] serializeMbo(MboRemote mbo)
                    throws MXException,
                           java.rmi.RemoteException

Parameters:

mbo - the Mbo to serialize as XML.

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

serializeMbo

public void serializeMbo(javax.xml.stream.XMLStreamWriter writer,
                         MboRemote mbo)
                  throws MXException,
                         java.rmi.RemoteException

Parameters:

writer - the XMLStreamWriter to which to write the serialized XML bytes

mbo - the Mbo to serialize as XML.

Throws:

MXException

java.rmi.RemoteException

serializeMboAsSet

public byte[] serializeMboAsSet(MboRemote mbo)
                         throws MXException,
                                java.rmi.RemoteException

Parameters:

mbo - the Mbo to serialize as XML.

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

serializeMboAsSet

public void serializeMboAsSet(javax.xml.stream.XMLStreamWriter writer,
                              MboRemote mbo)
                       throws MXException,
                              java.rmi.RemoteException

Parameters:

writer - the XMLStreamWriter to which to write the serialized XML bytes

mbo - the Mbo to serialize as XML.

Throws:

MXException

java.rmi.RemoteException

serializeMboSet

public byte[] serializeMboSet(MboSetRemote mboSet,
                              int startIndex,
                              int maxCount)
                       throws MXException,
                              java.rmi.RemoteException

Parameters:

mboSet - the MboSet to serialize

startIndex - the MboSet index to start serializing from.

maxCount - the maximum number of Mbos [in the MboSet] to serialize

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

serializeMboSet

public byte[] serializeMboSet(MboSetRemote mboSet)
                       throws MXException,
                              java.rmi.RemoteException

Parameters:

mboSet - the MboSet to serialize

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

serializeMboIterator

public void serializeMboIterator(javax.xml.stream.XMLStreamWriter writer,
                                 MboIterator mboSet)
                          throws MXException,
                                 java.rmi.RemoteException

Parameters:

writer - the XMLStreamWriter to which to write the serialized XML bytes

mboSet - the MboSet to serialize

Throws:

MXException

java.rmi.RemoteException

serializeMboIterator

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

Parameters:

mboSet - the MboSet to serialize

startIndex - the MboSet index to start serializing from.

maxCount - the maximum number of Mbos [in the MboSet] to serialize

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

serializeMboIterator

public byte[] serializeMboIterator(MboIterator mboSet)
                            throws MXException,
                                   java.rmi.RemoteException

Parameters:

mboSet - the MboSet to serialize

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

serializeMboSet

public void serializeMboSet(javax.xml.stream.XMLStreamWriter writer,
                            MboSetRemote mboSet)
                     throws MXException,
                            java.rmi.RemoteException

Parameters:

writer - the XMLStreamWriter to which to write the serialized XML bytes

mboSet - the MboSet to serialize

Throws:

MXException

java.rmi.RemoteException

serializeMboList

public byte[] serializeMboList(java.util.List mboList,
                               int startIndex,
                               int maxCount)
                        throws MXException,
                               java.rmi.RemoteException

Parameters:

mboList - The List of Mbos to serialize

startIndex - the List index to start serializing from.

maxCount - the maximum number of Mbos [in the List] to serialize

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

serializeMboList

public byte[] serializeMboList(java.util.List mboList)
                        throws MXException,
                               java.rmi.RemoteException

Parameters:

mboList - The List of Mbos to serialize

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

serializeMboList

public void serializeMboList(javax.xml.stream.XMLStreamWriter writer,
                             java.util.List mboList)
                      throws MXException,
                             java.rmi.RemoteException

Parameters:

writer - the XMLStreamWriter to which to write the serialized XML bytes

mboList - The List of Mbos to serialize

Throws:

MXException

java.rmi.RemoteException

serializeMboArray

public void serializeMboArray(javax.xml.stream.XMLStreamWriter writer,
                              MboRemote[] mboArray)
                       throws MXException,
                              java.rmi.RemoteException

Parameters:

writer - the XMLStreamWriter to which to write the serialized XML bytes

mboArray - The array of Mbos to serialize

Throws:

MXException

java.rmi.RemoteException

serializeMboArray

public byte[] serializeMboArray(MboRemote[] mboArray,
                                int startIndex,
                                int maxCount)
                         throws MXException,
                                java.rmi.RemoteException

Parameters:

mboArray - The array of Mbos to serialize

startIndex - the array index to start serializing from.

maxCount - the maximum number of Mbos [in the List] to serialize

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

serializeMboArray

public byte[] serializeMboArray(MboRemote[] mboArray)
                         throws MXException,
                                java.rmi.RemoteException

Parameters:

mboArray - The array of Mbos to serialize

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

createXML

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

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

createXML

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

Parameters:

mboSet - the MboSet to serialize

startIndex - the index to start serializing from.

maxCount - the maximum number of Mbos to serialize

Returns:

the resultant XML document as bytes

Throws:

MXException

java.rmi.RemoteException

setDefaultNS

protected void setDefaultNS()
                     throws javax.xml.stream.XMLStreamException,
                            java.rmi.RemoteException

Throws:

javax.xml.stream.XMLStreamException

java.rmi.RemoteException

writeDefaultNS

protected void writeDefaultNS()
                       throws javax.xml.stream.XMLStreamException,
                              java.rmi.RemoteException

Throws:

javax.xml.stream.XMLStreamException

java.rmi.RemoteException

setXSINS

protected void setXSINS()
                 throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

writeXSINS

protected void writeXSINS()
                   throws javax.xml.stream.XMLStreamException

Throws:

javax.xml.stream.XMLStreamException

setMboColumnElement

protected void setMboColumnElement(java.lang.String xmlTagName,
                                   java.lang.String mboAttrName,
                                   MboValueInfo mboValueInfo,
                                   MboRemote mbo,
                                   java.lang.Object ovrdColValue,
                                   boolean overridden)
                            throws java.rmi.RemoteException,
                                   MXException,
                                   javax.xml.stream.XMLStreamException

Parameters:

mboAttrName -

mbo -

ovrdColValue -

Throws:

java.rmi.RemoteException

MXException

javax.xml.stream.XMLStreamException

writeCharacters

protected void writeCharacters(java.lang.String mboAttrName,
                               MboValueInfo mboValueInfo,
                               MboRemote mbo,
                               java.lang.String xmlTagName,
                               java.lang.String tagValue)
                        throws java.rmi.RemoteException,
                               MXException,
                               javax.xml.stream.XMLStreamException

Throws:

java.rmi.RemoteException

MXException

javax.xml.stream.XMLStreamException

addExtensibilityAttributes

protected void addExtensibilityAttributes(java.lang.String name,
                                          MboRemote mbo,
                                          java.lang.Object ovrdColValue,
                                          boolean overridden)
                                   throws java.rmi.RemoteException,
                                          MXException,
                                          javax.xml.stream.XMLStreamException

Throws:

java.rmi.RemoteException

MXException

javax.xml.stream.XMLStreamException

isMaxValueRequired

protected boolean isMaxValueRequired(java.lang.String mboAttrName,
                                     MboRemote mbo)

isGLCompRequired

protected boolean isGLCompRequired(java.lang.String mboAttrName,
                                   MboRemote mbo)

isRequiresChangeIndicator

protected boolean isRequiresChangeIndicator(java.lang.String mboAttrName,
                                            MboRemote mbo)

useMboValueForSendersysid

protected boolean useMboValueForSendersysid()

isValidateXMLText

protected boolean isValidateXMLText(java.lang.String mboAttrName,
                                    MboRemote mbo)

isUseTotalCount

protected boolean isUseTotalCount()

setJsonRequest

public void setJsonRequest(OslcRequest jsonRequest)