com.ibm.tivoli.maximo.fdmbo

Class RESTMboSet

java.lang.Object

psdi.mbo.MboSet

psdi.mbo.NonPersistentMboSet

com.ibm.tivoli.maximo.fdmbo.JSONMboSet

com.ibm.tivoli.maximo.fdmbo.RESTMboSet

All Implemented Interfaces:

java.rmi.Remote, MboAccessInterface, MboConstants, MboSetRemote, NonPersistentMboSetRemote, MaxRemoteProxy, Transactable, FixedLoggerNames, FixedLoggers

Direct Known Subclasses:

CloudantMboSet

public class RESTMboSet
extends JSONMboSet

REST Set object definition.

Version:

1.0

Author:

Anamitra

Field Summary

Fields inherited from class psdi.mbo.MboSet

fetchStopLimitEnabled, LOOKUPMAXROW, maxSorterSize, mboCountCleanuplist, perfStats, strNoBaseLangValueEntered

Fields inherited from interface psdi.mbo.MboSetRemote

INSERTONLY, INSERTORUPDATE, UPDATEONLY

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
RESTMboSet(MboServerInterface ms) Constructor

Method Summary

Modifier and Type	Method and Description
void	execute() Method o be called in non-persistent object on save
byte[]	formatPostData(int index, boolean forCount) Default implementation for formats where clause for POST.
byte[]	formatPostDataForNextPage(byte[] data, int index) Default implementation for formats data for next page
java.lang.String	formatUrl(java.lang.String url, java.lang.String method) Formats where clause.
java.lang.String	formatUrlForNextPage(java.lang.String url, int index, java.lang.String method) Formats where clause.
java.lang.String	formatUrlForSortPage(java.lang.String url, int index, boolean forCount, java.lang.String method) Add sort and paging to existing URL.
void	formatWhere(java.util.List<java.lang.String> whereList, java.lang.String where) Formats where clause.
java.lang.String	getCountClause() Return count clause.
java.lang.String	getHTTPQueryMethod() Get HTTP method.
java.lang.Object[]	getOpAndValue(java.lang.String expression) Parse expression to get operation and value
java.lang.String	getOrderByClouse() Return order by clause.
java.lang.String[]	getPagingParams() Return parameters for paging.
java.lang.String	getStringQualifier() Return string qualifies.
java.lang.String	getUrl(HTTPHandler handler, boolean forCount) Return original URL.
java.lang.String	getWhereSeparator() Formats where separator.
java.lang.String	getWhereToFormat(java.lang.String where) Return formatted where clause.
java.lang.String	getWhereToFormat(java.lang.String where, boolean isRelationship) Return formatted where clause.
byte[]	invoke(int index, boolean forCount) Implementation of invoke of the external data to MboSet for REST call
void	load(int index) Implementation of load of the external data to MboSet using REST
MboRemote	moveNext() Override this method so that the current index of the mboset doesn't change during loading through moveNext() call.
MboRemote	moveTo(int pos) Override this method so that the current index of the mboset doesn't change during loading through moveNext() call.
void	resetQbe() Reset the QBE for this object, i.e.
void	setQbe(java.lang.String attribute, java.lang.String expression) Sets QBE.

Methods inherited from class com.ibm.tivoli.maximo.fdmbo.JSONMboSet

bytesToJSONArray, count, deserialize, formatResourceName, getBulkUpdate, getCountFromResponse, getDataAsDouble, getDateFormat, getDateFormatType, getEndPointName, getLimit, getMbo, getMetaData, getNullFormat, getProductName, getResourceName, getURL, json2Mbo, json2MboSet, moveLast, reset, resetJSON, setAdditionalData, setAppWhere, setBulkUpdate, setDateFormat, setDateFormatType, setRelationship, setResourceName, setup, setUserWhere, setUserWhereAfterParse, setWhere, supportsUpdate, toBeSaved

Methods inherited from class psdi.mbo.NonPersistentMboSet

execute, isClosed, setMboSetInfo

Methods inherited from class psdi.mbo.MboSet

abortSql, add, add, addAtEnd, addAtEnd, addAtIndex, addAtIndex, addFakeAtEnd, addFederatedMboToSorter, addSubQbe, addSubQbe, addSubQbe, addSubQbe, addToEndOfSelectStatement, addWarning, addWarnings, appendToWhere, applyRowSecurity, avg, canAdd, cancelAndClose, checkMethodAccess, checkMethodAccess, cleanup, clear, clearBatchedPreparedStmt, clearBatchedPreparedStmts, clearESigTransactionIdThread, clearESigTransIDForAdmin, clearIgnoredAutokeyAttrs, clearLongOpPipe, clearToBeSaved, clearTransactionReference, clearWarnings, close, commit, commitTransaction, copy, copy, copy, copyForDM, count, deleteAll, deleteAll, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemoveAll, deleteAndRemoveAll, determineRequiredFieldsFromERM, dump, earliestDate, enableMethod, executeBatch, fetchNext, findAllNullRequiredFields, findByIntegrationKey, findKey, fireEventsAfterDB, fireEventsAfterDBCommit, fireEventsBeforeDB, forceDBSort, getAllowQualifiedRestriction, getAlwaysFlags, getAlwaysFlags, getApp, getAppAlwaysFieldFlags, getAppWhere, getAttrRestrictions, getBoolean, getByte, getBytes, getClientLocale, getClientTimeZone, getCompleteWhere, getCurrentPosition, getDate, getDBFetchMaxRows, getDefaultValue, getDefaultValueHash, getDouble, getERMEntity, getESigTransactionId, getExcludeMeFromPropagation, getFlags, getFloat, getIgnoredAutokeyAttrs, getInsertCompanySet, getInsertItemSet, getInsertOrg, getInsertSite, getInt, getJspDefaultValueHash, getKeyAttributes, getList, getList, getLong, getMaxAppsWhere, getMaxMessage, getMbo, getMboForUniqueId, getMboLogger, getMboServer, getMboSetData, getMboSetData, getMboSetInfo, getMboSetRetainMboPositionData, getMboSetRetainMboPositionInfo, getMboSetValueData, getMboSetValueData, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMLFromClause, getMultiSiteWhere, getMXTransaction, getName, getOrderBy, getOwner, getParentApp, getPreparedStmt, getProfile, getProxy, getQbe, getQbe, getQbe, getQbeSiteAuthorization, getQbeWhere, getQualifiedWhere, getQueryTimeout, getRelationName, getRelationship, getRowRestrictions, getSecurityLogger, getSelection, getSelectionWhere, getSetOrderByForUI, getSharedMboSet, getSize, getSkipFirstNRows, getSqlLogger, getSQLOptions, getString, getTxnPropertyMap, getUserAndQbeWhere, getUserInfo, getUserName, getUserPrefWhere, getUserWhere, getUserWhere, getWarnings, getWhere, getZombie, handleMLMbo, handleMLMbo, hasMLQbe, hasQbe, hasWarnings, ignoreAutokeyAttr, ignoreAutokeyAttr, ignoreQbeExactMatchSet, incrementDeletedCount, init, init, initDataDictionary, isBasedOn, isDeltaStorage, isDMDeploySet, isDMSkipFieldValidation, isEAuditFieldModified, isEmpty, isESigFieldModified, isESigNeeded, isFlagSet, isIgnoreQbeExactMatchSet, isLookup, isNull, isQbeCaseSensitive, isQbeExactMatch, isRetainMboPosition, isTableDomainLookup, latestDate, locateMbo, logESigVerification, logRowUpdatedException, max, min, moveFirst, movePrev, moveToKey, newMboIndex, notExist, positionState, processML, remove, remove, remove, resetForRefreshOnSave, resetWithSelection, rollback, rollbackToCheckpoint, rollbackToCheckpoint, rollbackTransaction, save, save, save, save, saveMbos, saveTransaction, select, select, select, selectAll, setAllowQualifiedRestriction, setApp, setAppAlwaysFieldFlag, setAutoKeyFlag, setDBFetchMaxRows, setDefaultOrderBy, setDefaultValue, setDefaultValue, setDefaultValues, setDefaultValues, setDMDeploySet, setDMSkipFieldValidation, setEAuditFieldModified, setERMEntity, setESigFieldModified, setExcludeMeFromPropagation, setFederatedResources, setFlag, setFlag, setFlags, setInsertCompanySet, setInsertItemSet, setInsertOrg, setInsertSite, setLastESigTransId, setLogLargFetchResultDisabled, setMXTransaction, setNoNeedtoFetchFromDB, setOrderBy, setOrderByNVL, setOwner, setPreserveOrderByCase, setProxy, setQbe, setQbe, setQbe, setQbe, setQbeCaseSensitive, setQbeCaseSensitive, setQbeExactMatch, setQbeExactMatch, setQbeOperatorOr, setQueryBySiteQbe, setQueryTimeout, setRelationName, setRequiedFlagsFromERM, setRetainMboPosition, setSetOrderByForUI, setSkipFirstNRows, setSQLOptions, setTableDomainLookup, setTxnPropertyMap, setupLongOpPipe, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, setWhereQbe, smartFill, smartFill, smartFind, smartFind, smartFind, smartFind, sort, splitOrderBy, startCheckpoint, startCheckpoint, sum, undeleteAll, undoTransaction, unselect, unselect, unselect, unselectAll, useStoredQuery, validate, validateTransaction, verifyESig

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.mbo.MboSetRemote

abortSql, add, add, addAtEnd, addAtEnd, addAtIndex, addAtIndex, addFakeAtEnd, addSubQbe, addSubQbe, addSubQbe, addSubQbe, addWarning, addWarnings, checkMethodAccess, cleanup, clear, clearLongOpPipe, close, commit, copy, copy, copyForDM, count, deleteAll, deleteAll, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemoveAll, deleteAndRemoveAll, determineRequiredFieldsFromERM, earliestDate, fetchNext, findAllNullRequiredFields, findByIntegrationKey, findKey, getApp, getAppAlwaysFieldFlags, getAppWhere, getCompleteWhere, getCurrentPosition, getDBFetchMaxRows, getDefaultValue, getERMEntity, getESigTransactionId, getExcludeMeFromPropagation, getFlags, getKeyAttributes, getList, getList, getMaxMessage, getMbo, getMboForUniqueId, getMboSetData, getMboSetData, getMboSetInfo, getMboSetRetainMboPositionData, getMboSetRetainMboPositionInfo, getMboSetValueData, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMLFromClause, getMXTransaction, getName, getOrderBy, getOwner, getParentApp, getProfile, getQbe, getQbe, getQbe, getQbeWhere, getQueryTimeout, getRelationName, getRelationship, getSelection, getSelectionWhere, getSetOrderByForUI, getSize, getSQLOptions, getTxnPropertyMap, getUserAndQbeWhere, getUserInfo, getUserName, getUserWhere, getWarnings, getWhere, getZombie, hasMLQbe, hasQbe, hasWarnings, ignoreQbeExactMatchSet, incrementDeletedCount, init, isBasedOn, isDMDeploySet, isDMSkipFieldValidation, isEmpty, isESigNeeded, isFlagSet, isQbeCaseSensitive, isQbeExactMatch, isRetainMboPosition, latestDate, locateMbo, logESigVerification, max, min, moveFirst, movePrev, newMboIndex, notExist, positionState, processML, remove, remove, remove, resetWithSelection, rollback, rollbackToCheckpoint, rollbackToCheckpoint, save, save, select, select, select, selectAll, setAllowQualifiedRestriction, setApp, setAppAlwaysFieldFlag, setAutoKeyFlag, setDBFetchMaxRows, setDefaultOrderBy, setDefaultValue, setDefaultValue, setDefaultValues, setDMDeploySet, setDMSkipFieldValidation, setERMEntity, setESigFieldModified, setExcludeMeFromPropagation, setFlag, setFlag, setFlags, setInsertCompanySet, setInsertItemSet, setInsertOrg, setInsertSite, setLastESigTransId, setLogLargFetchResultDisabled, setMXTransaction, setNoNeedtoFetchFromDB, setOrderBy, setOwner, setQbe, setQbe, setQbe, setQbe, setQbeCaseSensitive, setQbeCaseSensitive, setQbeExactMatch, setQbeExactMatch, setQbeOperatorOr, setQueryBySiteQbe, setQueryTimeout, setRelationName, setRequiedFlagsFromERM, setRetainMboPosition, setSetOrderByForUI, setSQLOptions, setTableDomainLookup, setTxnPropertyMap, setupLongOpPipe, setWhereQbe, smartFill, smartFill, smartFind, smartFind, startCheckpoint, startCheckpoint, sum, undeleteAll, unselect, unselect, unselect, unselectAll, useStoredQuery, validate, verifyESig

Methods inherited from interface psdi.mbo.MboAccessInterface

getBoolean, getByte, getBytes, getDate, getDouble, getFloat, getInt, getLong, getString, isNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull

Methods inherited from interface psdi.txn.Transactable

commitTransaction, fireEventsAfterDB, fireEventsAfterDBCommit, fireEventsBeforeDB, rollbackTransaction, saveTransaction, undoTransaction, validateTransaction

Constructor Detail

RESTMboSet

public RESTMboSet(MboServerInterface ms)
           throws java.rmi.RemoteException

Constructor

Parameters:

ms - The REST MboSet.

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

Method Detail

execute

public void execute()
             throws MXException,
                    java.rmi.RemoteException

Method o be called in non-persistent object on save

Specified by:

execute in interface NonPersistentMboSetRemote

Overrides:

execute in class NonPersistentMboSet

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

See Also:

To check that all required fields are have a value before continuing execution, call this method. Generally implementations of this method will call validate() as there first action.

load

public void load(int index)
          throws MXException,
                 java.rmi.RemoteException

Implementation of load of the external data to MboSet using REST

Overrides:

load in class JSONMboSet

Parameters:

index - index of the Mbo in MboSet

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

invoke

public byte[] invoke(int index,
                     boolean forCount)
              throws MXException,
                     java.rmi.RemoteException

Implementation of invoke of the external data to MboSet for REST call

Overrides:

invoke in class JSONMboSet

Parameters:

index - index of the Mbo in MboSet

forCount - is invoke for count only or data

Returns:

response in byte array

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

setQbe

public void setQbe(java.lang.String attribute,
                   java.lang.String expression)
            throws MXException,
                   java.rmi.RemoteException

Sets QBE.

Specified by:

setQbe in interface MboSetRemote

Overrides:

setQbe in class MboSet

Parameters:

attribute - attribute to set to

expression - expression to set

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

See Also:

MboSet.resetQbe(), MboSet.setQbe(String[], String), MboSet.reset(), MboSet.getMbo()

getOpAndValue

public java.lang.Object[] getOpAndValue(java.lang.String expression)

Parse expression to get operation and value

Parameters:

expression - expression to parse

Returns:

object array. First element operation and second value

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

resetQbe

public void resetQbe()

Reset the QBE for this object, i.e. the Qbe is cleared.

Specified by:

resetQbe in interface MboSetRemote

Overrides:

resetQbe in class MboSet

See Also:

setQbe(String, String)

getHTTPQueryMethod

public java.lang.String getHTTPQueryMethod()

Get HTTP method.

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

formatUrl

public java.lang.String formatUrl(java.lang.String url,
                                  java.lang.String method)
                           throws java.rmi.RemoteException,
                                  MXException

Formats where clause.

Parameters:

url - invoke url

method - HTTP invoke method

Returns:

new formatted URL

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

formatUrlForSortPage

public java.lang.String formatUrlForSortPage(java.lang.String url,
                                             int index,
                                             boolean forCount,
                                             java.lang.String method)
                                      throws java.rmi.RemoteException,
                                             MXException

Add sort and paging to existing URL.

Parameters:

url - invoke url

index - index of the Mbo in MboSet

forCount - formatted for count only or get whole data

method - HTTP invoke method

Returns:

new formatted URL

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

formatPostData

public byte[] formatPostData(int index,
                             boolean forCount)
                      throws java.rmi.RemoteException,
                             MXException

Default implementation for formats where clause for POST.

Parameters:

index - Index of the row from getMbo(index)

forCount - indicates if only count need to be retrieved

Returns:

byte data for POST

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

formatPostDataForNextPage

public byte[] formatPostDataForNextPage(byte[] data,
                                        int index)
                                 throws java.rmi.RemoteException,
                                        MXException

Default implementation for formats data for next page

Parameters:

data - original POST data

index - Index of the row from getMbo(index)

Returns:

byte data for next page retrieval

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getWhereSeparator

public java.lang.String getWhereSeparator()
                                   throws MXException

Formats where separator.

Returns:

encoded where separator

Throws:

MXException - Maximo Exception

formatWhere

public void formatWhere(java.util.List<java.lang.String> whereList,
                        java.lang.String where)
                 throws java.rmi.RemoteException,
                        MXException

Formats where clause.

Parameters:

whereList - list of where clauses

where - where clause to add to the list

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

formatUrlForNextPage

public java.lang.String formatUrlForNextPage(java.lang.String url,
                                             int index,
                                             java.lang.String method)
                                      throws java.rmi.RemoteException,
                                             MXException

Formats where clause.

Parameters:

url - url to add paging

index - index of the Mbo in MboSet

method - HTTP invoke method

Returns:

formatted URL

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getOrderByClouse

public java.lang.String getOrderByClouse()

Return order by clause.

Returns:

order by clause

Throws:

MXException

java.rmi.RemoteException

getCountClause

public java.lang.String getCountClause()

Return count clause.

Returns:

count clause

getPagingParams

public java.lang.String[] getPagingParams()

Return parameters for paging. First parameter is page size (limit) second is when to start (or skip)

Returns:

paging parameters array

Throws:

MXException

java.rmi.RemoteException

getStringQualifier

public java.lang.String getStringQualifier()

Return string qualifies. If null - no qualifier. So value can be abc or 'abc'

Returns:

count clause

getUrl

public java.lang.String getUrl(HTTPHandler handler,
                               boolean forCount)
                        throws MXException,
                               java.rmi.RemoteException

Return original URL.

Parameters:

handler - handler name

forCount - count indicator

Returns:

URL

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getWhereToFormat

public java.lang.String getWhereToFormat(java.lang.String where)
                                  throws java.rmi.RemoteException,
                                         MXException

Return formatted where clause.

Parameters:

where - where clause

Returns:

formated where

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getWhereToFormat

public java.lang.String getWhereToFormat(java.lang.String where,
                                         boolean isRelationship)
                                  throws java.rmi.RemoteException,
                                         MXException

Return formatted where clause.

Parameters:

where - where clause

isRelationship - is it relationship where or any other where

Returns:

formated where

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

moveTo

public MboRemote moveTo(int pos)
                 throws MXException,
                        java.rmi.RemoteException

Override this method so that the current index of the mboset doesn't change during loading through moveNext() call. This is because loading (calls getMbo(i)) and moveNext() increment the currIndex so causes currIndex to be incorrect.

Specified by:

moveTo in interface MboSetRemote

Overrides:

moveTo in class MboSet

Throws:

MXException

java.rmi.RemoteException

See Also:

MboSet.getMbo(int)

moveNext

public MboRemote moveNext()
                   throws MXException,
                          java.rmi.RemoteException

Override this method so that the current index of the mboset doesn't change during loading through moveNext() call. This is because loading (calls getMbo(i)) and moveNext() increment the currIndex so causes currIndex to be incorrect.

Specified by:

moveNext in interface MboSetRemote

Overrides:

moveNext in class MboSet

Returns:

The next MboRemote in this set.

Throws:

MXException

java.rmi.RemoteException

See Also:

MboSet.getMbo(int)