com.ibm.tivoli.maximo.fdmbo

Class CloudantMboSet

java.lang.Object

psdi.mbo.MboSet

psdi.mbo.NonPersistentMboSet

com.ibm.tivoli.maximo.fdmbo.JSONMboSet

com.ibm.tivoli.maximo.fdmbo.RESTMboSet

com.ibm.tivoli.maximo.fdmbo.CloudantMboSet

All Implemented Interfaces:

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

public class CloudantMboSet
extends RESTMboSet

Cloudant object set definition.

Field Summary

Fields inherited from class com.ibm.tivoli.maximo.fdmbo.RESTMboSet

qbe

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

currentCount, fetchComplete, fullCount, jsonAnalyzer, limit, productName, resourceName, resourceType, responseArray, url, urlFormatted

Fields inherited from class psdi.mbo.MboSet

dmDeploySet, dmDeploySkipFieldValidation, fetchStopLimitEnabled, LOOKUPMAXROW, maxSorterSize, mboCountCleanuplist, mboVec, mrdVec, perfStats, strNoBaseLangValueEntered, toBeSaved

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
CloudantMboSet(MboServerInterface ms) Constructor

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	addOrderBy(java.lang.String url, java.lang.String orderBy) Adds Order By to URL.
JSONQuery	addPaging(JSONQuery formater, int index, boolean forCount) Add paging parameters if paging is enabled.
void	bulkUpdate() Performs bulk update back to Cloudant.
JSONQuery	format(JSONQuery formater, JSONResourceInfo resourceInfo, java.lang.String where, boolean forCount, int index) Formats full where clause.
byte[]	formatPostData(int index, boolean forCount) Formats where clause for POST.
byte[]	formatPostDataForNextPage(byte[] data, int index) Formats data for next page.
JSONQuery	formatQBE(JSONQuery formater, JSONResourceInfo resourceInfo, boolean forCount, int index) Formats QBE.
java.lang.String	getHTTPQueryMethod() Return HTTP method for the call.
protected Mbo	getMboInstance(MboSet ms) Generate a new Clodant object.
java.lang.String	getQualifiedWhere() Get the row level security's QUALIFIED where clause that would append to the complete where clause.
java.lang.String	getStringQualifier() Return string qualifies.
java.lang.String	getURI() Returns URL.
java.lang.String	getUrl(HTTPHandler handler, boolean forCount) Returns URL.
void	setAdditionalData(MboRemote mbo, com.ibm.json.java.JSONObject jo) It will set id and revision.
protected void	setAttributeValue(java.lang.String attributeName, java.lang.Object value, MboRemote mbo) Set the attribute value to a serialized mbo from JSON.

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

execute, formatOrderBy, formatUrl, formatUrlForNextPage, formatUrlForSortPage, formatWhere, getCountClause, getMimeType, getOpAndValue, getOrderByClouse, getPagingParams, getWhereSeparator, getWhereToFormat, getWhereToFormat, invoke, load, moveNext, moveTo, processPaging, resetQbe, setDiscardableFlag, setQbe

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

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

Methods inherited from class psdi.mbo.NonPersistentMboSet

execute, isClosed, setMboSetInfo

Methods inherited from class psdi.mbo.MboSet

abortSql, add, add, addAliasForML, addAliasForML, addAtEnd, addAtEnd, addAtIndex, addAtIndex, addFakeAtEnd, addFederatedMboToSorter, addJoinedAttribute, addMbo, addMbo, addSubQbe, addSubQbe, addSubQbe, addSubQbe, addToEndOfSelectStatement, addWarning, addWarnings, appendToWhere, applyAppSpecificAuthorization, 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, countAndCleanup, countAndCleanup, deleteAll, deleteAll, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemoveAll, deleteAndRemoveAll, determineRequiredFieldsFromERM, dump, earliestDate, enableMethod, executeBatch, fetchNext, findAllNullRequiredFields, findByIntegrationKey, findKey, fireEventsAfterDB, fireEventsAfterDBCommit, fireEventsBeforeDB, forceDBSort, getAllAppAlwaysFieldFlags, getAllowQualifiedRestriction, getAlwaysFlags, getAlwaysFlags, getApp, getAppAlwaysFieldFlags, getAppWhere, getAttrRestrictions, getBoolean, getByte, getBytes, getClientLocale, getClientTimeZone, getCompleteWhere, getCurrentPosition, getDate, getDBFetchMaxRows, getDefaultValue, getDefaultValueHash, getDouble, getERMEntity, getESigTransactionId, getExcludeMeFromPropagation, getFlags, getFloat, getFromClause, getIgnoredAutokeyAttrs, getInsertCompanySet, getInsertItemSet, getInsertOrg, getInsertSite, getInt, getJspDefaultValueHash, getKeyAttributes, getList, getList, getLong, getMaxAppsWhere, getMaxMessage, getMbo, getMboCtx, 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, getQueryTimeout, getRelationName, getRelationship, getRetainRecordLimit, getRowRestrictions, getSecurityLogger, getSelectClause, getSelectClause, getSelection, getSelectionWhere, getSelectWhereClause, getSetOrderByForUI, getSharedMboSet, getSize, getSkipFirstNRows, getSqlLogger, getSQLOptions, getString, getTranslator, getTxnPropertyMap, getUserAndQbeWhere, getUserInfo, getUserName, getUserPrefWhere, getUserWhere, getUserWhere, getWarnings, getWhere, getZombie, handleMLMbo, handleMLMbo, hasMLQbe, hasQbe, hasWarnings, ignoreAutokeyAttr, ignoreAutokeyAttr, ignoreQbeExactMatchSet, includeRelatedMbosOfOwnersChildren, incrementDeletedCount, init, init, initDataDictionary, insertDeltaRow, isBasedOn, isDeltaStorage, isDMDeploySet, isDMSkipFieldValidation, isDownloadSet, isEAuditFieldModified, isEAuditNeeded, isEmpty, isESigFieldModified, isESigNeeded, isESigNeeded, isFlagSet, isIgnoreQbeExactMatchSet, isInMemorySort, isJoinedAttribute, isLookup, isNull, isQbeCaseSensitive, isQbeExactMatch, isRetainMboPosition, isRetainRecordEnabled, isTableDomainLookup, latestDate, locateMbo, logESigVerification, logRowUpdatedException, max, min, moveFirst, movePrev, moveToKey, newMboIndex, notExist, positionState, processML, remove, remove, remove, removeAllJoinedAttributes, removeCtx, removeJoinedAttribute, resetForRefreshOnSave, resetWithSelection, rollback, rollbackToCheckpoint, rollbackToCheckpoint, rollbackTransaction, save, save, save, save, saveMbos, saveTransaction, select, select, select, selectAll, setAllowQualifiedRestriction, setApp, setAppAlwaysFieldFlag, setAutoKeyFlag, setBindValueAsBytes, setDBFetchMaxRows, setDefaultOrderBy, setDefaultValue, setDefaultValue, setDefaultValues, setDefaultValues, setDMDeploySet, setDMSkipFieldValidation, setDownloadSet, setEAuditFieldModified, setERMEntity, setESigFieldModified, setExcludeMeFromPropagation, setFederatedResources, setFlag, setFlag, setFlags, setInsertCompanySet, setInsertItemSet, setInsertOrg, setInsertSite, setLastESigTransId, setLogLargFetchResultDisabled, setMboCtx, setMXTransaction, setNoNeedtoFetchFromDB, setNoSaveFlag, setOrderBy, setOrderByNVL, setOverrideSelectClause, setOverrideSelectFromClause, setOverrideSelectWhereClause, 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, updateMboSetRetainMboPositionData, updateRelatedMboSetRetainMboPositionData, useStoredQuery, validate, validateTransaction, verifyESig

Methods inherited from class java.lang.Object

clone, equals, finalize, 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, isDownloadSet, 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, setDownloadSet, 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

CloudantMboSet

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

Constructor

Parameters:

ms - The Cloudant MboSet.

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

Method Detail

getURI

public java.lang.String getURI()

Returns URL.

Returns:

URL

getMboInstance

protected Mbo getMboInstance(MboSet ms)
                      throws MXException,
                             java.rmi.RemoteException

Generate a new Clodant object.

Overrides:

getMboInstance in class RESTMboSet

Parameters:

ms -

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

addOrderBy

protected java.lang.String addOrderBy(java.lang.String url,
                                      java.lang.String orderBy)

Adds Order By to URL. THis method does not have to be implemented for Cloudant

Overrides:

addOrderBy in class RESTMboSet

Parameters:

url - REST URL

orderBy - order by clause

Returns:

formated URL

Throws:

MXException - Maximo Exception

getHTTPQueryMethod

public java.lang.String getHTTPQueryMethod()

Return HTTP method for the call.

Overrides:

getHTTPQueryMethod in class RESTMboSet

Returns:

POST for the Cludant

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

formatPostData

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

Formats where clause for POST.

Overrides:

formatPostData in class RESTMboSet

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

Formats data for next page. Used if paging is enabled

Overrides:

formatPostDataForNextPage in class RESTMboSet

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

format

public JSONQuery format(JSONQuery formater,
                        JSONResourceInfo resourceInfo,
                        java.lang.String where,
                        boolean forCount,
                        int index)
                 throws java.rmi.RemoteException,
                        MXException

Formats full where clause.

Parameters:

formater - JSONQuery

resourceInfo - resource info

where - where clause

index - Index of the row from getMbo(index)

forCount - indicates if only count need to be retrieved

Returns:

JSONQuery with data for POST

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

addPaging

public JSONQuery addPaging(JSONQuery formater,
                           int index,
                           boolean forCount)
                    throws java.rmi.RemoteException,
                           MXException

Add paging parameters if paging is enabled.

Parameters:

formater - JSONQuery

index - Index of the row from getMbo(index)

forCount - indicates if only count need to be retrieved

Returns:

JSONQuery

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

formatQBE

public JSONQuery formatQBE(JSONQuery formater,
                           JSONResourceInfo resourceInfo,
                           boolean forCount,
                           int index)
                    throws java.rmi.RemoteException,
                           MXException

Formats QBE.

Parameters:

formater - JSONQuery

resourceInfo - resource info

index - Index of the row from getMbo(index)

forCount - indicates if only count need to be retrieved

Returns:

JSONQuery

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

bulkUpdate

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

Performs bulk update back to Cloudant.

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

setAdditionalData

public void setAdditionalData(MboRemote mbo,
                              com.ibm.json.java.JSONObject jo)
                       throws MXException,
                              java.rmi.RemoteException

It will set id and revision.

Overrides:

setAdditionalData in class JSONMboSet

Parameters:

mbo - Maximo object

jo - JSON Object to get data

mbo - processing object

jo - JSON object

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

setAttributeValue

protected void setAttributeValue(java.lang.String attributeName,
                                 java.lang.Object value,
                                 MboRemote mbo)
                          throws java.rmi.RemoteException,
                                 MXException

Set the attribute value to a serialized mbo from JSON.

Parameters:

attributeName - The attribute name.

value - The value to be set.

mbo - The serialized mbo.

Throws:

java.rmi.RemoteException

MXException

getQualifiedWhere

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

Get the row level security's QUALIFIED where clause that would append to the complete where clause. This only applies to top level and lookup mbos.

Overrides:

getQualifiedWhere in class MboSet

Returns:

qualified where

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

See Also:

MboSet.isLookup(), MboSet.getAllowQualifiedRestriction(), MboSet.getRowRestrictions(int)

getUrl

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

Returns URL.

Overrides:

getUrl in class RESTMboSet

Parameters:

handler - Handler name

forCount - indicates if only count need to be retrieved

Returns:

URL

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

getStringQualifier

public java.lang.String getStringQualifier()

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

Overrides:

getStringQualifier in class RESTMboSet

Returns:

count clause