public class S_LibrarySession extends Object implements LibrarySessionInterface, S_LibrarySessionInterface, IfsEventHandler, Traceable, LibraryConstants, LogInfo
For every S_LibrarySession there is a corresponding LibrarySession.
LibrarySession, in the package oracle.ifs.beans
, forms part
of the CM SDK application development API, informally known as the
"beans API". Applications invoke CM SDK functionality by calling the beans
API. S_LibrarySession, however, is in the oracle.ifs.server
package, and forms part of the CM SDK server extensibility API, also
known as the "server API". The server API is used to override or extend
out-of-the-box CM SDK behavior by injecting your code into certain methods
that are automatically invoked by the CM SDK repository. Applications do
not typically call the server API directly.
S_LibrarySession provides helpful methods as you use the server API to
change the behavior of S_LibraryObject subclasses. To get a reference
to the S_LibrarySession, call getSession
on S_LibraryObject.
You can change the behavior of S_LibrarySession via the Tie class, S_TieLibrarySession.
Modifier and Type | Field and Description |
---|---|
protected boolean |
m_AccessCheckMode
Indication if access checks for other than Discover permssion
should be performed.
|
protected Stack |
m_AccessCheckModeStack
A stack of temporary access check modes, stored as Boolean objects.
|
protected Long[] |
m_AllAncestorIds
The IDs of all ancestor groups of the currently connected user.
|
protected boolean |
m_AlwaysCacheSelectedData
Indication as to whether the current session always caches
selected data from Selectors.
|
protected String |
m_ApplicationName
The name of the application that created this session.
|
protected Hashtable |
m_AuxiliaryConnections
The auxiliary LibraryConnections acquired by this
S_LibrarySession, hashed by Connection.
|
protected boolean |
m_Cancelled
Has the session been interrupted due to an explicit cancel?
|
protected long |
m_ClientVersionNumber
The version of LibrarySession as a long.
|
protected String |
m_ClientVersionString
The version of LibrarySession as a string.
|
protected Long |
m_ComponentAclsAttributeId
The ID of the AccessControlList.ComponentAcls attribute
|
protected Hashtable |
m_Cursors
The S_LibraryObjectCursors created by this S_LibrarySession,
hashed by cursor sequence.
|
protected long |
m_CursorSequence
The last used cursor sequence.
|
protected S_ContentQuota |
m_DefaultContentQuota
the default ContentQuota object that will be used for any
new Documents
|
protected Long |
m_DirectoryObjectClassId
The id of the DIRECTORYOBJECT classobject.
|
protected S_PropertyBundle |
m_DomainPropertyBundle
The domain PropertyBundle.
|
protected boolean |
m_EventProcessingEnabled
Whether event processing is enabled for this S_LibrarySession.
|
protected oracle.ifs.server.S_LibrarySession.Fifo |
m_EventsQueuedForProcessing
A queue of events awaiting processing by this S_LibrarySession.
|
protected int |
m_ExecutionMode
The current execution mode of the session.
|
protected S_DirectoryUser |
m_FeignedUser
The current S_DirectoryUser.
|
protected Long |
m_FeignedUserId
The ID of the current S_DirectoryUser.
|
protected String |
m_FeignedUserName
The name of the current S_DirectoryUser.
|
protected String |
m_FolderPathDelimiter
The delimiter for elements in folder paths (e.g. "/").
|
protected Long |
m_Id
The id of this S_LibrarySession.
|
protected boolean |
m_Interrupted
Has the session been interrupted?
|
protected Boolean |
m_IsContextEnabled
Remember if context is installed in this schema.
|
protected long |
m_LastOperationTime
The time at which the most-recent DMFoo operation was performed.
|
protected LibrarySession |
m_LibrarySession
The LibrarySession for this S_LibrarySession.
|
protected Localizer |
m_Localizer
The Localizer for this S_LibrarySession.
|
protected Hashtable |
m_LockedForSessionObjects
The self-hashed ids of the objects for which this S_LibrarySession
has acquired a session lock.
|
protected OperationDriver |
m_OperationDriver
The class which drives policy-driven operations.
|
protected boolean |
m_PolicyMode
Is the session in "Policy Mode", indicating that non-settable
attributes added to definitions will be honored?
|
protected boolean |
m_PreventSessionTimeouts
Indication as to whether session timeouts are suppressed
|
protected S_PrimaryUserProfile |
m_PrimaryUserProfile
The S_PrimaryUserProfile of m_FeignedUser.
|
protected Long |
m_PublicObjectClassId
The id of the PUBLICOBJECT classobject.
|
protected Hashtable |
m_RegisteredClassEventHandlers
Registered class event handlers (see registerClassEventHandler()).
|
protected Hashtable |
m_RegisteredEventHandlers
Registered event handlers (see registerEventHandler()).
|
protected S_Folder |
m_RootFolder
The root folder.
|
protected Long |
m_SchemaObjectClassId
The id of the SCHEMAOBJECT classobject.
|
protected Hashtable |
m_SearchCursors
The S_Search objects created by this S_LibrarySession, hashed
by cursor sequence.
|
protected HashMap |
m_SelectorMap
The S_LibraryObjectSelectors for every S_ClassObject, hashed
by class id.
|
protected S_LibraryService |
m_Service
The S_LibraryService hosting this S_LibrarySession.
|
protected oracle.ifs.server.S_LibraryServiceEventExchanger |
m_ServiceEventExchanger
The S_LibraryServiceEventExchanger of the S_LibraryService
hosting this S_LibrarySession.
|
protected long |
m_SessionCreationTime
The time at which this session was created.
|
protected Stack |
m_SessionStateStack
A stack of S_SessionStates.
|
protected S_LibraryObjectDataSharedStateFactory |
m_SharedStateFactory
The Shared state factory
|
protected Long |
m_SimpleObjectClassId
The id of the SIMPLEOBJECT classobject.
|
protected Hashtable |
m_SSelectors
The S_Selectors created by this S_LibrarySession, hashed by
selector sequence.
|
protected long |
m_SSelectorSequence
The last used selector sequence.
|
protected Statement |
m_StatementInProgress
The current JDBC statement being executed on beahlf on this session
|
protected boolean |
m_StatementInProgressCancelled
Has the current JDBC statement being executed on beahlf on this session
been cancelled?
|
protected Long |
m_SystemObjectClassId
The id of the SYSTEMOBJECT classobject.
|
protected int |
m_TemporaryExecutionMode
The temporarily expanded execution mode.
|
protected HashMap |
m_TemporyDiscoveredAcls
The table used to track discoverability when m_TemporyDiscoveredAclsEnabled is
true.
|
protected boolean |
m_TemporyDiscoveredAclsEnabled
Indication if ACL discoverability should be cached in
a temporary HashMap.
|
protected oracle.ifs.server.S_LibrarySessionTransactionManager |
m_TransactionManager
The S_LibrarySessionTransactionManager for this S_LibrarySession.
|
protected UncommittedLibraryObjectDataCache |
m_UncommittedLibraryObjectDataCache
The uncommitted S_LibraryObjectData cache for this S_LibrarySession.
|
protected UncommittedResolvedAclCache |
m_UncommittedResolvedAclCache
The uncommitted Resolved ACL cache for this S_LibrarySession.
|
protected S_DirectoryUser |
m_User
The S_DirectoryUser that was authenticated to create this
S_LibrarySession.
|
protected String |
m_UserName
The name of the S_DirectoryUser that was authenticated to
create this S_LibrarySession.
|
protected S_UserState |
m_UserState
The S_UserState (for example, read indication) for m_FeignedUser.
|
ALWAYS_CACHE_SELECTED_DATA_PROPERTY, CLEAR_SHARED_CACHES, DEFAULT_CONTENTQUOTA_PROPERTY, EXECUTIONMODE_ADMINISTRATION, EXECUTIONMODE_DISCOVERYADMINISTRATION, EXECUTIONMODE_INSTALLADMINISTRATION, EXECUTIONMODE_PREEXISTING, EXECUTIONMODE_SYSTEMADMINISTRATION, EXECUTIONMODE_USER, FOLDER_PATH_DELIMITER_PROPERTY, PREVENT_SESSION_TIMEOUTS_PROPERTY, UPGRADE_BEHAVIOR_PROPERTY
ARRAYVALUES_TABLENAME_PREFIX, AUDIT_EVENT_COLUMN_APPLICATIONCONTEXT, AUDIT_EVENT_COLUMN_APPLICATIONUSER, AUDIT_EVENT_COLUMN_AUXILIARYNUMBER, AUDIT_EVENT_COLUMN_AUXILIARYSTRING, AUDIT_EVENT_COLUMN_CREATEDATE, AUDIT_EVENT_COLUMN_CREATORID, AUDIT_EVENT_COLUMN_DOMAINID, AUDIT_EVENT_COLUMN_ID, AUDIT_EVENT_COLUMN_OPERATIONSUCCEEDED, AUDIT_EVENT_COLUMN_OPERATIONTYPE, AUDIT_EVENT_COLUMN_TARGETOBJECTID, AUDIT_SPECIFICATION_CUSTOM, AUDIT_SPECIFICATION_GLOBAL, AUDIT_SPECIFICATION_OBJECT, AUDIT_SUCCESS_MODE_FAILURE_ONLY, AUDIT_SUCCESS_MODE_NONE, AUDIT_SUCCESS_MODE_SUCCESS_ONLY, AUDIT_SUCCESS_MODE_SUCCESS_OR_FAILURE, AUDIT_TABLENAME_PREFIX, CAPABILITY_ADDITEM, CAPABILITY_ADDMEMBER, CAPABILITY_ADDRELATIONSHIP, CAPABILITY_ADDVERSION, CAPABILITY_ADDVERSIONSERIES, CAPABILITY_ADMINISTER_CATEGORY, CAPABILITY_ADMINISTER_CONFIGURATION, CAPABILITY_ADMINISTER_CONTAINER, CAPABILITY_ADMINISTER_DOMAIN, CAPABILITY_ADMINISTER_LOCK, CAPABILITY_ADMINISTER_QUOTA, CAPABILITY_ADMINISTER_RECORD, CAPABILITY_ADMINISTER_ROLE, CAPABILITY_ADMINISTER_SECURITY, CAPABILITY_ADMINISTER_USER, CAPABILITY_ADMINISTER_WORKSPACE, CAPABILITY_COPY, CAPABILITY_CREATECONTAINER, CAPABILITY_CREATEFOLDER, CAPABILITY_CREATEWORKSPACE, CAPABILITY_DELETE, CAPABILITY_DISCOVER, CAPABILITY_GET_CONTENT, CAPABILITY_GETAUDITHISTORY, CAPABILITY_GETMETADATA, CAPABILITY_GETRELATION, CAPABILITY_LOCK, CAPABILITY_MOVE, CAPABILITY_REMOVEITEM, CAPABILITY_REMOVEMEMBER, CAPABILITY_REMOVERELATIONSHIP, CAPABILITY_REMOVEVERSIONSERIES, CAPABILITY_SET_ATTR, CAPABILITY_SET_CONTENT, CAPABILITY_SETMETADATA, CAPABILITY_SETRELATION, DEFINITIONSETTINGPOLICY_STANDARD, EXCEPTION_INFO_AGGREGATE_ENTRIES, EXCEPTION_INFO_CONFLICTING_OBJECT_ID, EXCEPTION_INFO_DESCRIPTION_MAP, EXCEPTION_INFO_LIMIT, EXCEPTION_INFO_OBJECT_ID, EXCEPTION_INFO_PARAMETER_NAME, FLAG_ACTIVITYRECORD_EXISTS, FLAG_ACTOR_EXISTS, FLAG_ATTACHMENTRELATION_EXISTS, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MESSAGELIST_EXISTS, IFS_ATTRIBUTEPROPERTY_COMMONNAME, IFS_ATTRIBUTEPROPERTY_DEFINITIONSETTINGPOLICY, IFS_ATTRIBUTEPROPERTY_MULTIVALUETABLESUFFIX, IFS_ATTRIBUTEPROPERTY_STANDARDSIMPLEPROPERTYARRAY, IFS_CLASSPROPERTY_CATEGORY_ALLOWMULTIPLEINSTANCES, IFS_CLASSPROPERTY_CATEGORY_FLAGBIT, IFS_CLASSPROPERTY_COMMONNAME, IFS_CLASSPROPERTY_CONTENTSEARCHVIEWNAME, IFS_CLASSPROPERTY_DEFINITIONCLASSNAME, IFS_CLASSPROPERTY_INSTALLEDCLASS, IFS_DOMAIN_ACCESSCONTROLLIST_BYPASSNAMEUNIQUENESSCHECK, IFS_DOMAIN_ACCESSCONTROLLIST_COMPOSITEACLSUPPORTED, IFS_DOMAIN_ACLINDEX_EVENTTARGET, IFS_DOMAIN_ACTIVITY_CURRENTACTIVITYEVENTHISTORY, IFS_DOMAIN_ACTIVITY_CURRENTPERFORMEDACTIVITYSPECIFICATION, IFS_DOMAIN_ACTIVITY_CURRENTTRACKEDACTIVITYSPECIFICATION, IFS_DOMAIN_ACTIVITY_DEFAULTACTIVITYSPECIFICATION, IFS_DOMAIN_ACTIVITY_DELETERECORDSUPONACTIVITYRECORDFREE, IFS_DOMAIN_APPLICATION_INITIALIZERCLASSNAME, IFS_DOMAIN_AUDIT_AUDITINGENABLED, IFS_DOMAIN_AUDITING_GLOBALAUDITEVENTEXPIRATIONPERIOD, IFS_DOMAIN_AUDITING_GLOBALAUDITTYPELIST, IFS_DOMAIN_AUDITRULEEVALUATORCLASS, IFS_DOMAIN_CONFIGURATIONCATEGORYDESCRIPTORMAPCLASSNAME, IFS_DOMAIN_CONTENTVAULTENTRY_ENCRYPTIONCIPHERCOUNT, IFS_DOMAIN_CONTROLLERSTATE_SINGLETON, IFS_DOMAIN_CREDENTIALMANAGER_ANONYMOUSUSER, IFS_DOMAIN_CREDENTIALMANAGER_ANONYMOUSUSERNAME, IFS_DOMAIN_CREDENTIALMANAGER_AUTOUSERPROVISIONINGENABLED, IFS_DOMAIN_CREDENTIALMANAGER_IDM, IFS_DOMAIN_CREDENTIALMANAGER_IDM_COUNT_LIMIT, IFS_DOMAIN_CREDENTIALMANAGER_IDM_EXTERNALLY_SUPPORTED_ATTRIBUTES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_DIRECTORY_VENDOR, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_GROUP_MEMBER_ATTRIBUTES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_GROUP_NAME_ATTRIBUTE, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_GROUP_OBJECT_CLASSES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_GROUP_SEARCHBASES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_HOST, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_PORT, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_SSL_ENABLED, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_USER_NAME_ATTRIBUTE, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_USER_OBJECT_CLASSES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_LDAP_USER_SEARCHBASES, IFS_DOMAIN_CREDENTIALMANAGER_IDM_PAGE_SIZE, IFS_DOMAIN_CREDENTIALMANAGER_IDM_SECURITY_PROVIDER_TYPE, IFS_DOMAIN_CREDENTIALMANAGER_IDM_TIME_LIMIT, IFS_DOMAIN_CREDENTIALMANAGER_IDM_XML_FILE_PATH, IFS_DOMAIN_CREDENTIALMANAGER_IDM_XML_REALM, IFS_DOMAIN_CREDENTIALMANAGER_IDMENABLED, IFS_DOMAIN_DEFAULT_TIMEZONE_STRING, IFS_DOMAIN_DEFAULTTEMPDIRECTORY, IFS_DOMAIN_DEFAULTWINDOWSTEMPDIRECTORY, IFS_DOMAIN_DEFINITIONCLONINGREQUIRED, IFS_DOMAIN_DIRECTORYGROUP_BYPASSNAMEUNIQUENESSCHECK, IFS_DOMAIN_DIRECTORYGROUP_GROUPMEMBERSHIPCACHEMEMBERUSESARRAYINPUTS, IFS_DOMAIN_DIRECTORYGROUP_MEMBERTHRESHOLD, IFS_DOMAIN_DIRECTORYOBJECT_ANCESTORTHRESHOLD, IFS_DOMAIN_DIRECTORYOBJECT_GROUPMEMBERSHIPCACHEANCESTORUSESARRAYINPUTS, IFS_DOMAIN_DOCUMENT_DEFINITIONOBJECTEXPIRATIONPERIOD, IFS_DOMAIN_DOCUMENT_OWNERHASREADSUPPORTED, IFS_DOMAIN_EXTRACTION_DEFAULTINFORMATIONEXTRACTIONSPECIFICATION, IFS_DOMAIN_FDKCONFIGURATIONCLASS, IFS_DOMAIN_FOLDERINDEX_EVENTTARGET, IFS_DOMAIN_LIBRARYOBJECT_AUDITSPECIFICATION_GLOBALAUDITHISTORY, IFS_DOMAIN_LIBRARYOBJECT_AUDITSPECIFICATION_OBJECTAUDITHISTORY, IFS_DOMAIN_LIBRARYOBJECT_CLASSACCESSCONTROLLIST_CLASSPRIVATE, IFS_DOMAIN_LIBRARYOBJECT_CLASSACCESSCONTROLLIST_CLASSPUBLIC, IFS_DOMAIN_LIBRARYOBJECT_CLASSACCESSCONTROLLIST_CLASSRESTRICTCREATION, IFS_DOMAIN_LIBRARYOBJECT_MEDIA_DEFAULTCONTENTMEDIA, IFS_DOMAIN_LIBRARYOBJECT_MEDIA_NONCONTENTMEDIA, IFS_DOMAIN_LIBRARYOBJECT_NODECONFIGURATION_DEFAULTNODECONFIGURATION, IFS_DOMAIN_LIBRARYOBJECT_SERVICECONFIGURATION_DEFAULTSERVICECONFIGURATION, IFS_DOMAIN_LIBRARYOBJECT_STORAGEGROUP_DEFAULTSTORAGEGROUP, IFS_DOMAIN_LIBRARYOBJECT_SYSTEMACCESSCONTROLLIST_PRIVATE, IFS_DOMAIN_LIBRARYOBJECT_SYSTEMACCESSCONTROLLIST_PUBLIC, IFS_DOMAIN_LIBRARYOBJECT_SYSTEMACCESSCONTROLLIST_PUBLISHED, IFS_DOMAIN_LIBRARYOBJECT_SYSTEMLOCKOBJECT_SYSTEMHARDLOCK, IFS_DOMAIN_LIBRARYOBJECT_SYSTEMLOCKOBJECT_SYSTEMSOFTLOCK, IFS_DOMAIN_LOCALIZER_DEFAULTEXTENDEDRESOURCEBUNDLENAMES, IFS_DOMAIN_LOCKOBJECT_ENABLED, IFS_DOMAIN_LOOKUP_CLUSTERING_PROPERTIES, IFS_DOMAIN_LOOKUP_CUSTOMLOCKTYPES, IFS_DOMAIN_LOOKUP_ORACLELOCKTYPES, IFS_DOMAIN_LOOKUP_SORTOBJECTCOLLECTION, IFS_DOMAIN_OIDCREDENTIALMANAGERAGENT_SUBSCRIBERS, IFS_DOMAIN_OPERATIONACTIONSPECIFICATION_GLOBALLIST, IFS_DOMAIN_OPERATIONACTIONSPECIFICATION_TEMPORARILYDEACTIVATED, IFS_DOMAIN_PROPERTYBUNDLE_NAME, IFS_DOMAIN_PROTOCOLS_DAV_COPYMOVETHROUGHFOLDERLINKENABLED, IFS_DOMAIN_PROTOCOLS_DAV_NULLRESOURCELOCKEXPIRATIONPERIOD, IFS_DOMAIN_PROTOCOLS_DAV_USERAGENTS, IFS_DOMAIN_RANDOMACCESSOR_EXPIRATIONPERIOD, IFS_DOMAIN_SEARCH_ATTEMPTCONTEXTSEARCHREWRITE, IFS_DOMAIN_SECURITY_SYNCHRONOUSSECURITYREFRESHENABLED, IFS_DOMAIN_SHAREDSTATEFACTORY, IFS_DOMAIN_UPGRADEINPROGRESS, IFS_DOMAIN_WORKFLOW_BPEL_CREATIONENABLED, IFS_DOMAIN_WORKFLOW_BPEL_WORKLISTURL, IFS_DOMAIN_WORKFLOW_ENABLED, IFS_DOMAIN_WORKFLOW_SCHEMANAME, IFS_DOMAIN_WS_CLEARTEXTAUTHENTICATIONREQUIRESHTTPS, IFS_HANDLER_PROPERTY_BASETIMEOFDAY, IFS_HANDLER_PROPERTY_NOTIFIEDONEVENT, IFS_HANDLER_PROPERTY_TIMEFORMAT, IFS_HANDLER_PROPERTY_TIMERPERIOD, IFS_NODE_DISABLEDINHERITEDPROPERTYNAMES, IFS_NODE_DISABLEDINHERITEDSERVERNAMES, IFS_NODE_ENABLEDINHERITEDPROPERTYNAMES, IFS_NODE_ENABLEDINHERITEDSERVERNAMES, IFS_ORACLELOCKTYPE_KEY_CHECKOUT, IFS_ORACLELOCKTYPE_KEY_DAV, IFS_ORACLELOCKTYPE_KEY_FINALIZED, IFS_ORACLELOCKTYPE_KEY_FREEZE, IFS_ORACLELOCKTYPE_KEY_HASRECORD, IFS_ORACLELOCKTYPE_KEY_LIFECYCLE, IFS_ORACLELOCKTYPE_KEY_MANUAL, IFS_ORACLELOCKTYPE_KEY_NAMEDFREEZE, IFS_ORACLELOCKTYPE_KEY_RECORD, IFS_ORACLELOCKTYPE_KEY_RETENTION, IFS_ORACLELOCKTYPE_KEY_WORKFLOW, IFS_SERVICE_ACLCACHE_EMERGENCYTRIGGER, IFS_SERVICE_ACLCACHE_NORMALTRIGGER, IFS_SERVICE_ACLCACHE_PURGETARGET, IFS_SERVICE_ACLCACHE_SIZE, IFS_SERVICE_ACLCACHE_URGENTTRIGGER, IFS_SERVICE_AUDITCERTIFICATECACHE_PURGETARGET, IFS_SERVICE_AUDITINGENABLED, IFS_SERVICE_AUDITSTRINGCACHE_PURGETARGET, IFS_SERVICE_AURORASERVICE, IFS_SERVICE_CASESENSITIVEAUTHENTICATION, IFS_SERVICE_CHECKFORORPHANSESSIONSPERIOD, IFS_SERVICE_CLONEDSESSIONRETRYPERIOD, IFS_SERVICE_CONNECTIONPOOL_READONLY_MAXIMUMSIZE, IFS_SERVICE_CONNECTIONPOOL_READONLY_MAXIMUMSIZETIMEOUT, IFS_SERVICE_CONNECTIONPOOL_READONLY_MINIMUMSIZE, IFS_SERVICE_CONNECTIONPOOL_READONLY_STATEMENTCACHESIZETRIGGER, IFS_SERVICE_CONNECTIONPOOL_READONLY_STATEMENTCACHETARGET, IFS_SERVICE_CONNECTIONPOOL_READONLY_STATEMENTRESETLIMIT, IFS_SERVICE_CONNECTIONPOOL_READONLY_TARGETSIZE, IFS_SERVICE_CONNECTIONPOOL_READONLY_TARGETSIZETIMEOUT, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_MAXIMUMSIZE, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_MAXIMUMSIZETIMEOUT, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_MINIMUMSIZE, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_STATEMENTCACHESIZETRIGGER, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_STATEMENTCACHETARGET, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_STATEMENTRESETLIMIT, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_TARGETSIZE, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_TARGETSIZETIMEOUT, IFS_SERVICE_CONTENTBUFFERSIZE, IFS_SERVICE_CREDENTIALMANAGER, IFS_SERVICE_CREDENTIALMANAGER_CREDENTIALNAMETOKENIZER, IFS_SERVICE_CREDENTIALMANAGER_NAMES, IFS_SERVICE_DATACACHE_EMERGENCYTRIGGER, IFS_SERVICE_DATACACHE_NORMALTRIGGER, IFS_SERVICE_DATACACHE_PURGETARGET, IFS_SERVICE_DATACACHE_SIZE, IFS_SERVICE_DATACACHE_URGENTTRIGGER, IFS_SERVICE_DEFAULTCHARACTERSET, IFS_SERVICE_DEFAULTLANGUAGE, IFS_SERVICE_EVENTEXCHANGER, IFS_SERVICE_EVENTSTATEMENTRESETLIMIT, IFS_SERVICE_GROUPMEMBERSHIPCACHEANCESTORTHRESHOLD, IFS_SERVICE_GROUPMEMBERSHIPCACHEANCESTORUSESARRAYINPUTS, IFS_SERVICE_GROUPMEMBERSHIPCACHEENABLED, IFS_SERVICE_GROUPMEMBERSHIPCACHEMEMBERTHRESHOLD, IFS_SERVICE_GROUPMEMBERSHIPCACHEMEMBERUSESARRAYINPUTS, IFS_SERVICE_JDBC_DEFAULTROWPREFETCH, IFS_SERVICE_JDBC_DRIVER, IFS_SERVICE_JDBC_DRIVERTYPE, IFS_SERVICE_JDBC_TRACINGENABLED, IFS_SERVICE_LOCKTIMEOUTPERIOD, IFS_SERVICE_MAXIMUMCLONEDSESSIONS, IFS_SERVICE_MAXIMUMCONCURRENTSESSIONS, IFS_SERVICE_MAXIMUMPOOLEDCONTENTBUFFERSPERSESSION, IFS_SERVICE_ORPHANSESSIONTIMEOUTPERIOD, IFS_SERVICE_POLLFOREVENTSFROMOTHERSERVICESPERIOD, IFS_SERVICE_QUOTACHECKFREQUENCYINBYTES, IFS_SERVICE_SERVICECONFIGURATIONNAME, IFS_SERVICE_SERVICEKEEPALIVEEVENTPERIOD, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_EMERGENCYTRIGGER, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_ISMANGEDBYSERVER, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_NORMALTRIGGER, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_PURGETARGET, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_SIZE, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_URGENTTRIGGER, IFS_SERVICE_SESSION_BEANSSESSION, IFS_SERVICE_SESSION_DATACACHE_EMERGENCYTRIGGER, IFS_SERVICE_SESSION_DATACACHE_NORMALTRIGGER, IFS_SERVICE_SESSION_DATACACHE_PURGETARGET, IFS_SERVICE_SESSION_DATACACHE_SIZE, IFS_SERVICE_SESSION_DATACACHE_URGENTTRIGGER, IFS_SERVICE_SESSION_DEFAULTSEARCHTIMEOUTPERIOD, IFS_SERVICE_SESSION_EVENTPOLLER, IFS_SERVICE_SESSION_EVENTPOLLERPERIOD, IFS_SERVICE_SESSION_FOLDERITEM_CACHING_ENABLED, IFS_SERVICE_SESSION_FOLDERPATHCACHE_ENABLED, IFS_SERVICE_SESSION_FOLDERPATHCACHE_NORMALTRIGGER, IFS_SERVICE_SESSION_FOLDERPATHCACHE_PURGETARGET, IFS_SERVICE_SESSION_FOLDERPATHCACHE_SIZE, IFS_SERVICE_SESSION_FOLDERPATHCACHE_URGENTTRIGGER, IFS_SERVICE_SESSION_SERVEROBJECTCACHE_EMERGENCYTRIGGER, IFS_SERVICE_SESSION_SERVEROBJECTCACHE_NORMALTRIGGER, IFS_SERVICE_SESSION_SERVEROBJECTCACHE_PURGETARGET, IFS_SERVICE_SESSION_SERVEROBJECTCACHE_SIZE, IFS_SERVICE_SESSION_SERVEROBJECTCACHE_URGENTTRIGGER, IFS_SERVICE_SESSION_SERVERSESSION, IFS_SERVICE_SESSION_TRANSACTIONSTACKSIZE, IFS_SERVICE_SESSIONOPERATIONTIMEOUTPERIOD, IFS_SERVICE_TRACING_BEANSSESSIONTRACETYPE, IFS_SERVICE_TRACING_CHANNELCOUNT, IFS_SERVICE_TRACING_CHANNELLEVEL, IFS_SERVICE_TRACING_DEFAULTTRACELEVEL, IFS_SERVICE_TRACING_SERVERSESSIONTRACETYPE, IFS_SERVICE_TRACING_SERVICETRACETYPE, IFS_SERVICE_TRANSPORTBATCHSIZE, IFS_SERVICE_TRANSPORTEVENTSTOOTHERSERVICESPERIOD, IFS_SESSIONSTATE_APPLICATION_SESSIONID, IFS_SESSIONSTATE_AUDIT_DOMAIN_DEFAULT, IFS_SESSIONSTATE_OPERATIONS_COPYTABLE, IFS_SESSIONSTATE_OPERATIONS_FREETABLE, IFS_SESSIONSTATE_OPERATIONS_UPDATETABLE, INFORMATIONEXTRACTIONENTITYPHRASE_INDEX_PREFIX, INFORMATIONEXTRACTIONENTITYPHRASE_TABLE_PREFIX, LIBRARYOBJECT_INDEXNAME_PREFIX, LIBRARYOBJECT_TABLENAME_PREFIX, LIBRARYOBJECT_VIEWNAME_PREFIX, LOCKTYPE_CHECKOUT, LOCKTYPE_CUSTOM, LOCKTYPE_DAV, LOCKTYPE_FAMILYHASRECORD, LOCKTYPE_FINALIZED, LOCKTYPE_FREEZE, LOCKTYPE_HAS_RECORD, LOCKTYPE_LIFECYCLE, LOCKTYPE_MANUAL, LOCKTYPE_NAMEDFREEZE, LOCKTYPE_RECORD, LOCKTYPE_RETENTION, LOCKTYPE_WORKFLOW, MAPVALUES_TABLENAME_PREFIX, PERFORMEDACTIVITY_PRIVATEACTIONINDEX_PREFIX, PERFORMEDACTIVITY_PRIVATEACTIONTABLE_PREFIX, PERFORMEDACTIVITY_SEQUENCE_PREFIX, PERFORMEDACTIVITY_SUMMARYTABLE_PREFIX, PERFORMEDACTIVITY_TABLE_PREFIX, PERFORMEDACTIVITY_VIEW_PREFIX, PUBLIC_SESSIONSTATE_APPLICATION_CONTEXT, PUBLIC_SESSIONSTATE_APPLICATION_USERIDENTIFER, PUBLICOBJECT_BASESECUREVIEWNAME_PREFIX, PUBLICOBJECT_BASEVIEWNAME_PREFIX, PUBLICOBJECT_SECUREVIEWNAME_PREFIX, PUBLICOBJECT_UNDELETED_SECUREVIEWNAME_PREFIX, PUBLICOBJECT_UNDELETED_VIEWNAME_PREFIX, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_CHECKOUT, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_DAV, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_FINALIZED, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_FREEZE, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_HASRECORD, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_LIFECYCLE, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_MANUAL, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_NAMEDFREEZE, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_RECORD, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_RETENTION, RESOURCEKEY_IFS_ORACLELOCKTYPE_DESCRIPTION_WORKFLOW, SYSTEMLOCK_NAME_FINALIZED, SYSTEMLOCK_NAME_FREEZE, SYSTEMLOCK_NAME_HAS_RECORD, SYSTEMLOCK_NAME_LIFECYCLE, SYSTEMLOCK_NAME_RECORD, SYSTEMLOCK_NAME_RETENTION, TRACKEDACTIVITY_PRIVATEACTIONINDEX_PREFIX, TRACKEDACTIVITY_PRIVATEACTIONTABLE_PREFIX, TRACKEDACTIVITY_SEQUENCE_PREFIX, TRACKEDACTIVITY_SUMMARYTABLE_PREFIX, TRACKEDACTIVITY_TABLE_PREFIX, TRACKEDACTIVITY_VIEW_PREFIX
Modifier | Constructor and Description |
---|---|
protected |
S_LibrarySession(S_LibraryService service)
Constructs an unauthenticated S_LibrarySession.
|
Modifier and Type | Method and Description |
---|---|
void |
abortImplicitTransaction(Transaction transaction)
Aborts an implicit transaction.
|
void |
abortImplicitTransaction(Transaction transaction,
IfsException originalException)
Aborts an implicit transaction.
|
void |
abortTransaction(Transaction transaction)
Aborts a transaction.
|
void |
abortTransaction(Transaction transaction,
IfsException originalException)
Aborts a transaction in response to the specified IfsException.
|
Connection |
acquireAuxiliaryConnection()
Acquires an auxiliary Connection for use by this S_LibrarySession.
|
LibraryConnection |
acquireAuxiliaryLibraryConnection()
Acquires an auxiliary LibraryConnection for use by this S_LibrarySession.
|
protected void |
addLockedForSessionObject(Long objid)
Adds the specified S_PublicObject to this S_LibrarySession's
internal table of session-locked objects.
|
protected void |
addLockedForSessionObject(S_PublicObject obj)
Adds the specified S_PublicObject to this S_LibrarySession's
internal table of session-locked objects.
|
protected S_LibraryObjectSelector |
addSelectorToHashMap(Long classId)
Creates an S_LibraryObjectSelector for the specified classobject
and adds it to the hashtable of S_LibraryObjectSelectors.
|
protected void |
addSSelector(S_Selector sel)
Add the specified S_Selector to the set of S_Selectors for this
S_LibrarySession.
|
Transaction |
beginImplicitReadonlyTransaction()
Starts a readonly transaction implicitly at the beginning of an
operation.
|
Transaction |
beginImplicitTransaction()
Starts a writeable transaction implicitly at the beginning of an
operation.
|
Transaction |
beginReadonlyTransaction()
Starts a readonly transaction.
|
Transaction |
beginTransaction()
Starts a writeable transaction.
|
Transaction |
beginTransaction(boolean writeable)
Starts a transaction.
|
protected void |
clearCachedAllAncestorIds()
Clears the cached set of all IDs of ancestor groups (direct or indirect)
for this user.
|
protected void |
clearPreparedInsertStatement(PreparedStatement stmt,
S_ClassObjectData clssdef)
Clears all bind variables of the specified INSERT statement for the
specified classobject.
|
protected void |
clearValueInStatement(PreparedStatement stmt,
int position,
int datatype)
Clears the value of a bind variable in the specified PreparedStatement.
|
void |
commit()
Makes all pending changes for all in-progress Transactions for this
S_LibrarySession visible to all other S_LibrarySessions.
|
void |
completeImplicitTransaction(Transaction transaction)
Completes an implicit transaction.
|
void |
completeTransaction(Transaction transaction)
Completes a transaction.
|
protected S_LibraryObject |
constructLibraryObject(Long class_id)
Constructs a new, non-persistent S_LibraryObject.
|
protected S_LibraryObject |
constructLibraryObject(S_LibraryObjectData data)
Constructs an S_LibraryObject for the specified S_LibraryObjectData.
|
protected S_LibraryObjectData |
constructLibraryObjectData(S_LibraryObjectSelector sel,
Long id)
Construct an S_LibraryObjectData by singleton-selecting the
specified object using the specified S_LibraryObjectSelector.
|
protected OperationDriver |
constructOperationDriver()
Constructs an OperationDriver instance to be used to drive a
policy-driven operation.
|
protected S_LibraryObjectDataSharedState |
constructSharedState()
Returns a newly constructed shared state instance of the proper type.
|
protected S_LibraryObjectCursor |
createLibraryObjectCursor(LibraryQueryStatement lstmt,
ResultSet resultSet,
S_LibraryObjectSelector selector)
Creates a S_LibraryObjectCursor.
|
AttributeValue |
createPublicObjectInstance(OperationState opState,
S_LibraryObjectDefinition sdef)
Creates a new S_PublicObject based on the specified
S_LibraryObjectDefinition within an OperationState
context.
|
AttributeValue |
createSchemaObjectInstance(OperationState opState,
S_LibraryObjectDefinition sdef)
Creates a new S_SchemaObject based on the specified
S_LibraryObjectDefinition within an OperationState
context.
|
AttributeValue |
createSimpleObjectInstance(OperationState opState,
S_LibraryObjectDefinition sdef)
Creates a new S_SimpleObject based on the specified
S_LibraryObjectDefinition within an OperationState
context.
|
AttributeValue |
createSystemObjectInstance(OperationState opState,
S_LibraryObjectDefinition sdef)
Creates a new S_SystemObject based on the specified
S_LibraryObjectDefinition within an OperationState
context.
|
protected AttributeValue |
createVersionedPublicObjectInstance(OperationState opState,
S_LibraryObjectDefinition sdef)
Creates a new S_PublicObject based on the specified
S_LibraryObjectDefinition within an OperationState
context.
|
void |
deleteExpiredAuditFolderPaths(long expPeriod)
Delete any expired Audit folder paths, that have expired
longer than the specified period.
|
void |
deleteExpiredGlobalAuditEvents(Long domainId,
Long specId,
Long expPeriod)
Delete any expired global audit events.
|
protected void |
deleteRepositoryParameter(String name)
Deletes the specified repository parameter.
|
void |
deleteUnusedAuditFolderPathOverflowEntries()
Delete any unused overflow entries for Audit folder paths.
|
void |
deleteUnusedAuditProperties()
Delete any unreferenced Audit event properties.
|
void |
deregisterClassEventHandler(S_ClassObject co,
boolean includeSubclasses,
IfsEventHandler handler)
Deregisters the specified IfsEventHandler for the specified
class.
|
void |
deregisterCollection(Collection collection,
String classname)
Deregisters a collection, cancelling the event registration.
|
void |
deregisterEventHandler(S_LibraryObject lo,
IfsEventHandler handler)
Deregisters the specified IfsEventHandler for the specified
S_LibraryObject.
|
protected void |
destroyOperationDriver()
Destroys the current OperationDriver and nulls the reference
to it.
|
Long |
directlyDispatchAuditEvent(AuditEvent event,
Long specId)
Directly dispatch an AuditEvent to the specified AuditSpecifcation's
event history.
|
protected void |
disconnect()
Disconnects this S_LibrarySession.
|
S_LibraryObject |
discoverLibraryObject(Long id)
Gets an S_LibraryObject by ID, without knowing the class ID.
|
S_LibraryObject |
discoverLibraryObject(Long id,
Long classId)
Gets an S_LibraryObject by ID and classId.
|
S_PublicObject |
discoverPublicObject(Long id)
Gets an S_PublicObject by id.
|
void |
DMAbortTransaction(Transaction transaction)
Aborts a transaction.
|
S_LibraryObjectData |
DMaddAccessControlEntry(Long id,
Long classId,
S_LibraryObjectDefinition sdef)
Adds an S_AccessControlEntry to the specified S_AccessControlList.
|
Long |
DMAddAttributeToClassObject(Long id,
S_LibraryObjectDefinition def)
Adds an attribute to an existing classobject.
|
void |
DMAddFolderRelationship(Long id,
Long classid,
S_LibraryObjectDefinition rdef)
Adds an item to the specified S_Folder.
|
void |
DMAddManualTextIndexing(Long id,
Long classId,
ContentStreamSerializer css)
Adds text index information manually.
|
void |
DMAddMembersToDirectoryGroup(Long group_id,
Long classid,
Long[] rightObjIds,
Long[] rightObjClassids)
Adds the specified S_DirectoryObjects to the specified S_DirectoryGroup.
|
void |
DMAddMemberToDirectoryGroup(Long group_id,
Long classid,
Long member_id,
Long memberClassid)
Adds the specified S_DirectoryObject to the specified S_DirectoryGroup.
|
S_LibraryObjectData |
DMAddRelationship(Long id,
Long classId,
S_LibraryObjectDefinition rdef)
Adds a relationship for the specified S_PublicObject.
|
void |
DMAddToFolder(Long folder_id,
Long classid,
Long rightObj,
Long rightObjClassid)
Adds the specified item to the specified S_Folder.
|
void |
DMApplyAclIndexDeferredUpdate(AccessControlListDeferredUpdate entry,
boolean deleteAfterProcessing)
Forces re-calculation of an ACL's discoverer table.
|
void |
DMApplyFolderIndexDeferredUpdate(FolderIndexDeferredUpdate entry)
Applies a deferred update to the Folder index
|
Transaction |
DMBeginTransaction(boolean writeable)
Starts a transaction.
|
void |
DMCalculateConsumedStorage(Long quotaid,
Long classid)
Recalculates consumed storage for the specified S_ContentQuota.
|
void |
DMCancelOperation()
Cancel any server-side operation in progress for this session.
|
boolean |
DMCheckExistenceOfPublicObjectByPath(Long folder_id,
Long classid,
String path)
Checks whether there exists an S_PublicObject at a path relative
to a specified S_Folder.
|
void |
DMCloseFolder(Long folder_id,
Long classid)
Closes the specified S_Folder.
|
void |
DMCloseSearch(Long srchId)
Closes the specified S_Search.
|
void |
DMCloseSelector(long selId)
Closes the specified selector.
|
void |
DMCommit()
Makes all pending changes for all in-progress Transactions for this
S_LibrarySession visible to all other S_LibrarySessions.
|
void |
DMCompleteTransaction(Transaction transaction)
Completes a transaction.
|
S_LibraryObjectData |
DMConvertToPrivateACL(Long id,
Long classId,
S_LibraryObjectDefinition sdef)
Makes the specified S_PublicObject have a private S_AccessControlList.
|
S_LibraryObjectData |
DMCopyLibraryObject(Long id,
Long classId,
S_LibraryObjectDefinition sdef)
Copies the specified S_LibraryObject.
|
S_LibraryObjectData |
DMCreateDefaultPolicyPropertyBundle(Long id,
Long classId)
Deprecated.
CM SDK 10gR2: see release notes for changes to Policy framework
|
S_LibraryObjectData |
DMCreateDefaultPropertyBundle(Long id,
Long classId)
Creates a default PropertyBundle.
|
void |
DMCreateRetainedEventDatabaseObjects(RetainedEvent event)
Create tables associated with a RetainedEvent type
|
void |
DMCreateView(ViewSpecification vsp)
Creates a view for the specified ViewSpecification.
|
void |
DMDelete(Long id,
Long classId,
S_LibraryObjectDefinition def)
Deletes the specified S_PublicObject.
|
void |
DMDeleteAclIndexDeferredUpdates(Long[] ids)
deletes a set of Deferred ACL Resolution Entries
|
void |
DMDeleteRepositoryParameter(String name)
Deletes the specified repository parameter.
|
void |
DMDeleteRetainedEvent(RetainedEvent event)
Delete a RetainedEvent
|
oracle.sql.ORAData |
DMDequeueMessage(Long id,
Long classId,
String subscriberName)
Dequeues a message from the specified queue as the
specified subscriber.
|
oracle.sql.ORAData |
DMDequeueMessageFromExceptionQueue(Long id,
Long classId)
Dequeues a message from the specified exception queue.
|
void |
DMDeregisterClassEventHandler(Long classId)
Receive notification that the bean-side has de-registered all
event handlers for the specified ClassObject.
|
void |
DMDeregisterEventHandler(Long id)
Receive notification that the bean-side has de-registered all
event handlers for the specified object.
|
void |
DMDeregisterServiceEventHandler(IfsEventHandler handler)
De-register a Service event handler.
|
Long |
DMDirectlyDispatchAuditEvent(AuditEvent event,
Long specId)
Directly dispatch an AuditEvent to the specified AuditSpecifcation's
event history.
|
void |
DMDisconnect()
Disconnects this S_LibrarySession.
|
void |
DMDisposeSearch(Long srchId)
Disposes the specified S_Search.
|
void |
DMDropRetainedEventDatabaseObjects(RetainedEvent event)
Drop tables associated with a RetainedEvent type
|
void |
DMEmptyWastebasket()
Empties the user's (or feigned user's, if applicable) wastebasket.
|
void |
DMEnqueueMessage(Long id,
Long classId,
oracle.sql.ORAData message)
Enqueues the message on the specified queue.
|
void |
DMEnqueueMessage(Long id,
Long classId,
oracle.sql.ORAData message,
String correlation)
Enqueues the message on the specified queue.
|
void |
DMFeignUser(Long id,
Long classid)
Feigns the specified S_DirectoryUser.
|
Long[] |
DMfetchACEs(Long id,
Long classId)
Gets the S_AccessControlEntries for the specified S_AccessControlList.
|
Vector |
DMFetchPolicyListElements(Long policyListId,
Long policyListClassId)
Gets the PolicyListElements for the specified PolicyList.
|
Vector |
DMFetchProperties(Long propBundleId,
Long propClassId)
Gets the S_Properties for the specified S_PropertyBundle.
|
Long[] |
DMfetchRevisions(Long id,
Long classid)
Gets the S_VersionDescription IDs for the specified S_VersionSeries.
|
Long[] |
DMfetchVersionSerieses(Long id,
Long classid)
Gets the S_VersionSeries for the specified S_Family.
|
void |
DMFilterContent(Long id,
Long classId,
boolean plaintext,
Long refObjId,
Long refObjClassId)
Filters the specified S_ContentObject.
|
void |
DMFilterDeletedObjects(boolean mode)
Deprecated.
iFS 9.0.3 Has no effect
|
S_LibraryObjectData |
DMFindPublicObjectByPath(Long folder_id,
Long classid,
String path)
Finds an S_PublicObject by its path relative to a specified S_Folder.
|
void |
DMFlushEvents()
Flushes any outgoing events in event exchanger.
|
boolean |
DMFolderHasSubFolders(Long folder_id,
Long classid)
Returns true if the folder has subfolders.
|
void |
DMForceReadEvents()
Forces incoming events from the event exchanger to be processed.
|
void |
DMFree(Long id,
Long classId,
S_LibraryObjectDefinition def)
Frees the specified S_LibraryObject.
|
void |
DMGenerateSummary(Long id,
Long classId,
String pointOfView,
long sizeAsPercent,
long sizeAsNumParagraphs,
String summaryLevel,
Long refObjId,
Long refObjClassId)
Generates a summary of the specified S_ContentObject.
|
void |
DMGenerateThemes(Long id,
Long classId,
boolean fullThemes,
Long refObjId,
Long refObjClassId)
Generates the themes of the specified S_ContentObject.
|
AccessLevel |
DMGetAccessLevel(Long id,
Long classId,
Long userId)
Gets the AccessLevel of the specified S_DirectoryUser for the
specified S_AccessControlList.
|
Vector |
DMGetAclIndexDeferredUpdates(int maxItems)
gets a set of Deferred ACL Resolution Entries
|
Long[] |
DMGetAllAncestorsOfDirectoryObject(Long id,
Long classid)
Gets all ancestors of the specified S_DirectoryGroup.
|
String[] |
DMGetAllFolderPaths(Long id,
Long classid,
Long folderRefId,
Long folderRefClassid,
FolderPathOptions fpo,
SortSpecification sort)
Return all reachable folder paths to an object, or null if there is no
reachable path.
|
Long[] |
DMGetAllMembersOfDirectoryGroup(Long id,
Long classid,
boolean filterForDiscoverability)
Gets all members of the specified S_DirectoryGroup.
|
int |
DMGetAncestorThreshold()
Gets the threshold for using a temp table to select all (recursive) ancestors
of a directory object.
|
String |
DMGetAnyFolderPath(Long id,
Long classid,
Long folderRefId,
Long folderRefClassid,
FolderPathOptions fpo,
SortSpecification sort)
Return a folder path to an object, or null if there is no
reachable path.
|
Vector |
DMGetArrayReferencingObjects(Long attributeId,
AttributeValue referencedValue,
SortSpecification sort)
Gets the set of object data for objects that are instances
of the class on which the specified Attribute is defined,
and whose array value contains the specified referenced value.
|
AttributeValue |
DMGetArrayTypeAttributeValue(long objectId,
long attributeId,
Long priClassId,
int count)
Gets a fully resolved array-type AttributeValue with non-transient
elements for the the specified object/attribute combination.
|
long |
DMGetAttributesRsn()
Gets the attributes RSN of the service.
|
AuditCertificate[] |
DMGetAuditCertificates(Long[] objectIds)
Select AuditCertificates for the specified object IDs.
|
AttributeValue[] |
DMGetAuditTypesForClass(String className,
boolean includeNested)
Gets the audit operation type values for a specified
class name, optionally including any types that are
applicable to a class that is considered a descendent of the
specified class.
|
AttributeValue[] |
DMGetAuditTypesForCreateOperations()
Gets the audit operation type values that correspond to "CREATED"
operations.
|
AttributeValue[] |
DMGetAuditTypesForFreeOperations()
Gets the audit operation type values that correspond to "FREED"
operations.
|
Long[] |
DMGetCategoryIds(Long id,
Long classid)
Gets all category IDs for the specified S_PublicObject or
S_SystemObject or S_SchemaObject
For publicobjects, it returns only the set of ID's
that represents Categories
that the current session can discover (which in general
should always be all of the categories, since the ACL of
the Category should always be the same as the PO).
|
Long |
DMGetClockOffset()
Gets the clock offset, representing the number of milliseconds the
DBMS clock is ahead of this mid tier.
|
Long[] |
DMGetCompositeAclIds(Long id,
Long classid,
SortSpecification sort)
Gets the set of composite ACLs which reference the target ACL as a
"component".
|
long |
DMGetConsumedStorage(Long id,
Long classid)
Returns the storage (in bytes) consumed by a given public object.
|
RandomAccessor |
DMGetContentByRandomAccess(Long coId,
Long coClassId,
Long refObjId,
Long refObjClassId)
Gets a RandomAccessor for randomly reading the content of the specified
ContentObject.
|
ContentStreamSerializer |
DMGetContentReader(Long id,
Long classId,
Long refObjId,
Long refObjClassId)
Gets the content of the specified S_ContentObject as a reader.
|
ContentStreamSerializer |
DMGetContentStream(Long id,
Long classId,
Long refObjId,
Long refObjClassId)
Fetches a ContentStream encapulated in a ContentStreamSerializer for
the given ContentObject.
|
AttributeValue[] |
DMGetCustomAuditTypes()
Gets the custom audit operation type values.
|
Long[] |
DMGetDirectAncestorsOfDirectoryObject(Long id,
Long classid)
Gets the direct ancestors of the specified S_DirectoryGroup.
|
Long[] |
DMGetDirectMembersOfDirectoryGroup(Long id,
Long classid,
boolean filterForDiscoverability)
Gets the direct members of the specified S_DirectoryGroup.
|
S_LibraryObjectData |
DMGetDirectoryUserData()
Gets the S_LibraryObjectData for the current S_DirectoryUser
for this S_LibrarySession.
|
Long[] |
DMGetDiscoverabilityOfPublicObjectsIds(Long[] ids)
Return indication as to which PublicObject objects specified (by ID) the
current user can discover.
|
Vector |
DMGetEffectiveClassPolicyListElements(Long id,
Long classId,
String operation)
Gets the set of policies, as PolicyListElement ids, implicitly
applied to all instances of the specified ClassObject for the
specified operation.
|
Vector |
DMGetEffectivePolicyListElements(Long id,
Long classId,
String operation)
Gets the set of policies, as PolicyListElement ids, applied to the
specified LibraryObject, either explicitly (through its
PolicyLists) or implicitly (through the
ClassPolicyLists of its classobject hierarchy) for the specified
operation.
|
String |
DMGetEncryptedRepositoryParameter(String name)
Gets the value of the specified repository parameter.
|
Vector |
DMGetExpiredTimedLocks(int maxItems,
int offset)
Get a set of timed out locks, bounded in size by the max count
specified.
|
ContentStreamSerializer |
DMGetFilteredContent(Long id,
Long classId,
Long refObjId,
Long refObjClassId)
Gets the filtered content for the specified S_ContentObject as as reader.
|
Vector |
DMGetFolderIndexDeferredUpdates(int maxItems)
gets a set of Deferred Folder index updates
|
long |
DMGetFolderItemCount(Long id,
Long classId,
String folderRelClassname)
Gets the number of items in the specified S_Folder.
|
Long[] |
DMGetFolderItemList(Long folder_id,
Long classid,
SortSpecification sort)
Gets the item IDs in the specified Folder.
|
Long[] |
DMGetFolderReferences(Long PublicObject_id,
Long classid,
SortSpecification sort)
Gets the S_Folders that contain the specified S_PublicObject.
|
long |
DMGetHighestAuditId()
Get the highest Audit Id in use.
|
Long[] |
DMGetIdsForNewObjects(int length)
Returns a set of objects that can be used to import new objects.
|
Date |
DMGetLastAccessDate(Long id,
Long classId)
Gets when the content of a ContentObject was most recently written
or read.
|
Vector |
DMGetLeftwardRelationshipObjects(Long id,
Long classId,
Long relClassId,
SortSpecification sort)
Gets the target objects of the leftward relationships for the
specified S_PublicObject.
|
Vector |
DMGetLeftwardRelationships(Long id,
Long classId,
Long relClassId,
SortSpecification sort)
Gets the leftward relationships for the specified S_PublicObject.
|
long |
DMGetLeftwardRelationshipsCount(Long id,
Long classId,
Long relClassId)
Gets the number of leftward relationships for the specified
S_PublicObject.
|
S_LibraryObjectData |
DMgetLibraryObjectData(Long id,
Long classId,
String attributeName,
boolean selectFully)
Gets the S_LibraryObjectData for the specified id and class id.
|
Long[] |
DMGetLinks(Long id,
Long classid)
Gets the Links for the specified PublicObject.
|
Vector |
DMGetLockedForSessionObjects()
Gets the objects in this S_LibrarySession's internal table of
session-locked objects.
|
AttributeValue |
DMGetMapTypeAttributeValue(int dataType,
long objectId,
long attrIdVal,
int count)
Gets a fully resolved map-type AttributeValue with non-transient
elements for the the specified object/attribute combination.
|
int |
DMGetMemberThreshold()
Gets the threshold for using a temp table to select all (recursive) members
of a group.
|
String |
DMGetNLSDatabaseParameterValue(String parameter)
Gets the value for the specified NLS database parameter.
|
Serializable |
DMGetObjectReferenceAttribute(Long id,
Long classId,
String attrName)
Gets the value of the specified object-reference type attribute.
|
S_LibraryObjectData |
DMGetOurPrimaryUserProfile()
Gets the S_PrimaryUserProfile of current S_DirectoryUser for
this S_LibrarySession.
|
Long |
DMGetPartitionValue(Long id,
Long classId)
Gets the partition value of a ContentObject.
|
int |
DMGetPreparedSelectorItemCount(String statementKey,
boolean distinct,
AttributeValue searchTarget,
AttributeValue[] auxSearchTargets,
String[] bypassSecAliases,
String joinCondition,
String searchDefinition,
boolean recursive,
String hint,
AttributeValue[] bindValues)
Constructs an S_PreparedSelector and gets its item count.
|
AttributeValueTable[] |
DMGetPreparedSelectorResults(String statementKey,
boolean distinct,
AttributeValue searchTarget,
AttributeValue[] auxSearchTargets,
ColumnDescriptor[] colDescs,
String[] bypassSecAliases,
String joinCondition,
String searchDefinition,
boolean recursive,
String language,
int maxItemCount,
int rowNumber,
String hint,
SortSpecification sort,
AttributeValue[] bindValues)
Constructs an S_PreparedSelector and gets its results.
|
S_LibraryObjectData |
DMGetPrimaryUserProfile(Long id)
Gets the S_PrimaryUserProfile of the specified S_DirectoryUser.
|
AttributeValue |
DMGetProperty(Long propBundleId,
Long propClassId,
String propertyName)
Gets the property value from the property bundle.
|
S_LibraryObjectData |
DMGetPublicObjectData(Long id,
Long classId)
Gets the S_LibraryObjectData for the specified S_PublicObject.
|
Vector |
DMGetPublicObjectsReferringToLockObject(Long id,
Long classid,
SortSpecification sort)
Gets the PO's that reference this LockObject
|
String |
DMGetRepositoryParameter(String name)
Gets the value of the specified repository parameter.
|
String[] |
DMGetRepositoryParameterNames(String prefix)
Gets the repository parameter names that start with the specified prefix.
|
S_ClassObjectData |
DMGetResolvedClassObjectData(Long id)
Gets the fully-resolved S_ClassObjectData.
|
RetainedEvent[] |
DMGetRetainedEvents(RetainedEvent event,
int maxItems)
Select RetainedEvents
|
Vector |
DMGetRightwardRelationshipObjects(Long id,
Long classId,
Long relClassId,
SortSpecification sort)
Gets the target objects of the rightward relationships for the
specified S_PublicObject.
|
Vector |
DMGetRightwardRelationships(Long id,
Long classId,
Long relClassId,
SortSpecification sort)
Gets the rightward relationships for the specified S_PublicObject.
|
String |
DMGetSchemaName()
Gets the schema name in effect for the service.
|
S_LibraryObjectData |
DMGetSchemaObjectData(Long id,
Long classId)
Gets the S_LibraryObjectData for the specified S_SchemaObject.
|
int |
DMgetSearchItemCount(Long srchId,
Vector bindValues,
String language,
int timeout)
Gets the item count for the specified S_Search.
|
SearchSpecification |
DMGetSearchSpecification(Long srchId)
Gets the SearchSpecification of the specified S_Search.
|
String |
DMgetSearchSQLString(Long srchId)
Gets the SQL string for the specified S_Search.
|
long |
DMGetSelectorItemCount(String searchClass,
String searchDefinition,
boolean recursive)
Constructs an S_Selector and gets its number of items.
|
Hashtable |
DMGetServiceConfigurationProperties()
Gets the service properties.
|
Long |
DMGetServiceId()
Gets the id of the S_LibraryService hosting this S_LibrarySession.
|
int[] |
DMGetServiceTraceLoggerLevels()
Gets the trace levels of the S_LibraryServiceTraceLogger.
|
Long |
DMGetSessionId()
Gets the id of this S_LibrarySession.
|
int[] |
DMGetSessionTraceLoggerLevels()
Gets the trace levels of the S_LibrarySessionTraceLogger.
|
S_LibraryObjectData |
DMGetSimpleObjectData(Long id,
Long classId)
Gets the S_LibraryObjectData for the specified S_SimpleObject.
|
S_LibraryObjectDefinition |
DMGetSLibraryObjectDefinition(Long id,
Long classId)
Generates an S_LibraryObjectDefinition for the specified S_LibraryObject.
|
long |
DMGetSubfolderCount(Long id,
Long classId,
String folderRelClassname)
Gets the number of folders in the specified S_Folder.
|
ContentStreamSerializer |
DMGetSummary(Long id,
Long classId,
String pointOfView,
Long refObjId,
Long refObjClassId)
Gets the summary of the specified S_ContentObject as as reader.
|
S_LibraryObjectData |
DMGetSystemObjectData(Long id,
Long classId)
Gets the S_LibraryObjectData for the specified S_SystemObject.
|
ContextTheme[] |
DMGetThemes(Long id,
Long classId,
Long refObjId,
Long refObjClassId)
Gets the themes of the specified S_ContentObject.
|
int |
DMGetTotalFolderItemCount(Long folder_id,
Long classid)
Gets the count of items in a folder, including undiscoverable
items.
|
long |
DMGetWastebasketSelectorItemCount(String searchClass,
String searchDefinition,
boolean recursive)
Constructs a wastebasket S_Selector and gets its number of items.
|
void |
DMGrantAdmin(Long userid)
Grants administration privilege to the specified S_DirectoruUser.
|
void |
DMHandleAuditEventDispatchRequests(ArrayList reqList,
String tableName)
Handle a list of AuditEvent dispatch requests.
|
void |
DMInsertRetainedEvent(RetainedEvent event)
Add a retained event
|
void |
DMIntegrateIntoVersionSeries(Long sid,
Long sclassId,
Long tid,
Long tclassId)
Integrates an S_VersionSeries at a specified S_VersionDescription
into a second S_VersionSeries at that series's latest
S_VersionDescription, creating a new S_BranchRelationship.
|
void |
DMInvalidateTokenCredentials(Long userId)
Invalidates all the token credentials for a given user.
|
Object |
DMInvokeOperation(Long id,
Long classId,
OperationContext op)
Invokes a server-side operation.
|
Serializable |
DMInvokeServerMethod(Long id,
Long classId,
String methodName,
Serializable payload)
Invokes an S_LibrarySession or S_LibraryObject DYN method.
|
boolean |
DMIsAclIndexUpdateModeSynchronous()
determine if ACL index update mode is synchronous
|
boolean |
DMIsArrayInputsUsedForAncestorSelection()
Gets whether to use array inputs for selecting "all ancestors"
if size has exceeded threshhold.
|
boolean |
DMIsArrayInputsUsedForMemberSelection()
Gets whether to use array inputs for selecting "all members"
if size has exceeded threshhold.
|
boolean |
DMIsAttributeValueInValueDomain(Long id,
Long classId,
AttributeValue av)
Determines whether the specified attribute value
lies within this ValueDomain.
|
boolean |
DMIsContentReadByUser(Long id,
Long classId)
Gets the read state of the specified S_ContentObject.
|
boolean |
DMIsContextIndexEnabled()
whether Context has ben enabled on this schema
|
boolean |
DMIsDirectMemberOfDirectoryGroup(Long groupId,
Long groupClassId,
Long memberId,
Long memberClassId)
Check whether the specified DirectoryObject is a direct
member of the specified group.
|
boolean |
DMIsExecutionMode(int mode)
Gets whether this S_LibrarySession is in at least the specified
execution mode.
|
boolean |
DMIsInstanceOfClassVersionable(Long classId)
Gets whether an instance of the specified S_ClassObject is versionable.
|
boolean |
DMIsLockObjectShared(Long id,
Long classid)
Verifies if the LockObject is shared
|
boolean |
DMIsMemberOfDirectoryGroup(Long groupId,
Long groupClassId,
Long memberId,
Long memberClassId)
Check whether the specified DirectoryObject is a member of the
specified group, directly or indirectly.
|
boolean |
DMIsTransactionInProgress()
Gets whether this S_LibrarySession is in a transaction, explicit
or implicit.
|
boolean |
DMIsVersionable(Long id,
Long classId)
Gets whether the specified S_PublicObject is versionable.
|
Vector |
DMListItems(Long folder_id,
Long classid,
String folderRelClassname,
SortSpecification sort)
Gets the items in the specified S_Folder.
|
Vector |
DMListPreparedSelectorItems(String statementKey,
boolean distinct,
AttributeValue searchTarget,
AttributeValue[] auxSearchTargets,
String[] bypassSecAliases,
String joinCondition,
String searchDefinition,
boolean recursive,
String language,
int maxItemCount,
int rowNumber,
String hint,
SortSpecification sort,
AttributeValue[] bindValues)
Constructs an S_PreparedSelector and gets its items.
|
Vector |
DMListSelectorItems(String searchClass,
String searchDefinition,
boolean recursive,
int maxItemCount,
SortSpecification sort)
Constructs an S_Selector and gets its items.
|
Vector |
DMListWastebasketSelectorItems(String searchClass,
String searchDefinition,
boolean recursive,
SortSpecification sort)
Constructs a wastebasket S_Selector and gets its items.
|
void |
DMLockRows(Long id,
Long classId)
Obtain a row-level lock on the specified object.
|
String[] |
DMLookupAuditEventOperationTypeKeys(int[] opTypes)
Looks up audit event operation type keys by their numeric values,
returning the string keys.
|
int[] |
DMLookupAuditEventOperationTypes(String[] opTypeKeys)
Looks up audit event operation types by their string key,
returning the corresponding numeric equivalents.
|
AuditTargetCode |
DMLookupAuditTargetCode(String className)
Looks up an audit target code structure from the specified Class name or
other registered alias for the desired type.
|
S_LibraryObjectData |
DMNewBranchedVersionSeries(Long id,
Long classId,
S_LibraryObjectDefinition def)
Branches an S_VersionSeries at the specified S_VersionDescription,
resulting in a new S_VersionSeries, S_VersionDescription, and
S_BranchRelationship.
|
ContentStreamSerializer |
DMNewContentStreamSerializer()
Constructs and returns a ContentStreamSerializer appropriate to
the runtime process model.
|
S_LibraryObjectData |
DMNewPublicObject(S_LibraryObjectDefinition def)
Creates a new S_PublicObject based on the specified
S_LibraryObjectDefinition.
|
S_LibraryObjectData |
DMNewRevision(Long id,
Long classId,
S_LibraryObjectDefinition def)
Creates a new S_VersionDescription in the specified S_VersionSeries.
|
S_LibraryObjectData |
DMNewSchemaObject(S_LibraryObjectDefinition def)
Creates a new S_SchemaObject based on the specified
S_LibraryObjectDefinition.
|
Long |
DMNewSearch()
Constructs a new S_Search whose SearchSpecification is undefined.
|
Long |
DMNewSearchFromObject(Long searchObjectId)
Constructs a new S_Search whose SearchSpecification is defined
by the specified S_SearchObject.
|
S_LibraryObjectData |
DMNewSimpleObject(S_LibraryObjectDefinition def)
Creates a new S_SimpleObject based on the specified
S_LibraryObjectDefinition.
|
S_LibraryObjectData |
DMNewSystemObject(S_LibraryObjectDefinition def)
Creates a new S_SystemObject based on the specified
S_LibraryObjectDefinition.
|
S_LibraryObjectData |
DMNewVersionSeries(Long id,
Long classId,
S_LibraryObjectDefinition def)
Creates a secondary S_VersionSeries for the specified S_Family.
|
S_LibraryObjectData |
DMNextFolderItem(Long folder_id,
Long classid)
Gets the next item in the specified S_Folder.
|
Vector |
DMNextSearchItems(Long srchId,
int batchCount)
Gets the next batch of items in the specified S_Search.
|
Vector |
DMNextSelectorBatch(long selId,
int batchSize)
Gets the next batch of items for the specified selector.
|
S_LibraryObjectData |
DMNextSelectorItem(long selId)
Gets the next item in the specified selector.
|
void |
DMOpenFolder(Long folder_id,
Long classid,
String folderRelClassname,
SortSpecification sort)
Opens the items in the specified S_Folder.
|
void |
DMOpenSearch(Long srchId,
Vector bindValues,
String language,
int timeout)
Opens the specified S_Search.
|
long |
DMOpenSelector(String searchClass,
String searchDefinition,
boolean recursive,
SortSpecification sort)
Constructs and opens an S_Selector.
|
long |
DMOpenWastebasketSelector(String searchClass,
String searchDefinition,
boolean recursive,
SortSpecification sort)
Constructs and opens a wastebasket S_Selector.
|
void |
DMPersistTokenCredential(TokenCredential credential)
Makes the specified TokenCredential persistent.
|
void |
DMPopTemporaryAccessCheckMode()
Bean-side cover to
popTemporaryAccessCheckMode . |
void |
DMPopTemporaryExecutionMode()
Restore previous temporary execution mode for this session.
|
void |
DMPostAuditEvent(AuditEvent event,
int mode)
Create an audit event.
|
void |
DMPostEvent(IfsEvent event)
Posts the specified event.
|
void |
DMProcessEvents()
Processes any events after ticking the event exchanger.
|
Vector |
DMProcessEventsInBackground()
Processes any events server-side after ticking the event exchanger,
and then returns these events to the bean-side caller for
bean-side processing.
|
void |
DMPushTemporaryAccessCheckMode(boolean mode)
Bean-side cover to
pushTemporaryAccessCheckMode . |
void |
DMPushTemporaryExecutionMode(int mode)
Establishes a temporary execution mode for this session.
|
void |
DMRandomAccessorClose(S_RandomAccessorImpl ra)
Closes the specified RandomAccessor, saving any changes to the document.
|
void |
DMRandomAccessorDispose(S_RandomAccessorImpl ra)
Disposes the specified RandomAccessor, discarding any changes to the
document.
|
Long |
DMRandomAccessorGetContentObjectId(S_RandomAccessorImpl ra)
Gets the id of the ContentObject being accessed by the specified RandomAccessor.
|
Long |
DMRandomAccessorGetDocumentId(S_RandomAccessorImpl ra)
Gets the id of the Document being accessed by the specified RandomAccessor.
|
boolean |
DMRandomAccessorIsWriteable(S_RandomAccessorImpl ra)
Gets whether the specified RandomAccessor is writeable.
|
long |
DMRandomAccessorLength(S_RandomAccessorImpl ra)
Gets the content length from the specified RandomAccessor.
|
int |
DMRandomAccessorRead(S_RandomAccessorImpl ra,
long pos,
byte[] b,
int off,
int len)
Reads bytes from the specified RandomAccessor.
|
void |
DMRandomAccessorSetSession(S_RandomAccessorImpl ra)
Binds the specified RandomAccessor to this session.
|
void |
DMRandomAccessorTruncate(S_RandomAccessorImpl ra,
long len)
Truncates the content of the specified RandomAccessor.
|
void |
DMRandomAccessorWrite(S_RandomAccessorImpl ra,
long pos,
byte[] b,
int off,
int len)
Writes bytes to the specified RandomAccessor.
|
void |
DMReassociateLinks(Long oldId,
Long oldClassId,
Long newId,
Long newClassId)
Reassociate the Links for the specified PublicObject to new
specified PublicObject.
|
boolean |
DMReauthenticate(Credential credential,
ConnectOptions options)
Reauthenticates the DIRECTORYUSER for which this S_LibrarySession
was created (this is the DIRECTORYUSER returned by the method
getAuthenticatedUser ). |
int |
DMRegisterAuditEventOperationType(String opTypeKey,
int targetCode,
String targetClass,
int opCode,
Boolean createOrFree)
Register a new event type.
|
void |
DMRegisterClassEventHandler(Long classId)
Receive notification that the bean-side has a registered
event handler for the specified ClassObject.
|
int |
DMRegisterCustomAuditEventOperationCodeKey(String opCodeKey)
Register a new custom operation code key.
|
void |
DMRegisterEventHandler(Long id)
Receive notification that the bean-side has a registered
event handler for the specified object.
|
void |
DMRegisterServiceEventHandler(IfsEventHandler handler)
Register a Service event handler.
|
int |
DMReleaseExpiredLockObject(Long id,
Long classId)
Release an expired LockObject.
|
void |
DMRemoveAccessControlEntry(Long id,
Long classId,
Long aceId,
Long aceClassId)
Removes an S_AccessControlEntry in the specified S_AccessControlList.
|
void |
DMremoveAllAccessControlEntries(Long id,
Long classId)
Removes all S_AccessControlEntries from the specified S_AccessControlList.
|
void |
DMRemoveAttributeFromClassObject(Long id,
S_LibraryObjectDefinition def)
Removes an attribute from an existing classobject.
|
void |
DMRemoveAuditEvents(long[] eventIds,
String tableName)
Remove audit events.
|
void |
DMRemoveAuditEventsForTarget(Long specId,
Long targetId)
Free audit events from a specific Audit history, by target ID.
|
void |
DMRemoveFromFolder(Long folder_id,
Long classid,
Long rightObj,
Long rightObjClassid,
S_LibraryObjectDefinition def)
Removes the specified item from the specified S_Folder.
|
void |
DMRemoveMemberFromDirectoryGroup(Long group_id,
Long classid,
Long member_id,
Long memberClassid)
Removes the specified S_DirectoryObject from the specified S_DirectoryGroup.
|
void |
DMRemoveMembersFromDirectoryGroup(Long group_id,
Long classid,
Long[] rightObjIds,
Long[] rightObjClassids)
Removes the specified S_DirectoryObjects from the specified S_DirectoryGroup.
|
void |
DMRemoveRawAuditEvents(RawAuditEvent[] rawEvents)
Remove raw audit events.
|
void |
DMRemoveRelationship(Long id,
Long classId,
Long relId,
Long relClassId)
Removes a relationship from the specified S_PublicObject.
|
ContentStreamSerializer |
DMRender(Long id,
Long classId,
String rendererType,
String rendererName,
Hashtable options,
boolean reader)
Deprecated.
iFS 9.0.3 see release notes for more information
|
void |
DMReserveNext(Long id,
Long classId,
String contentPath,
String comment)
Reserves the specified S_VersionSeries.
|
void |
DMResolveObjects(Long[] ids,
Long[] classIds,
ObjectResolverSpecification spec)
Force deeper resolution for the specified LibraryObjects
|
void |
DMRollback()
Discards all pending changes for all in-progress Transactions for this
S_LibrarySession.
|
long |
DMSchemaVersionNumber()
Gets the schema version as a long.
|
String |
DMSchemaVersionString()
Gets the schema version as a string.
|
AttributeValue[] |
DMSelectAggregateAuditEventColumns(Long auditSpec,
String aggFunction,
String[] columnNames,
String[] innerColNames,
String filterClause,
String sortClause)
Returns the list of distinct values of the specified AuditEvent columns,
along with an optional aggregate function.
|
AuditEvent[] |
DMSelectAuditEvents(Long auditSpec,
String filterClause,
AttributeValue[] bindValues,
String sortClause,
int maxItems)
Select audit events.
|
RawAuditEvent[] |
DMSelectRawAuditEvents(String filterClause,
int maxItems)
Select raw audit events.
|
AuditFolderPath |
DMSelectSpecificAuditFolderPath(long folderPathId)
Select the specific AuditFolderPath for a given primary key.
|
void |
DMSendClientVersionInformation(long versionNumber,
String versionString)
Sets the LibrarySession version for this S_LibrarySession.
|
void |
DMSetApplicationName(String name)
Sets the application name.
|
S_LibraryObjectDefinition |
DMSetAttributes(Long id,
Long classId,
S_LibraryObjectDefinition def)
Updates the specified S_LibraryObject.
|
void |
DMSetContentReadByUser(Long id,
Long classId,
boolean readState,
Long refObjId,
Long refObjClassId)
Sets the read state of the specified S_ContentObject.
|
void |
DMSetEncryptedRepositoryParameter(String name,
String value)
Sets the value of the specified repository parameter.
|
void |
DMSetExecutionMode(int mode)
Sets whether the new execution mode for the session
|
void |
DMSetLibrarySession(LibrarySession session)
Sets the LibrarySession callback for this S_LibrarySession.
|
void |
DMSetRepositoryParameter(String name,
String value)
Sets the value of the specified repository parameter.
|
void |
DMSetSearchSpecification(Long srchId,
SearchSpecification sp)
Sets the SearchSpecification of the specified S_Search.
|
void |
DMSetServiceTraceLoggerLevels(int[] levels)
Sets the trace levels of the S_LibraryServiceTraceLogger.
|
void |
DMSetSessionTraceLoggerLevels(int[] levels)
Sets the trace levels of the S_LibrarySessionTraceLogger.
|
void |
DMTrace(int channel,
int level,
Long serviceId,
Long sessionId,
Long id,
String className,
String payload)
Sends a trace request to the S_LibrarySessionTraceLogger.
|
void |
DMUndelete(Long id,
Long classId,
S_LibraryObjectDefinition def)
Undeletes the specified S_PublicObject.
|
void |
DMUnregisterAuditEventOperationType(String opTypeKey)
Unregister an event type.
|
void |
DMUnReserve(Long id,
Long classId)
Unreserves the specified S_VersionSeries.
|
void |
DMupdateAccessControlEntry(Long id,
Long classId,
Long aceId,
Long aceClassId,
S_LibraryObjectDefinition sdef)
Updates an S_AccessControlEntry in the specified S_AccessControlList.
|
RandomAccessor |
DMUpdateContentByRandomAccess(Long docId,
Long docClassId,
S_LibraryObjectDefinition sdocdef,
Long expirationPeriod)
Gets a RandomAccessor for randomly writing and reading the content of
the specified document.
|
void |
DMUpdateLocalizer(Hashtable properties)
Updates the Localizer of this S_LibrarySession to reflect the Localizer
properties specified as name/value pairs.
|
void |
DMUpdateSessionDefaults(Hashtable properties)
Updates the S_LibrarySession preferences, including the name of the
default folder relationship classobject and the folder path delimiter.
|
long |
DMVersionNumber()
Gets the version of the S_LibraryService hosting this S_LibrarySession
as a long.
|
String |
DMVersionString()
Gets the version of the S_LibraryService hosting this S_LibrarySession
as a string.
|
Serializable |
DYNChangeAclResolutionMode(Serializable payload)
Change ACL resolution mode to either synchronous or asynchronous.
|
Serializable |
DYNChangeFolderIndexUpdateMode(Serializable payload)
Change folder index update mode to either synchronous or asynchronous.
|
Serializable |
DYNCleanUpDanglingArrayReferences(Serializable payload)
Clears elements of array-type object-type attributes that reference
invalid objects.
|
Serializable |
DYNCleanUpDanglingObjectReferences(Serializable payload)
Clears scalar object-type attributes that reference invalid objects.
|
Serializable |
DYNCleanupDeadServices(Serializable payload)
Cleans up S_LibraryServices that have abnormally terminated.
|
Serializable |
DYNCompleteIndexCreation(Serializable payload)
Complete the creation of the folder index.
|
Serializable |
DYNCreateAdminDirectoryObjects(Serializable payload)
Creates the admin DirectoryUser and the world DirectoryGroup.
|
Serializable |
DYNCreateInitialDeferredEntries(Serializable payload)
Create the initial deferred set of folder relationships for the
Folder index.
|
Serializable |
DYNCreateInitialSelfRows(Serializable payload)
Create the initial set of self-referencing rows inthe folder index
|
Serializable |
DYNCredentialManagerAuthenticate(Serializable payload)
Authenticates the specified credential.
|
Serializable |
DYNCredentialManagerCreateInitialContext(Serializable payload)
Creates a JNDI connection to the OiD instance for the specified
OidCredentialManager and returns the DirContext of that connection.
|
Serializable |
DYNCredentialManagerCreateUser(Serializable payload)
Deprecated.
iFS 9.0.2 added options element
|
Serializable |
DYNCredentialManagerDeleteUser(Serializable payload)
Deprecated.
iFS 9.0.2 added options element
|
Serializable |
DYNCredentialManagerGetProperty(Serializable payload)
Gets the value of the specified dynamic property for the specified
CredentialManager.
|
Serializable |
DYNCredentialManagerListUsers(Serializable payload)
Deprecated.
iFS 9.0.2 changed payload to Vector of two elements
|
Serializable |
DYNCredentialManagerSetPassword(Serializable payload)
Deprecated.
iFS 9.0.2 added options element
|
Serializable |
DYNCredentialManagerSupportsCreateUser(Serializable payload)
Determines whether the specified CredentialManager supports the
DYNCredentialManagerCreateUser method. |
Serializable |
DYNCredentialManagerSupportsDeleteUser(Serializable payload)
Determines whether the specified CredentialManager supports the
DYNCredentialManagerDeleteUser method. |
Serializable |
DYNCredentialManagerSupportsListUsers(Serializable payload)
Determines whether the specified CredentialManager supports the
DYNCredentialManagerListUsers method. |
Serializable |
DYNCredentialManagerSupportsSetPassword(Serializable payload)
Determines whether the specified CredentialManager supports the
DYNCredentialManagerSetPassword method. |
Serializable |
DYNCredentialManagerUserExists(Serializable payload)
Determines whether the specified CredentialManager can authenticate the
specified user.
|
Serializable |
DYNDeleteExpiredAuditFolderPaths(Serializable payload)
Delete any expired Audit folder paths, that have expired
longer than the specified period.
|
Serializable |
DYNDeleteExpiredGlobalAuditEvents(Serializable payload)
Delete any expired audit events from global audit history.
|
Serializable |
DYNDeleteOldFilteredContent(Serializable payload)
Garbage collects old filtered content rows.
|
Serializable |
DYNDeleteUnusedAuditFolderPathOverflowEntries(Serializable payload)
Delete any unused overflow entries for Audit folder paths.
|
Serializable |
DYNDeleteUnusedAuditProperties(Serializable payload)
Delete any unreferenced Audit event properties.
|
Serializable |
DYNExplainPlan(Serializable payload)
Generates the query plan for a S_Search.
|
Serializable |
DYNExtractContentForIndexing(Serializable payload)
DYN wrapper for the
extractContentForIndexing method
of S_LibrarySessionContentStorageManager. |
Serializable |
DYNGetAbsolutePath(Serializable payload)
Gets an absolute path, on the database-tier file system, for the specified
path.
|
Serializable |
DYNGetCommittedLibraryObjectDataCachePerformanceString(Serializable payload)
Gets the cache performance of the committed S_LibraryObjectData
cache, as a string.
|
Serializable |
DYNGetCommittedResolvedAclCachePerformanceString(Serializable payload)
Gets the cache performance of the committed Resolved ACL
cache, as a string.
|
Serializable |
DYNGetFolderIndexMaxLevel(Serializable payload)
Get the max level parameter from FolderIndexService.
|
Serializable |
DYNGetFolderPathCachePerformanceString(Serializable payload)
Deprecated.
CM SDK 10g removed explicit Folder path cache
|
Serializable |
DYNGetFoldersNeedingPromotion(Serializable payload)
Get the list of folders that are in need of promotion.
|
Serializable |
DYNGetLibraryObjectCachePerformanceString(Serializable payload)
Gets the cache performance of the S_LibraryObject cache, as a string.
|
Serializable |
DYNGetReadonlyConnectionPoolPerformanceString(Serializable payload)
Gets performance statistics of the readonly connection pool.
|
Serializable |
DYNGetRichMediaDocsWithoutRichMediaCategories(Serializable payload)
Gets all Docs that are in the "InterMedia" media but are not
associated with an InterMedia category.
|
Serializable |
DYNGetSystemUserToken(Serializable payload)
Gets the system token that can be used to efficiently clone
system sessions.
|
Serializable |
DYNGetUncommittedLibraryObjectDataCachePerformanceString(Serializable payload)
Gets the cache performance of the uncommitted S_LibraryObjectData
cache, as a string.
|
Serializable |
DYNGetUncommittedResolvedAclCachePerformanceString(Serializable payload)
Gets the cache performance of the uncommitted Resolved ACL
cache, as a string.
|
Serializable |
DYNGetUnreferencedContentObjectList(Serializable payload)
Gets List of all unreferenced ContentObjects
|
Serializable |
DYNGetWriteableConnectionPoolPerformanceString(Serializable payload)
Gets performance statistics of the writeable connection pool.
|
Serializable |
DYNInitializeFolderIndexTables(Serializable payload)
Creates folder index tables.
|
Serializable |
DYNIsFolderIndexEnabled(Serializable payload)
Returns indication of whether a folder index service is
in use.
|
Serializable |
DYNIsFolderIndexUpdateModeSynchronous(Serializable payload)
Get indication of theFolderIndexService update mode.
|
Serializable |
DYNListAllFoldersWithSubfolders(Serializable payload)
Gets all S_Folders that have one or more subfolders.
|
Serializable |
DYNPurgeEvents(Serializable payload)
Purges events older than a threshold age.
|
Serializable |
DYNRemoveInvalidTokenCredentials(Serializable payload)
Remove Token Credentials that have expired or have been expended.
|
Serializable |
DYNResetFolderIndex(Serializable payload)
Resets Folder index so that the only rows included are
"self" rows.
|
Serializable |
DYNSelectUnusedAuditTypeLists(Serializable payload)
Get a list of unused audit type list IDs.
|
Serializable |
DYNSyncContentIndex(Serializable payload)
Syncs the Oracle Text index.
|
Serializable |
DYNTruncateFolderIndexTables(Serializable payload)
Truncates the folder index tables.
|
Serializable |
DYNVacuumAnalyze(Serializable payload)
Execute the VACUUM ANALYZE action for Postgres.
|
protected void |
emptyWastebasket(S_DirectoryObject user)
Empties the user's (or feigned user's, if applicable) wastebasket.
|
boolean |
execute(PreparedStatement stmt)
Covers a JDBC execute statement, so that this statement
can be cancelled if it blocks.
|
boolean |
execute(Statement stmt,
String sql)
Covers a JDBC execute statement, so that this statement
can be cancelled if it blocks.
|
int[] |
executeBatch(Statement stmt)
Covers a JDBC executeBatch statement, so that this statement
can be cancelled if it blocks.
|
ResultSet |
executeQuery(PreparedStatement stmt)
Covers a JDBC executeQuery statement, so that this statement
can be cancelled if it blocks.
|
ResultSet |
executeQuery(Statement stmt,
String sql)
Covers a JDBC executeQuery statement, so that this statement
can be cancelled if it blocks.
|
int |
executeUpdate(PreparedStatement stmt)
Covers a JDBC executeUpdate statement, so that this statement
can be cancelled if it blocks.
|
int |
executeUpdate(Statement stmt,
String sql)
Covers a JDBC executeUpdate statement, so that this statement
can be cancelled if it blocks.
|
S_ClassObjectData |
findClassData(String className)
Returns an S_ClassObjectData given a class name.
|
protected S_LibraryObjectCursor |
findLibraryObjectCursor(long cursorId)
Finds a S_LibraryObjectCursor.
|
protected S_LibraryObjectData |
findLibraryObjectData(Long id)
Finds the S_LibraryObjectData in the data cache
|
protected AccessControlListResolver |
findOrConstructAclResolver(Long key)
Finds a previously constructed uncommitted AccessControlListResolver,
or failing that, a commited AccessControlListResolver for the
specified id.
|
protected S_LibraryObjectSelector |
findSelectorInCache(Long classId)
Gets the S_LibraryObjectSelector for the specified classobject.
|
S_LibraryObjectSelector |
findSelectorInCache(String className)
Gets the S_LibraryObjectSelector for the specified classobject.
|
protected S_Selector |
findSSelector(long selId)
Get the specified S_Selector from the set of S_Selectors for
this S_LibrarySession.
|
void |
flushEvents()
Flush any pending outgoing events.
|
protected void |
forceOriginalSessionState()
Clears discover administration mode and set deleted object filtering
mode to the default value for this S_LibrarySession.
|
protected String |
generateInsertStatement(String tableName,
S_ClassObjectData clssdef)
Generates a INSERT statement string for the specified classobject.
|
int |
getAncestorThreshold()
Gets the threshold for using a temp table to select all (recursive) ancestors
of a directory object.
|
protected String |
getApplicationName()
Gets the name of the application that created this session.
|
protected Object[] |
getArrayAttributeValueEntries(int dataType,
AttributeValue av)
Gets the array of objects corresponding to an array-type
AttributeValue.
|
AttributeValue |
getArrayTypeAttributeValue(AttributeValueArray av,
long objectId,
long attributeId,
Long priClassId,
int count)
Gets a fully resolved array-type AttributeValue with non-transient
elements that is a copy of the specified array-type AttributeValue.
|
static AttributeValue |
getArrayTypeAttributeValue(AttributeValueArray av,
long objectId,
long attributeId,
Long priClassId,
S_LibrarySession session,
LibraryConnection lconn,
Connection conn)
Gets a fully resolved array-type AttributeValue with non-transient
elements that is a copy of the specified array-type AttributeValue.
|
String |
getAttributeSortName(String classname,
String attributename)
Gets the database object name of the specified attribute.
|
protected BoundedCache |
getAuditCertificateCache()
Gets the AuditCertificate cache.
|
AuditCertificate[] |
getAuditCertificates(Long[] objectIds)
Select AuditCertificates for the specified object IDs.
|
protected BoundedCache |
getAuditInlineStringCache()
Gets the Audit cache for inline strings.
|
protected BoundedCache |
getAuditInlineStringReferenceCache()
Gets the Audit cache for references to inline strings.
|
AttributeValue[] |
getAuditTypesForClass(String className,
boolean includeNested)
Gets the audit operation type values for a specified
class name, optionally including any types that are
applicable to a class that is considered a descendent of the
specified class.
|
AttributeValue[] |
getAuditTypesForCreateOperations()
Gets the audit operation type values that correspond to "CREATED"
operations.
|
AttributeValue[] |
getAuditTypesForFreeOperations()
Gets the audit operation type values that correspond to "FREE" operations.
|
S_DirectoryUser |
getAuthenticatedUser()
Gets the S_DirectoryUser for which this S_LibrarySession was
authenticated.
|
Long |
getAuthenticatedUserId()
Gets the id of the S_DirectoryUser for which this S_LibrarySession
was authenticated.
|
protected String |
getAuthenticatedUserName()
Gets the name of the S_DirectoryUser for which this S_LibrarySession
was authenticated.
|
protected long |
getBeansVersionNumber()
Gets the beans-side version number, as a long.
|
protected String |
getBeansVersionString()
Gets the beans-side version number, as a string.
|
protected Long[] |
getCachedAllAncestorIds()
Gets the cached set of all IDs of ancestor groups (direct or indirect)
for this user.
|
Collection |
getClassAccessControlListCollection()
Gets a reference to the ClassAccessControlList collection.
|
Collection |
getClassDomainCollection()
Gets a reference to the S_ClassDomain collection.
|
protected String |
getClassName(Long classid)
Gets the name of the S_ClassObject for the specified class id.
|
S_ClassObject |
getClassObject(Long classid)
Gets the S_ClassObject for the specified class id.
|
S_ClassObject |
getClassObjectByName(String className)
Returns a class object given a class name, throwing an exception
if not found.
|
S_ClassObject |
getClassObjectByName(String className,
boolean enforce)
Returns a class object given a class name, optionally returning null
if not found.
|
Collection |
getClassObjectCollection()
Gets a reference to the S_ClassObject collection.
|
AttributeValue |
getClassObjectValueByName(String name)
Gets an AttributeValue representation of a CLASSOBJECT that has the
specified name.
|
Long |
getClockOffset()
Gets the clock offset, representing the number of milliseconds the
DBMS clock is ahead of this mid tier.
|
protected Long |
getComponentAclsAttributeId()
Returns the ID of the Attribute object for the
AccessControlList.ComponentAcls attribute.
|
protected ContentStorageManager |
getContentStorageManager()
Gets the ContentStorageManager for this S_LibrarySession.
|
Date |
getCurrentDate()
Gets the current Date, with the clock offset applied.
|
long |
getCurrentTimeMillis()
Gets the current time in milliseconds, with the clock offset applied.
|
AttributeValue[] |
getCustomAuditTypes()
Gets the custom audit operation type values.
|
protected S_LibraryObjectData |
getDataInstance(long selectClassId,
S_ClassObjectData classData,
S_LibraryObjectData[] selectAttributeDatas,
ResultSet rset)
Gets an S_LibraryObjectData based on the specified ResultSet.
|
protected S_LibraryObjectData |
getDataInstance(long selectClassId,
S_ClassObjectData classData,
S_LibraryObjectData[] selectAttributeDatas,
ResultSet rset,
int rsetStartIndex)
Gets an S_LibraryObjectData based on the specified ResultSet.
|
S_ContentQuota |
getDefaultContentQuota()
Gets the default ContentQuota to be used when creating new content
|
String |
getDefaultFolderRelationshipClassname()
Deprecated.
CM SDK 10g: no replacement functionality; FolderPathRelationship
is now used as the class name
|
S_DirectoryObject |
getDirectoryObject(Long id)
Gets an S_DirectoryObject by id.
|
S_DirectoryObject |
getDirectoryObject(Long id,
Long classId)
Gets an S_DirectoryObject by id and classId.
|
DirectoryObjectInterface |
getDirectoryObjectInterface(Long id)
Gets the DirectoryObjectInterface for the specified id.
|
DirectoryObjectInterface[] |
getDirectoryObjectInterfaces(Long[] ids)
Gets the DirectoryObjectInterfaces for the specified ids.
|
DirectoryService |
getDirectoryService()
Gets the DirectoryService of the S_LibraryService of this
S_LibrarySession.
|
Collection |
getDirectoryUserCollection()
Gets a reference to the DirectoryUser collection.
|
protected Long[] |
getDiscoverabilityOfPublicObjectsIds(Long[] ids)
Return indication as to which PublicObject objects specified (by ID) the
current user can discover.
|
protected String |
getDistinguishedUserName()
Gets the distinguished name of the current S_DirectoryUser for
this S_LibrarySession.
|
S_PropertyBundle |
getDomainPropertyBundle()
Gets the domain PropertyBundle.
|
AttributeValue |
getDomainPropertyValue(String name)
Gets the value of a domain property, by name.
|
protected String |
getEncryptedRepositoryParameter(String name)
Gets the value of the specified repository parameter.
|
Collection |
getExtendedPermissionCollection()
Gets a reference to the S_ExtendedPermission collection.
|
Collection |
getExtendedUserProfileCollection()
Gets a reference to the S_ExtendedUserProfile collection for
this S_LibrarySessions user.
|
String |
getFolderPathDelimiter()
Gets the Folder Path Delimiter for this session
|
Collection |
getFormatCollection()
Gets a reference to the S_Format collection, organized by name.
|
Collection |
getFormatExtensionCollection()
Gets a reference to the S_Format collection, organized by extension.
|
long |
getHighestAuditId()
Get the highest Audit Id in use.
|
Long |
getId()
Gets the id of this S_LibrarySession.
|
Long |
getIdForNewObject(S_LibraryObjectDefinition def)
Gets the next available id value.
|
IfsConnection |
getIfsConnection()
Returns an IfsConnection for this S_LibrarySession.
|
protected static PreparedStatement |
getInvalidateTokenCredentialsStatement(LibraryConnection lconn,
Connection conn)
Gets the PreparedStatement to invalidate user's token credentials
|
protected long |
getLastOperationTime()
Gets the time at which
setLastOperationTime was last
invoked. |
LibraryConnection |
getLibraryConnection()
Gets the LibraryConnection for this S_LibrarySession.
|
S_LibraryObject |
getLibraryObject(Long id,
Long classId)
Gets an S_LibraryObject by id and classId.
|
S_LibraryObject |
getLibraryObject(Long id,
String className)
Gets an S_LibraryObject by id and classobject name.
|
S_LibraryObject |
getLibraryObject(S_LibraryObjectData data)
Gets an S_LibraryObject by S_LibraryObjectData.
|
LibraryObjectCache |
getLibraryObjectCache()
Return a reference to the LibaryObject cache.
|
CachePerformance |
getLibraryObjectCachePerformance()
Gets the cache performance object for the S_LibraryObject cache.
|
protected S_LibraryObjectData |
getLibraryObjectData(Long id,
Long classId,
String attributeName,
boolean selectFully)
Gets the S_LibraryObjectData for the specified id and class id.
|
Vector |
getLibraryObjectDataVector(S_LibraryObject[] objs)
Gets the S_LibraryObjectDatas for the specified S_LibraryObjects.
|
S_LibraryObject[] |
getLibraryObjects(Vector vData)
Get the S_LibraryObjects for the specified S_LibraryObjectDatas.
|
LibrarySession |
getLibrarySession()
Gets the bean-side session context
|
Localizer |
getLocalizer()
Gets the Localizer of this S_LibrarySession.
|
Long |
getLowestCommonClassObjectIdAncestor(SimpleObjectInterface[] mos)
Gets the lowest common S_ClassObject ancestor for the specified array
of SimpleObjectInterface, excluding tableless ClassObjects.
|
AttributeValue |
getMapTypeAttributeValue(int dataType,
long objectId,
long attrIdVal,
int count)
Gets a fully resolved map-type AttributeValue with non-transient
elements that is a copy of the specified map-type AttributeValue.
|
static AttributeValue |
getMapTypeAttributeValue(int dataType,
long objectId,
long attrIdVal,
S_LibrarySession session,
LibraryConnection lconn,
Connection conn)
Gets a fully resolved map-type AttributeValue with non-transient
elements that is a copy of the specified array-type AttributeValue.
|
Collection |
getMediaCollection()
Gets a reference to the Media collection.
|
int |
getMemberThreshold()
Gets the threshold for using a temp table to select all (recursive) members
of a group.
|
protected static PreparedStatement |
getNextSequenceQueryStatement(LibraryConnection lconn,
Connection conn)
Gets the PreparedStatement to get the next available id value.
|
protected String |
getNLSDatabaseParameterValue(String parameter)
Gets the value for the specified NLS database parameter.
|
protected OperationDriver |
getOperationDriver()
Gets the OperationDriver instance in use by the in-progress
operation (if any).
|
Collection |
getPermissionBundleCollection()
Gets a reference to the S_PermissionBundle collection.
|
protected PolicyAction |
getPolicyAction(String className)
Finds a PolicyAction specified by fully-qualified classname,
as kept by the service.
|
Collection |
getPolicyCollection()
Gets a reference to the S_Policy collection.
|
Collection |
getPolicyListCollection()
Gets a reference to the S_PolicyList collection.
|
S_PrimaryUserProfile |
getPrimaryUserProfile()
Gets the S_PrimaryUserProfile of current S_DirectoryUser for
this S_LibrarySession.
|
S_PublicObject |
getPublicObject(Long id)
Gets an S_PublicObject by id.
|
S_PublicObject |
getPublicObject(Long id,
Long classId)
Gets an S_PublicObject by id and classId.
|
PublicObjectInterface |
getPublicObjectInterface(Long id)
Gets the PublicObjectInterface for the specified id.
|
PublicObjectInterface[] |
getPublicObjectInterfaces(Long[] ids)
Gets the PublicObjectInterfaces for the specified ids.
|
protected Vector |
getPublicObjectsByIds(Long[] ids)
Gets a set of S_PublicObjects from a set of IDs.
|
protected String |
getRepositoryParameter(String name)
Gets the value of the specified repository parameter.
|
protected String[] |
getRepositoryParameterNames(String prefix)
Gets the repository parameter names that start with the specified prefix.
|
String |
getResourceString(String key)
Gets the resource string for the specified key.
|
String |
getResourceString(String key,
Object[] params)
Gets the resource string for the specified key, and substitutes the
specified parameters into that resource string.
|
S_Folder |
getRootFolder()
Return the top-most Folder in the CM SDK folder hierarchy.
|
String |
getSchemaName()
Gets the schema name in effect for the service.
|
S_SchemaObject |
getSchemaObject(Long id)
Gets an S_SchemaObject by id.
|
S_SchemaObject |
getSchemaObject(Long id,
Long classId)
Gets an S_SchemaObject by id and classId.
|
SchemaObjectInterface |
getSchemaObjectInterface(Long id)
Gets the SchemaObjectInterface for the specified id.
|
SchemaObjectInterface[] |
getSchemaObjectInterfaces(Long[] ids)
Gets the SchemaObjectInterfaces for the specified ids.
|
protected Vector |
getSchemaObjectsByIds(Long[] ids)
Gets a set of S_SchemaObjects from a set of IDs.
|
S_LibraryService |
getService()
Gets the S_LibraryService hosting this S_LibrarySession.
|
AttributeValue |
getServiceConfigurationProperty(String name)
Gets the specified service configuration property.
|
boolean |
getServiceConfigurationProperty(String name,
boolean defaultValue)
Gets the value of the specified service configuration property,
as a boolean.
|
int |
getServiceConfigurationProperty(String name,
int defaultValue)
Gets the value of the specified service configuration property,
as an integer.
|
String |
getServiceConfigurationProperty(String name,
String defaultValue)
Gets the value of the specified service configuration property,
as a string.
|
Long |
getServiceId()
Gets the id of the S_LibraryService hosting this S_LibrarySession.
|
protected long |
getSessionCreationTime()
Gets the time at which this session was created.
|
Long |
getSessionId()
Gets the id of this S_LibrarySession.
|
String |
getSessionIdentifier()
Gets a session identifier.
|
protected S_LibraryObjectDataSharedStateFactory |
getSharedStateFactory()
Returns the Shared State factory in effect for the domain.
|
S_SimpleObject |
getSimpleObject(Long id)
Gets an S_SimpleObject by id.
|
S_SimpleObject |
getSimpleObject(Long id,
Long classId)
Gets an S_SimpleObject by id and classId.
|
SimpleObjectInterface |
getSimpleObjectInterface(Long id,
Long classId)
Gets the SimpleObjectInterface for the specified id.
|
SimpleObjectInterface[] |
getSimpleObjectInterfaces(Long[] ids)
Gets the SimpleObjectInterfaces for the specified ids.
|
SimpleObjectInterface[] |
getSimpleObjectInterfaces(Long[] ids,
Long primaryClassId)
Gets the SimpleObjectInterfaces for the specified ids.
|
protected Vector |
getSimpleObjectsByIds(Long[] ids)
Gets a set of S_SimpleObjects from a set of IDs.
|
protected Statement |
getStatementInProgress()
Return the current JDBC statement in progress on this session.
|
Collection |
getSystemAccessControlListCollection()
Gets a reference to the SystemAccessControlList collection.
|
Collection |
getSystemLockObjectCollection()
Gets a reference to the SystemLockObject collection.
|
S_SystemObject |
getSystemObject(Long id)
Gets an S_SystemObject by id.
|
S_SystemObject |
getSystemObject(Long id,
Long classId)
Gets an S_SystemObject by id and classId.
|
SystemObjectInterface |
getSystemObjectInterface(Long id)
Gets the SystemObjectInterface for the specified id.
|
SystemObjectInterface[] |
getSystemObjectInterfaces(Long[] ids)
Gets the SystemObjectInterfaces for the specified ids.
|
protected Vector |
getSystemObjectsByIds(Long[] ids)
Gets a set of S_SystemObjects from a set of IDs.
|
TraceLogger |
getTraceLogger()
Gets the trace logger of this session.
|
CachePerformance |
getUncommittedLibraryObjectDataCachePerformance()
Gets the cache performance object for the uncommitted
S_LibraryObjectData cache.
|
CachePerformance |
getUncommittedResolvedAclCachePerformance()
Gets the cache performance object for the uncommitted
Resolved ACL cache.
|
S_DirectoryUser |
getUser()
Gets the current S_DirectoryUser for this S_LibrarySession.
|
Long |
getUserId()
Gets the id of the current S_DirectoryUser for this S_LibrarySession.
|
String |
getUserIdentifier()
Return the identifer for the user associated with the current session.
|
protected String |
getUserName()
Gets the name of the current S_DirectoryUser for this S_LibrarySession.
|
protected S_UserState |
getUserState()
Gets the user state of the current S_DirectoryUser for
this S_LibrarySession.
|
Collection |
getValueDefaultCollection()
Gets a reference to the S_ValueDefault collection.
|
Collection |
getValueDomainCollection()
Gets a reference to the S_ValueDomain collection.
|
static AttributeValue |
getValueFromResultSet(ResultSet rset,
int position,
int datatype,
Long attributeId,
long objectId)
Gets the value of the specified bind variable in a ResultSet.
|
static AttributeValue |
getValueFromResultSet(ResultSet rset,
int position,
int datatype,
Long attributeId,
long auditid,
long objectId)
Deprecated.
9.2.5.0.0 use other variant
|
static AttributeValue |
getValueFromResultSet(ResultSet rset,
int position,
int datatype,
Long attributeId,
long auditid,
long objectId,
S_AttributeData attrData,
S_LibrarySession session)
Deprecated.
9.2.5.0.0 use other variant
|
static AttributeValue |
getValueFromResultSet(ResultSet rset,
int position,
int datatype,
Long attributeId,
long objectId,
S_AttributeData attrData,
S_LibrarySession session)
Gets the value of the specified select position in a ResultSet.
|
protected S_Selector |
getWastebasketSelector(String searchClass,
String searchDefinition,
boolean recursive)
Constructs a wastebasket S_Selector.
|
void |
handleEvent(IfsEvent event)
Handles the specified event.
|
protected void |
insertIntoSessionTable(Long user)
Add this S_LibrarySession into the odmz_session table.
|
protected void |
interrupt()
Interrupt the session.
|
void |
invalidateTokenCredentials(Long userId)
Invalidates any previously-created TokenCredential for the specified
user.
|
protected Serializable |
invokeServerMethod(Object obj,
String methodName,
Serializable payload)
Invokes a DYN method on the specified object.
|
protected boolean |
isAccessCheckMode()
Gets the access check mode for the session.
|
protected boolean |
isAdministrationDiscoverMode()
Gets whether this S_LibrarySession is in discover administration mode,
either because that mode was explicitly set or implicitly because the
session is in adminstration mode.
|
protected boolean |
isAdministrationDiscoverStateEnabled()
Gets whether this S_LibrarySession has been explicitly placed in
discover administration mode.
|
boolean |
isAdministrationMode()
Gets whether this S_LibrarySession is in administration mode.
|
protected boolean |
isAlwaysCacheSelectedData()
Gets whether the current session always caches
selected data from Selectors.
|
boolean |
isArrayInputsUsedForAncestorSelection()
Gets whether to use array inputs for selecting "all ancestors"
if size has exceeded threshhold.
|
boolean |
isArrayInputsUsedForMemberSelection()
Gets whether to use array inputs for selecting "all members"
if size has exceeded threshhold.
|
boolean |
isCompositeAclSupported()
See if the instance property indicates that composite ACLs are supported.
|
boolean |
isExecutionMode(int mode)
Gets whether this S_LibrarySession is in at least the specified
execution mode.
|
protected boolean |
isFilterDeletedObjectsEnabled()
Deprecated.
iFS 9.0.3 always returns false
|
protected boolean |
isFullTextIndexingEnabled()
Gets whether full-text indexing is enabled.
|
protected boolean |
isInstallationMode()
Gets whether this S_LibrarySession is in installation mode.
|
protected boolean |
isInstanceOfClassVersionable(Long classId)
Gets whether an instance of the specified S_ClassObject is versionable.
|
protected boolean |
isInterrupted()
Return true if this session has been interrupted,
either explicitly or as a result of a timeout.
|
protected boolean |
isMarkedDirty(Long id)
Detects whether the specified item ID is marked dirty in any
uncommitted frame.
|
boolean |
isOwnerHasReadSupported()
See if the instance property indicates that tracking
whether an Owner of a Document has read it is supported.
|
protected boolean |
isPartitioningEnabled()
checks whether or not partitioning is being used in this
instnace.
|
boolean |
isPolicyMode()
Gets whether this S_LibrarySession is in policy mode.
|
protected boolean |
isSessionTimeoutPrevented()
Gets whether session timeouts are prevented.
|
protected boolean |
isStatementInProgressCancelled()
Return true if there's a JDBC statement in progress and
it has been cancelled, either explicitly or as a result of a
timeout.
|
boolean |
isSystemAdministrationMode()
Gets whether this S_LibrarySession is in system administration mode.
|
boolean |
isTraced(int channel,
int level)
Gets whether tracing is enabled for the specified channel and level.
|
protected boolean |
isTransactionInProgress()
Gets whether there is a transaction in-progress.
|
boolean |
isUpgradeInProgress()
See if the session behaves as though an upgrade is in progress.
|
protected boolean |
isWriteableTransactionInProgress()
Gets whether there is a writeable transaction in-progress.
|
protected Vector |
listWastebasketSelectorItems(String searchClass,
String searchDefinition,
boolean recursive,
SortSpecification sort)
Constructs a wastebasket S_Selector and gets its items.
|
String |
lookupAuditEventOperationTypeKey(int opType)
Looks up an audit event operation type key by its numeric value,
returning the string key.
|
String[] |
lookupAuditEventOperationTypeKeys(int[] opTypes)
Looks up audit event operation type keys by their numeric values,
returning the string keys.
|
int[] |
lookupAuditEventOperationTypes(String[] opTypeKeys)
Looks up audit event operation types by their string key,
returning the corresponding numeric equivalents.
|
AuditTargetCode |
lookupAuditTargetCode(String className)
Looks up an audit target code structure from the specified Class name or
other registered alias for the desired type.
|
ContentStreamSerializer |
newContentStreamSerializer()
Constructs and returns a ContentStreamSerializer appropriate to
the runtime process model.
|
protected S_LibraryObject |
newLibraryObject(OperationState opState,
S_LibraryObjectDefinition def)
Creates a new S_LibraryObject based on the specified
S_LibraryObjectDefinition within an OperationState
context.
|
protected S_LibraryObject |
newLibraryObject(S_LibraryObjectDefinition def)
Creates a new S_LibraryObject based on the specified
S_LibraryObjectDefinition.
|
S_PublicObject |
newPublicObject(OperationState opState,
S_LibraryObjectDefinition def)
Creates a new S_PublicObject based on the specified
S_LibraryObjectDefinition within the specified OperationState
context.
|
S_PublicObject |
newPublicObject(S_LibraryObjectDefinition def)
Creates a new S_PublicObject based on the specified
S_LibraryObjectDefinition.
|
S_SchemaObject |
newSchemaObject(OperationState opState,
S_LibraryObjectDefinition def)
Creates a new S_SchemaObject based on the specified
S_LibraryObjectDefinition within the specified OperationState
context.
|
S_SchemaObject |
newSchemaObject(S_LibraryObjectDefinition def)
Creates a new S_SchemaObject based on the specified
S_LibraryObjectDefinition.
|
S_SimpleObject |
newSimpleObject(OperationState opState,
S_LibraryObjectDefinition def)
Creates a new S_SimpleObject based on the specified
S_LibraryObjectDefinition within the specified OperationState
context.
|
S_SimpleObject |
newSimpleObject(S_LibraryObjectDefinition def)
Creates a new S_SimpleObject based on the specified
S_LibraryObjectDefinition.
|
S_SystemObject |
newSystemObject(OperationState opState,
S_LibraryObjectDefinition def)
Creates a new S_SystemObject based on the specified
S_LibraryObjectDefinition within the specified OperationState
context.
|
S_SystemObject |
newSystemObject(S_LibraryObjectDefinition def)
Creates a new S_SystemObject based on the specified
S_LibraryObjectDefinition.
|
protected void |
notifyUncommittedDataCacheEnabled()
Notifies this S_LibrarySession that its uncommitted data cache has
been enabled.
|
protected void |
popSessionState()
Deprecated.
iFS 10.0 use
popTemporaryExecutionMode() |
void |
popTemporaryAccessCheckMode()
Resets any temporary access check mode back to the previous temporary
access check mode.
|
void |
popTemporaryExecutionMode()
Resets any temporary execution state back to the previous temporary
execution mode.
|
void |
postAuditEvent(AuditEvent event,
int mode)
Create an audit event.
|
protected void |
postAuditEventsUponCommit(LibraryConnection lconn,
Connection conn,
List rawEventList)
Create audit events as a result of a normal completeTransaction
occurring.
|
protected void |
postEvent(IfsEvent event)
Post the specified event.
|
protected void |
postFailedAuditEventsUponRollback(LibraryConnection lconn,
Connection conn,
List rawEventList)
Post failed audit events as a result of an abortTransaction.
|
void |
pushDiscoverAdministrationMode(boolean adminDiscoverMode)
Sets whether this S_LibrarySession is in discover administration mode.
|
protected void |
pushSessionState(boolean adminDiscoverMode)
Deprecated.
iFS 10.0 use
pushTemporaryExecutionMode(EXECUTIONMODE_DISCOVERYADMINISTRATION) |
void |
pushTemporaryAccessCheckMode(boolean mode)
Establishes a temporary access check mode for the session.
|
void |
pushTemporaryExecutionMode(int executionMode)
Establishes a temporary execution mode for the session.
|
protected void |
putPolicyAction(String className,
PolicyAction pa)
Caches a PolicyAction specified by fully-qualified classname,
managed by the service.
|
protected void |
queueEventForProcessing(IfsEvent event)
Queues the specified event for processing by this S_LibrarySession.
|
boolean |
reauthenticate(Credential credential,
ConnectOptions options)
Reauthenticates the DIRECTORYUSER for which this S_LibrarySession
was created (this is the DIRECTORYUSER returned by the method
getAuthenticatedUser ). |
protected void |
recacheObject(S_LibraryObject obj)
Re-cache the specified object.
|
int |
registerAuditEventOperationType(String opTypeKey,
int targetCode,
String targetClass,
int opCode,
Boolean createOrFree)
Register a new event type.
|
void |
registerClassEventHandler(S_ClassObject co,
boolean includeSubclasses,
IfsEventHandler handler)
Registers the specified IfsEventHandler to receive events for
all objects in the specified class.
|
void |
registerCollection(Collection collection,
String classname)
Registers a Collection so that it can be automatically reset
by handleEvent as needed when new S_LibraryObjects are created,
updated, or freed.
|
int |
registerCustomAuditEventOperationCodeKey(String opCodeKey)
Register a new custom operation code key.
|
void |
registerEventHandler(S_LibraryObject lo,
IfsEventHandler handler)
Registers the specified IfsEventHandler to receive events for the
specified S_LibraryObject.
|
void |
releaseAuxiliaryConnection(Connection conn)
Releases an auxiliary Connection previously acquired by this
LibrarySession.
|
void |
releaseAuxiliaryLibraryConnection(LibraryConnection lconn)
Releases an auxiliary LibraryConnection previously acquired by this
LibrarySession.
|
void |
removeAuditEvents(long[] eventIds,
String tableName)
Remove audit events.
|
void |
removeAuditEventsForTarget(Long specId,
Long targetId)
Free audit events from a specific Audit history, by target ID.
|
protected void |
removeLibraryObjectCursor(long cursorId)
Removes a S_LibraryObjectCursor.
|
protected void |
removeLibraryObjectCursor(S_LibraryObjectCursor cursor)
Removes a S_LibraryObjectCursor.
|
protected void |
removeLockedForSessionObject(Long objid)
Removes the specified S_PublicObject from this S_LibrarySession's
internal table of session-locked objects.
|
protected void |
removeLockedForSessionObject(S_PublicObject obj)
Removes the specified S_PublicObject from this S_LibrarySession's
internal table of session-locked objects.
|
protected void |
removeSSelector(long selId)
Removes the specified S_Selector from the set of S_Selectors for
this S_LibrarySession.
|
protected void |
removeSSelector(S_Selector sel)
Removes the specified S_Selector from the set of S_Selectors for
this S_LibrarySession.
|
protected void |
resetUserState()
Force user state to get reset or initialized for the
first time
|
protected String |
resolveSelectorWhereclause(String searchClass,
String searchDefinition,
boolean recursive)
Adds a "classid = n" expression to the specified S_Selector
WHERE clause, if appropriate.
|
void |
rollback()
Discards all pending changes for all in-progress Transactions for this
S_LibrarySession.
|
protected void |
scheduleRawAuditEvent(AuditExecutor.PreparedRawAuditEvent rawEvent,
int postMode)
Schedule an event with the transaction manager, to be posted with the
AuditExecutor upon complete or abort of the current transaction.
|
AttributeValue[] |
selectAggregateAuditEventColumns(Long auditSpec,
String aggFunction,
String[] columnNames,
String[] innerColNames,
String filterClause,
String sortClause)
Returns the list of distinct values of the specified AuditEvent columns,
along with an optional aggregate function.
|
AuditEvent[] |
selectAuditEvents(Long auditSpec,
String filterClause,
AttributeValue[] bindValues,
String sortClause,
int maxItems)
Select audit events.
|
AuditEvent[] |
selectAuditEvents(Long auditSpec,
String filterClause,
String sortClause,
int maxItems)
Select audit events.
|
protected AuditFolderPath |
selectLatestAuditFolderPath(Long folderId)
Select the latest AuditFolderPath for a folder.
|
AuditFolderPath |
selectSpecificAuditFolderPath(long folderPathId)
Select the specific AuditFolderPath for a given primary key.
|
ArrayList |
selectUnusedAuditTypeLists(long expirationPeriod)
Select any unreferenced Audit type lists.
|
protected void |
setApplicationName(String name)
Sets the name of the application that created this session.
|
protected void |
setCachedAllAncestorIds(Long[] ancestorIds)
Sets the cached set of all IDs of ancestor groups (direct or indirect)
for this user.
|
protected void |
setDirectoryUser(S_DirectoryUser user)
Sets the S_DirectoryUser of this S_LibrarySession.
|
protected void |
setEncryptedRepositoryParameter(String name,
String value)
Sets the value of the specified repository parameter.
|
protected void |
setLastOperationTime()
Provides a watchdog timer for this S_LibrarySession.
|
protected void |
setRepositoryParameter(String name,
String value)
Sets the value of the specified repository parameter.
|
protected void |
setSpecifiedInsertColumns(AttributeValue[] avs,
S_ClassObjectData classData,
int position_offset,
PreparedStatement stmt)
Sets the specified bind variables of the specified INSERT statement for
the specified classobject.
|
void |
setValueInStatement(PreparedStatement stmt,
AttributeValue av,
int position,
int datatype)
Sets a bind variable in the specified PreparedStatement,
coercing the datatype as necessary.
|
void |
setValueInStatement(PreparedStatement stmt,
AttributeValue av,
int position,
int datatype,
int datalength)
Sets a bind variable in the specified PreparedStatement,
coercing the datatype as necessary.
|
void |
trace(int channel,
int level,
String payload)
Issues a trace request to the trace logger.
|
void |
unregisterAuditEventOperationType(String opTypeKey)
Unregister an event type.
|
protected boolean |
usesSecureSqlSyntax(String whereclause)
Gets whether the specified WHERE clause references secured
database objects in the CM SDK schema.
|
protected void |
verifyAdminEnabled()
Verifies that this S_LibrarySession can enter administration mode.
|
void |
verifyAdministrationMode()
Verify that the effective execution mode for the session is
at least administration mode.
|
void |
verifyConnected()
Asserts that this S_LibrarySession is connected.
|
protected S_DirectoryObject |
verifyDirectoryObject(S_LibraryObject obj)
Verifies that the specified S_LibraryObject is an S_DirectoryObject.
|
void |
verifyExecutionMode(int mode)
Verify that the effective execution mode for the session is
at least the mode specified.
|
protected void |
verifyHasLegalSyntax(String searchDefinition)
Ensures the specified WHERE clause does not reference secured
database objects, unless in at least administration discover mode.
|
protected void |
verifyHasSelectorAccess(String classname)
Verifies that the specified classobject has ACCESSLEVEL_SELECTORACCESS.
|
protected void |
verifyInstallationMode()
Verify that the effective execution mode for the session is
at least installation mode.
|
protected void |
verifyInstallEnabled()
Verifies that this S_LibrarySession can enter installation mode.
|
protected void |
verifyNotInterrupted()
Return true if this session has been interrupted,
either explicitly or as a result of a timeout.
|
protected S_PublicObject |
verifyPublicObject(S_LibraryObject obj)
Verifies that the specified S_LibraryObject is an S_PublicObject.
|
protected S_SchemaObject |
verifySchemaObject(S_LibraryObject obj)
Verifies that the specified S_LibraryObject is an S_SchemaObject.
|
protected S_SimpleObject |
verifySimpleObject(S_LibraryObject obj)
Verifies that the specified S_LibraryObject is an S_SimpleObject.
|
protected void |
verifySystemAdminEnabled()
Verifies that this S_LibrarySession can enter system administration mode.
|
void |
verifySystemAdministrationMode()
Verify that the effective execution mode for the session is
at least system administration mode.
|
protected S_SystemObject |
verifySystemObject(S_LibraryObject obj)
Verifies that the specified S_LibraryObject is an S_SystemObject.
|
protected Long m_Id
protected LibrarySession m_LibrarySession
protected String m_ClientVersionString
protected long m_ClientVersionNumber
protected S_LibraryService m_Service
protected long m_SessionCreationTime
protected String m_ApplicationName
protected Hashtable m_AuxiliaryConnections
protected Hashtable m_LockedForSessionObjects
protected long m_LastOperationTime
protected oracle.ifs.server.S_LibrarySessionTransactionManager m_TransactionManager
protected OperationDriver m_OperationDriver
protected UncommittedLibraryObjectDataCache m_UncommittedLibraryObjectDataCache
protected UncommittedResolvedAclCache m_UncommittedResolvedAclCache
protected Boolean m_IsContextEnabled
protected oracle.ifs.server.S_LibraryServiceEventExchanger m_ServiceEventExchanger
protected S_LibraryObjectDataSharedStateFactory m_SharedStateFactory
protected Long m_PublicObjectClassId
protected Long m_SchemaObjectClassId
protected Long m_SystemObjectClassId
protected Long m_DirectoryObjectClassId
protected Long m_SimpleObjectClassId
protected S_DirectoryUser m_User
protected String m_UserName
protected S_DirectoryUser m_FeignedUser
protected String m_FeignedUserName
protected Long m_FeignedUserId
protected S_PrimaryUserProfile m_PrimaryUserProfile
protected S_UserState m_UserState
protected S_PropertyBundle m_DomainPropertyBundle
protected S_Folder m_RootFolder
protected Stack m_SessionStateStack
protected int m_ExecutionMode
LibrarySessionInterface
protected int m_TemporaryExecutionMode
This can be expanded as a result of pushTemporaryExecutionMode(), either directly (as in the case of enabling Admin discover mode) or as a result of the OperationDriver enabling a privileged state for a policy-driven operation. A value of EXECUTIONMODE_PREEXISTING (numerical value 0) indicates that there is no temporary execution mode in effect, and that the normal mode of the session is in effect.
protected boolean m_TemporyDiscoveredAclsEnabled
protected HashMap m_TemporyDiscoveredAcls
protected Stack m_AccessCheckModeStack
protected boolean m_AccessCheckMode
protected Localizer m_Localizer
protected String m_FolderPathDelimiter
protected S_ContentQuota m_DefaultContentQuota
protected boolean m_PreventSessionTimeouts
protected boolean m_AlwaysCacheSelectedData
protected boolean m_EventProcessingEnabled
protected oracle.ifs.server.S_LibrarySession.Fifo m_EventsQueuedForProcessing
protected Hashtable m_RegisteredEventHandlers
protected Hashtable m_RegisteredClassEventHandlers
protected Statement m_StatementInProgress
protected boolean m_StatementInProgressCancelled
protected boolean m_Interrupted
protected boolean m_Cancelled
protected boolean m_PolicyMode
protected HashMap m_SelectorMap
protected Hashtable m_SSelectors
protected long m_SSelectorSequence
protected Hashtable m_Cursors
protected Hashtable m_SearchCursors
protected long m_CursorSequence
protected Long m_ComponentAclsAttributeId
protected Long[] m_AllAncestorIds
protected S_LibrarySession(S_LibraryService service) throws IfsException
service
- the serviceIfsException
- if the operation failsprotected void setDirectoryUser(S_DirectoryUser user) throws IfsException
This is invoked immediately after successful authentication.
user
- the userIfsException
- if the operation failspublic void DMDisconnect() throws IfsException
DMDisconnect
in interface S_LibrarySessionInterface
IfsException
- if the operation failsprotected final void disconnect()
This method terminates the session with extreme prejudice. All thrown Exceptions are ignored.
This method should only be called by LibrarySession.disconnect().
protected void insertIntoSessionTable(Long user) throws IfsException
user
- the id of the authenticating S_DirectoryUserIfsException
- if the operation failspublic final void verifyConnected() throws IfsException
IfsException
- (IFS-21000) if the session is not connectedpublic boolean isUpgradeInProgress() throws IfsException
Indicates the default setting (stored as a domain property) if not explicitly set on the session.
When this behavior is set to true, operations performed on behalf of that session differ from those occuring on normal sessions in the following ways:
IfsException
- if operation fails.public boolean isCompositeAclSupported() throws IfsException
IfsException
- if operation fails.public boolean isOwnerHasReadSupported() throws IfsException
IfsException
- if operation fails.public Long DMGetSessionId() throws IfsException
DMGetSessionId
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic Long getId() throws IfsException
IfsException
- if the operation failspublic Long getSessionId() throws IfsException
IfsException
- if the operation failsprotected ContentStorageManager getContentStorageManager()
public String getUserIdentifier()
getUserIdentifier
in interface LogInfo
public String getSessionIdentifier()
getSessionIdentifier
in interface LogInfo
public S_LibraryService getService() throws IfsException
IfsException
- if the operation failspublic Long DMGetServiceId() throws IfsException
DMGetServiceId
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic String DMGetSchemaName() throws IfsException
DMGetSchemaName
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic Long DMGetClockOffset() throws IfsException
DMGetClockOffset
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic Long getServiceId() throws IfsException
IfsException
- if the operation failspublic String getSchemaName() throws IfsException
IfsException
- if the operation failspublic Long getClockOffset() throws IfsException
IfsException
- if the operation failspublic long getCurrentTimeMillis() throws IfsException
Will return the value from System.currentTimeMillis
with an offset applied equal to the number of milliseconds the DBMS clock
is ahead of the mid tier.
IfsException
- if the operation failspublic Date getCurrentDate() throws IfsException
Will return a Date value constructed from
System.currentTimeMillis
with an offset applied equal to
the number of milliseconds the DBMS clock is ahead of the mid tier.
IfsException
- if the operation failsprotected long getSessionCreationTime() throws IfsException
IfsException
- if the operation failsprotected String getApplicationName() throws IfsException
The application name is specified by the ConnectOptions passed
to LibraryService.connect
. The value is not used
internally; it is purely informational.
IfsException
- if the operation failsprotected void setApplicationName(String name) throws IfsException
The application name is specified by the ConnectOptions passed
to LibraryService.connect
. The value is not used
internally; it is purely informational.
name
- the application nameIfsException
- if the operation failspublic long DMGetAttributesRsn() throws IfsException
DMGetAttributesRsn
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic String DMVersionString() throws IfsException
DMVersionString
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic long DMVersionNumber() throws IfsException
DMVersionNumber
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic String DMSchemaVersionString() throws IfsException
DMSchemaVersionString
in interface S_LibrarySessionInterface
IfsException
- (IFS-20001) if the operation failspublic long DMSchemaVersionNumber() throws IfsException
DMSchemaVersionNumber
in interface S_LibrarySessionInterface
IfsException
- (IFS-20001) if the operation failspublic String DMGetNLSDatabaseParameterValue(String parameter) throws IfsException
DMGetNLSDatabaseParameterValue
in interface S_LibrarySessionInterface
IfsException
- if the operation failsprotected final String getNLSDatabaseParameterValue(String parameter) throws IfsException
parameter
- the parameterIfsException
- if the operation failspublic S_LibraryObjectData DMCreateDefaultPropertyBundle(Long id, Long classId) throws IfsException
DMCreateDefaultPropertyBundle
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic S_LibraryObjectData DMCreateDefaultPolicyPropertyBundle(Long id, Long classId) throws IfsException
DMCreateDefaultPolicyPropertyBundle
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic void DMSendClientVersionInformation(long versionNumber, String versionString) throws IfsException
DMSendClientVersionInformation
in interface S_LibrarySessionInterface
versionNumber
- the LibrarySession version numberversionString
- the LibrarySession version stringIfsException
- if the operation failsprotected String getBeansVersionString() throws IfsException
IfsException
- if the operation failsprotected long getBeansVersionNumber() throws IfsException
IfsException
- if the operation failspublic void DMSetApplicationName(String name) throws IfsException
DMSetApplicationName
in interface S_LibrarySessionInterface
name
- the application nameIfsException
- if the operation failspublic void DMSetLibrarySession(LibrarySession session) throws IfsException
DMSetLibrarySession
in interface S_LibrarySessionInterface
session
- the LibrarySessionIfsException
- if the operation failspublic LibrarySession getLibrarySession()
public final Localizer getLocalizer() throws IfsException
getLocalizer
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final String getFolderPathDelimiter() throws IfsException
IfsException
- if the operation failspublic S_Folder getRootFolder() throws IfsException
IfsException
- if operation fails.public final S_ContentQuota getDefaultContentQuota() throws IfsException
IfsException
- if the operation failspublic final void DMUpdateLocalizer(Hashtable properties) throws IfsException
DMUpdateLocalizer
in interface S_LibrarySessionInterface
properties
- the Localizer propertiesIfsException
- if the operation failspublic String getDefaultFolderRelationshipClassname() throws IfsException
IfsException
- if operation fails.public final void DMUpdateSessionDefaults(Hashtable properties) throws IfsException
DMUpdateSessionDefaults
in interface S_LibrarySessionInterface
properties
- the preferences, hashed by nameIfsException
- if the operation failspublic String getResourceString(String key) throws IfsException
The method looks-up the key in each extended resource bundle. If no extended resource bundle contains the key, the default resource bundle (LibraryResources) is used.
key
- the resource bundle keyIfsException
- IFS-12001 if the operation failspublic String getResourceString(String key, Object[] params) throws IfsException
The method looks-up the key using getResourceString(key)
.
Next, java.text.MessageFormat
is used to substitute the
parameters specified by params
into the key's value. If
a string element of params
is delimited by brackets, i.e.
"{param}
", then that element is replaced with the
value returned by getResourceString("param")
before
being passed to MessageFormat
.
key
- the resource bundle keyparams
- an array of Objects to be substituted into
the resource bundle message using using
java.text.MessageFormat
IfsException
- IFS-12006 if the operation failspublic LibraryObjectCache getLibraryObjectCache()
protected void recacheObject(S_LibraryObject obj) throws IfsException
obj
- the objectIfsException
- if the operation failspublic AttributeValue getServiceConfigurationProperty(String name) throws IfsException
name
- the property nameIfsException
- (IFS-20004) if the operation failspublic String getServiceConfigurationProperty(String name, String defaultValue) throws IfsException
name
- the property namedefaultValue
- the default valueIfsException
- (IFS-20004) if the operation failspublic boolean getServiceConfigurationProperty(String name, boolean defaultValue) throws IfsException
name
- the property namedefaultValue
- the default valueIfsException
- (IFS-20004) if the operation failspublic int getServiceConfigurationProperty(String name, int defaultValue) throws IfsException
name
- the property namedefaultValue
- the default valueIfsException
- (IFS-20004) if the operation failspublic final Hashtable DMGetServiceConfigurationProperties()
DMGetServiceConfigurationProperties
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic String[] DMGetRepositoryParameterNames(String prefix) throws IfsException
DMGetRepositoryParameterNames
in interface S_LibrarySessionInterface
prefix
- the prefix with which repository parameter names
must start to be returned; if null or zero-length,
all repository parameter names are returnedIfsException
- if the operation failsprotected String[] getRepositoryParameterNames(String prefix) throws IfsException
prefix
- the prefix with which repository parameter names
must start to be returned; if null or zero-length,
all repository parameter names are returnedIfsException
- if the operation failspublic String DMGetRepositoryParameter(String name) throws IfsException
DMGetRepositoryParameter
in interface S_LibrarySessionInterface
name
- the parameter nameIfsException
- if the operation failsprotected String getRepositoryParameter(String name) throws IfsException
name
- the parameter nameIfsException
- if the operation failspublic void DMSetRepositoryParameter(String name, String value) throws IfsException
DMSetRepositoryParameter
in interface S_LibrarySessionInterface
name
- the parameter namevalue
- the parameter valueIfsException
- if the operation failsprotected void setRepositoryParameter(String name, String value) throws IfsException
name
- the parameter namevalue
- the parameter valueIfsException
- if the operation failspublic void DMDeleteRepositoryParameter(String name) throws IfsException
DMDeleteRepositoryParameter
in interface S_LibrarySessionInterface
name
- the parameter nameIfsException
- if the operation failsprotected void deleteRepositoryParameter(String name) throws IfsException
name
- the parameter nameIfsException
- if the operation failspublic String DMGetEncryptedRepositoryParameter(String name) throws IfsException
The specified repository parameter's value is stored encrypted.
DMGetEncryptedRepositoryParameter
in interface S_LibrarySessionInterface
name
- the parameter nameIfsException
- if the operation failsprotected String getEncryptedRepositoryParameter(String name) throws IfsException
The specified repository parameter's value is stored encrypted.
name
- the parameter nameIfsException
- if the operation failspublic void DMSetEncryptedRepositoryParameter(String name, String value) throws IfsException
The specified repository parameter's value is stored encrypted.
DMSetEncryptedRepositoryParameter
in interface S_LibrarySessionInterface
name
- the parameter namevalue
- the parameter value, up to 127 charactersIfsException
- if the operation failsprotected void setEncryptedRepositoryParameter(String name, String value) throws IfsException
The specified repository parameter's value is stored encrypted.
name
- the parameter namevalue
- the parameter value, up to 127 charactersIfsException
- if the operation failspublic Serializable DMInvokeServerMethod(Long id, Long classId, String methodName, Serializable payload) throws IfsException
DMInvokeServerMethod
in interface S_LibrarySessionInterface
id
- the id of the S_LibraryObject on which to
operate, or null for S_LibrarySessionclassId
- the class id of the S_LibraryObject on which
to operate, or null for S_LibrarySessionmethodName
- the name of the method to invokepayload
- the parameter valueIfsException
- if the operation failspublic Object DMInvokeOperation(Long id, Long classId, OperationContext op) throws IfsException
DMInvokeOperation
in interface S_LibrarySessionInterface
id
- the id of the S_LibraryObject on which to
operateclassId
- the class id of the S_LibraryObject on which
to operateop
- the operation specificationIfsException
- if the operation failsprotected Serializable invokeServerMethod(Object obj, String methodName, Serializable payload) throws IfsException
obj
- the object on which to operatemethodName
- the name of the method to invokepayload
- the parameter valueIfsException
- if the operation failsprotected final void setLastOperationTime() throws IfsException
This method is invoked by each DMFoo to capture the time that this S_LibrarySession was last active. If any S_LibrarySession falls idle for more than a service properties-file specified period, it is disconnected.
IfsException
- (IFS-21000) if the session has been disconnectedprotected final long getLastOperationTime()
setLastOperationTime
was last
invoked.protected final boolean isSessionTimeoutPrevented()
protected final boolean isAlwaysCacheSelectedData()
public S_DirectoryUser getAuthenticatedUser() throws IfsException
IfsException
- if the operation failspublic Long getAuthenticatedUserId() throws IfsException
IfsException
- if the operation failsprotected String getAuthenticatedUserName() throws IfsException
IfsException
- if the operation failspublic S_DirectoryUser getUser() throws IfsException
This is the same as the authenticated user, unless a "feign user" operation has been performed.
IfsException
- if the operation failspublic Long getUserId() throws IfsException
IfsException
- if the operation failsprotected String getUserName() throws IfsException
IfsException
- if the operation failsprotected String getDistinguishedUserName() throws IfsException
IfsException
- if the operation failsprotected S_UserState getUserState() throws IfsException
IfsException
- if the operation failsprotected void resetUserState() throws IfsException
IfsException
- if the operation failspublic S_LibraryObjectData DMGetDirectoryUserData() throws IfsException
DMGetDirectoryUserData
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic S_LibraryObjectData DMGetOurPrimaryUserProfile() throws IfsException
DMGetOurPrimaryUserProfile
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic S_PrimaryUserProfile getPrimaryUserProfile() throws IfsException
IfsException
- if the operation failspublic void DMFeignUser(Long id, Long classid) throws IfsException
This makes this S_LibrarySession behave as though it were for the impersonated user, even though a different user was originally authenticated.
DMFeignUser
in interface S_LibrarySessionInterface
id
- the id of the user impersonate, or null to return
to the authenticated userclassid
- the class id of the user to impersonate, or null
to return to the authenticated userIfsException
- if the operation failspublic void DMSetExecutionMode(int mode) throws IfsException
DMSetExecutionMode
in interface S_LibrarySessionInterface
mode
- the desired execution modeIfsException
- if the operation failspublic boolean DMIsExecutionMode(int mode) throws IfsException
DMIsExecutionMode
in interface S_LibrarySessionInterface
mode
- specified mode being checkedIfsException
- if the operation failspublic final boolean isExecutionMode(int mode) throws IfsException
mode
- specified mode being checkedIfsException
- if the operation failsprotected boolean isAdministrationDiscoverMode() throws IfsException
IfsException
- if the operation failspublic final boolean isAdministrationMode() throws IfsException
IfsException
- if the operation failspublic final boolean isSystemAdministrationMode() throws IfsException
IfsException
- if the operation failsprotected final boolean isInstallationMode() throws IfsException
IfsException
- if the operation failspublic void verifyExecutionMode(int mode) throws IfsException
Throw an exception otherwise.
IfsException
- if not in at least the mode specifiedpublic void verifyAdministrationMode() throws IfsException
IfsException
- (IFS-21051) if not in administration modepublic void verifySystemAdministrationMode() throws IfsException
IfsException
- (IFS-21051) if not in system administration modeprotected void verifyInstallationMode() throws IfsException
IfsException
- (IFS-21051) if not in installation modeprotected final void verifyInstallEnabled() throws IfsException
IfsException
- (IFS-21050) if cannot enter installation modeprotected final void verifyAdminEnabled() throws IfsException
IfsException
- (IFS-21050) if cannot enter administration modeprotected final void verifySystemAdminEnabled() throws IfsException
IfsException
- (IFS-21050) if cannot enter system administration modeprotected boolean isAdministrationDiscoverStateEnabled() throws IfsException
IfsException
- if the operation failsprotected boolean isFilterDeletedObjectsEnabled() throws IfsException
IfsException
- if the operation failspublic void DMFilterDeletedObjects(boolean mode) throws IfsException
DMFilterDeletedObjects
in interface S_LibrarySessionInterface
mode
- whether the session filters out deleted objectsIfsException
- if the operation failspublic void DMPushTemporaryAccessCheckMode(boolean mode)
pushTemporaryAccessCheckMode
.
NOTE: this method intentionally deviates from the standard DMFoo pattern.
DMPushTemporaryAccessCheckMode
in interface S_LibrarySessionInterface
mode
- new temporary access check mode; false indicates that
access checks are disabled; true indicates that
they are enabled (the normal mode for the session)public void DMPopTemporaryAccessCheckMode()
popTemporaryAccessCheckMode
.
NOTE: this method intentionally deviates from the standard DMFoo pattern.
DMPopTemporaryAccessCheckMode
in interface S_LibrarySessionInterface
public void pushTemporaryAccessCheckMode(boolean mode)
The caller must guarantee that popTemporaryAccessCheckMode
is called to clear this temporary access check mode once it is
no longer needed, typically in try/finally blocks.
mode
- new temporary access check mode; false indicates that
access checks are disabled; true indicates that
they are enabled (the normal mode for the session)public void popTemporaryAccessCheckMode()
protected final boolean isAccessCheckMode()
Normally this returns true, but can be overridden temporarily
via pushTemporaryAccessCheckMode
IfsException
- if the operation failspublic void DMPushTemporaryExecutionMode(int mode)
NOTE: this method intentionally deviates from the standard DMFoo pattern.
DMPushTemporaryExecutionMode
in interface S_LibrarySessionInterface
mode
- the new temporary modepublic void DMPopTemporaryExecutionMode()
NOTE: this method intentionally deviates from the standard DMFoo pattern.
DMPopTemporaryExecutionMode
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic void pushDiscoverAdministrationMode(boolean adminDiscoverMode) throws IfsException
Equivalent to:
pushTemporaryExecutionMode(adminDiscoverMode)
adminDiscoverMode
- whether the session can discover any object
regardless of its ACLIfsException
- if the operation failsprotected void pushSessionState(boolean adminDiscoverMode)
pushTemporaryExecutionMode(EXECUTIONMODE_DISCOVERYADMINISTRATION)
Equivalent to pushTemporaryExecutionMode(EXECUTIONMODE_DISCOVERYADMINISTRATION)
adminDiscoverMode
- whether the session can discover any object
regardless of its ACLpublic void pushTemporaryExecutionMode(int executionMode)
The caller must guarantee that popTemporaryExecutionMode()
is called to clear this temprary execution mode once it is
no longer needed.
If the specified mode is less than the regular mode of the session, any previous temporary execution mode is cancelled.
executionMode
- new temporary execution modeprotected void popSessionState()
popTemporaryExecutionMode()
pushTemporaryExecutionMode
.
public void popTemporaryExecutionMode()
protected void forceOriginalSessionState()
public boolean isPolicyMode() throws IfsException
IfsException
- if the operation failsprotected S_LibraryObjectSelector addSelectorToHashMap(Long classId) throws IfsException
classId
- the id of the classobject of interestIfsException
- if the operation failsprotected S_LibraryObjectSelector findSelectorInCache(Long classId) throws IfsException
classId
- the class id of interestIfsException
- if the operation failspublic S_LibraryObjectSelector findSelectorInCache(String className) throws IfsException
className
- the class nameIfsException
- if the operation failspublic Vector DMListSelectorItems(String searchClass, String searchDefinition, boolean recursive, int maxItemCount, SortSpecification sort) throws IfsException
DMListSelectorItems
in interface S_LibrarySessionInterface
searchClass
- the classobject to searchsearchDefinition
- the WHERE clauserecursive
- whether to search subclasses of
searchClass
sort
- the sort orderIfsException
- if the operation failspublic long DMGetSelectorItemCount(String searchClass, String searchDefinition, boolean recursive) throws IfsException
DMGetSelectorItemCount
in interface S_LibrarySessionInterface
searchClass
- the classobject to searchsearchDefinition
- the WHERE clauserecursive
- whether to search subclasses of
searchClass
IfsException
- if the operation failspublic long DMOpenSelector(String searchClass, String searchDefinition, boolean recursive, SortSpecification sort) throws IfsException
DMOpenSelector
in interface S_LibrarySessionInterface
searchClass
- the classobject to searchsearchDefinition
- the WHERE clauserecursive
- whether to search subclasses of
searchClass
sort
- the sort orderIfsException
- if the operation failspublic S_LibraryObjectData DMNextSelectorItem(long selId) throws IfsException
DMNextSelectorItem
in interface S_LibrarySessionInterface
selId
- the selector sequenceIfsException
- if the operation failspublic Vector DMNextSelectorBatch(long selId, int batchSize) throws IfsException
DMNextSelectorBatch
in interface S_LibrarySessionInterface
selId
- the selector sequencebatchSize
- the maximum number of items to getIfsException
- if the operation failspublic void DMCloseSelector(long selId) throws IfsException
DMCloseSelector
in interface S_LibrarySessionInterface
selId
- the selector sequenceIfsException
- if the operation failspublic Vector DMListPreparedSelectorItems(String statementKey, boolean distinct, AttributeValue searchTarget, AttributeValue[] auxSearchTargets, String[] bypassSecAliases, String joinCondition, String searchDefinition, boolean recursive, String language, int maxItemCount, int rowNumber, String hint, SortSpecification sort, AttributeValue[] bindValues) throws IfsException
DMListPreparedSelectorItems
in interface S_LibrarySessionInterface
statementKey
- the key to use for the prepared Selectordistinct
- whether to search using "distinct" clausesearchTarget
- the primary search targetauxSearchTargets
- the auxiliary search targetsbypassSecAliases
- the aliases that indicates bypassing security for POsjoinCondition
- the JOIN conditionsearchDefinition
- the WHERE clauserecursive
- whether to search subclasses of
searchClass
language
- the search language to usemaxItemCount
- the maximum number of items to returnrowNumber
- the starting row number for the returned resultshint
- SQL hint for the main selectsort
- the sort orderbindValues
- the bind valuesIfsException
- if the operation failspublic AttributeValueTable[] DMGetPreparedSelectorResults(String statementKey, boolean distinct, AttributeValue searchTarget, AttributeValue[] auxSearchTargets, ColumnDescriptor[] colDescs, String[] bypassSecAliases, String joinCondition, String searchDefinition, boolean recursive, String language, int maxItemCount, int rowNumber, String hint, SortSpecification sort, AttributeValue[] bindValues) throws IfsException
DMGetPreparedSelectorResults
in interface S_LibrarySessionInterface
statementKey
- the key to use for the prepared Selectordistinct
- whether to search using "distinct" clausesearchTarget
- the primary search targetauxSearchTargets
- the auxiliary search targetscolDescs
- the columns to select, which will appear in the resultsbypassSecAliases
- the aliases that indicates bypassing security for POsjoinCondition
- the JOIN conditionsearchDefinition
- the WHERE clauserecursive
- whether to search subclasses of
searchClass
language
- the search language to usemaxItemCount
- the maximum number of items to returnrowNumber
- the starting row number for the returned resultshint
- SQL hint for the main selectsort
- the sort orderbindValues
- the bind valuesIfsException
- if the operation failspublic int DMGetPreparedSelectorItemCount(String statementKey, boolean distinct, AttributeValue searchTarget, AttributeValue[] auxSearchTargets, String[] bypassSecAliases, String joinCondition, String searchDefinition, boolean recursive, String hint, AttributeValue[] bindValues) throws IfsException
DMGetPreparedSelectorItemCount
in interface S_LibrarySessionInterface
statementKey
- the key to use for the prepared Selectordistinct
- whether to search using "distinct" clausesearchTarget
- the primary search targetauxSearchTargets
- the auxiliary search targetsbypassSecAliases
- the aliases that indicates bypassing security for POsjoinCondition
- the JOIN conditionsearchDefinition
- the WHERE clauserecursive
- whether to search subclasses of
searchClass
hint
- SQL hint to use for the main selectbindValues
- the bind valuesIfsException
- if the operation failsprotected void verifyHasSelectorAccess(String classname) throws IfsException
classname
- the name of the classobjectIfsException
- if the operation failsprotected void addSSelector(S_Selector sel)
sel
- the selectorprotected S_Selector findSSelector(long selId) throws IfsException
selId
- the selector sequenceIfsException
- if the operation failsprotected void removeSSelector(long selId)
selId
- the selector sequenceprotected void removeSSelector(S_Selector sel)
sel
- the selectorprotected String resolveSelectorWhereclause(String searchClass, String searchDefinition, boolean recursive) throws IfsException
searchClass
- the name of the classobjectsearchDefinition
- the existing WHERE clauserecursive
- whether to include subclasses of
searchClass
IfsException
- if the operation failsprotected boolean isPartitioningEnabled() throws IfsException
IfsException
- if the operation failspublic Long DMNewSearch() throws IfsException
DMNewSearch
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic Long DMNewSearchFromObject(Long searchObjectId) throws IfsException
DMNewSearchFromObject
in interface S_LibrarySessionInterface
searchObjectId
- the id of the S_SearchObjectIfsException
- if the operation failspublic SearchSpecification DMGetSearchSpecification(Long srchId) throws IfsException
DMGetSearchSpecification
in interface S_LibrarySessionInterface
srchId
- the cursor sequence identifying the S_SearchIfsException
- if the operation failspublic void DMSetSearchSpecification(Long srchId, SearchSpecification sp) throws IfsException
DMSetSearchSpecification
in interface S_LibrarySessionInterface
srchId
- the cursor sequence identifying the S_SearchIfsException
- if the operation failspublic void DMOpenSearch(Long srchId, Vector bindValues, String language, int timeout) throws IfsException
DMOpenSearch
in interface S_LibrarySessionInterface
srchId
- the cursor sequence identifying the S_SearchbindValues
- the bind valueslanguage
- the language to be used for searchIfsException
- if the operation failspublic int DMgetSearchItemCount(Long srchId, Vector bindValues, String language, int timeout) throws IfsException
DMgetSearchItemCount
in interface S_LibrarySessionInterface
srchId
- the cursor sequence identifying the S_SearchbindValues
- the bind valueslanguage
- the language to be used for searchIfsException
- if the operation failspublic String DMgetSearchSQLString(Long srchId) throws IfsException
DMgetSearchSQLString
in interface S_LibrarySessionInterface
srchId
- the cursor sequence identifying the S_SearchIfsException
- if the operation failspublic Vector DMNextSearchItems(Long srchId, int batchCount) throws IfsException
DMNextSearchItems
in interface S_LibrarySessionInterface
srchId
- the cursor sequence identifying the S_SearchbatchCount
- the maximum number of items to getIfsException
- if the operation failspublic void DMCloseSearch(Long srchId) throws IfsException
DMCloseSearch
in interface S_LibrarySessionInterface
srchId
- the cursor sequence identifying the S_SearchIfsException
- if the operation failspublic void DMDisposeSearch(Long srchId) throws IfsException
DMDisposeSearch
in interface S_LibrarySessionInterface
srchId
- the cursor sequence identifying the S_SearchIfsException
- if the operation failspublic void DMCreateView(ViewSpecification vsp) throws IfsException
DMCreateView
in interface S_LibrarySessionInterface
vsp
- the ViewSpecificationIfsException
- if the operation failspublic Serializable DYNExplainPlan(Serializable payload) throws IfsException
payload
- a Hashtable that holds the cursor sequence of the
S_Search, bind values, plan name, plan table name,
and whether to clear the plan tableIfsException
- if the operation failspublic void registerCollection(Collection collection, String classname) throws IfsException
collection
- the collection to registerclassname
- the classobject name corresponding to the Java
classname specified at collection constructionIfsException
- if the operation failspublic void deregisterCollection(Collection collection, String classname) throws IfsException
collection
- the collection itselfclassname
- the classname corresponding to the ClassObject
name specified at collection constructionIfsException
- if the operation failspublic final Collection getClassObjectCollection() throws IfsException
getClassObjectCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final S_ClassObject getClassObjectByName(String className) throws IfsException
This uses the ClassObjectCollection and is simply a convenience method.
className
- the name of a classIfsException
- if the operation failspublic final S_ClassObject getClassObjectByName(String className, boolean enforce) throws IfsException
This uses the ClassObjectCollection and is simply a convenience method.
className
- the name of a classenforce
- if true, throw an exception if not found;
if false, return null if not foundIfsException
- if the operation failspublic AttributeValue getClassObjectValueByName(String name) throws IfsException
getClassObjectValueByName
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final S_ClassObjectData findClassData(String className) throws IfsException
className
- the name of a classIfsException
- if the operation failspublic final Collection getClassDomainCollection() throws IfsException
getClassDomainCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getValueDefaultCollection() throws IfsException
getValueDefaultCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getValueDomainCollection() throws IfsException
getValueDomainCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getPolicyCollection() throws IfsException
getPolicyCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getPolicyListCollection() throws IfsException
IfsException
- if the operation failspublic final Collection getPermissionBundleCollection() throws IfsException
getPermissionBundleCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getExtendedPermissionCollection() throws IfsException
getExtendedPermissionCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getExtendedUserProfileCollection() throws IfsException
getExtendedUserProfileCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getFormatCollection() throws IfsException
getFormatCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getFormatExtensionCollection() throws IfsException
getFormatExtensionCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getMediaCollection() throws IfsException
getMediaCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getSystemAccessControlListCollection() throws IfsException
getSystemAccessControlListCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getSystemLockObjectCollection() throws IfsException
IfsException
- if the operation failspublic final Collection getClassAccessControlListCollection() throws IfsException
getClassAccessControlListCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getDirectoryUserCollection() throws IfsException
getDirectoryUserCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final AttributeValue getDomainPropertyValue(String name) throws IfsException
name
- the property nameIfsException
- if the operation failspublic final S_PropertyBundle getDomainPropertyBundle() throws IfsException
IfsException
- if the operation failspublic AttributeValue DMGetArrayTypeAttributeValue(long objectId, long attributeId, Long priClassId, int count) throws IfsException
This method is invoked when a bean-side array-type AttributeValue needs to obtains its elements from the server.
DMGetArrayTypeAttributeValue
in interface S_LibrarySessionInterface
objectId
- The LibraryObject ID.attributeId
- The Attribute id.priClassId
- The primary Class IDcount
- the number of elements in the AttributeValueIfsException
- if the operation failspublic AttributeValue getArrayTypeAttributeValue(AttributeValueArray av, long objectId, long attributeId, Long priClassId, int count) throws IfsException
For internal use only. Do not use this method.
The invoker of this method sucks the elements from the returned object, plugs them into the corresponding cached AttributeValue, and then discards the returned object.
getArrayTypeAttributeValue
in interface LibrarySessionInterface
av
- the AttributeValue of interestobjectId
- The LibraryObject ID.attributeId
- The Attribute id.priClassId
- The primary Class IDcount
- the number of elements in the AttributeValueIfsException
- if the operation failspublic static AttributeValue getArrayTypeAttributeValue(AttributeValueArray av, long objectId, long attributeId, Long priClassId, S_LibrarySession session, LibraryConnection lconn, Connection conn) throws IfsException
For internal use only. Do not use this method.
The invoker of this method sucks the elements from the returned object, plugs them into the corresponding cached AttributeValue, and then discards the returned object.
av
- the AttributeValue of interestobjectId
- The LibraryObject ID.attributeId
- The Attribute id.priClassId
- The primary Class IDsession
- the session, or null if not called from session
contextlconn
- the LibraryConnection, or null if not called
from session contextconn
- the JDBC connectionIfsException
- if the operation failsprotected Object[] getArrayAttributeValueEntries(int dataType, AttributeValue av) throws IfsException
For internal use only. Do not use this method.
There are two users of this method. S_LibraryObject uses this to get the primitive array of values used to create the rows in the array tables. S_LibrarySession uses this method to create system audit entry properties that are of array datatypes.
dataType
- the dataType of the expected valuesav
- the AttributeValue of interestIfsException
- if the operation failspublic AttributeValue DMGetMapTypeAttributeValue(int dataType, long objectId, long attrIdVal, int count) throws IfsException
This method is invoked when a bean-side map-type AttributeValue needs to obtains its elements from the server.
DMGetMapTypeAttributeValue
in interface S_LibrarySessionInterface
dataType
- the AttributeValue's data typeobjectId
- the ID of the LibraryObject for which
this AttributeValue represents the value
of one of its AttributesattrIdVal
- the ID value of the Attributecount
- the number of elements in the AttributeValueIfsException
- if the operation failspublic AttributeValue getMapTypeAttributeValue(int dataType, long objectId, long attrIdVal, int count) throws IfsException
For internal use only. Do not use this method.
The invoker of this method sucks the elements from the returned object, plugs them into the corresponding cached AttributeValue, and then discards the returned object.
getMapTypeAttributeValue
in interface LibrarySessionInterface
dataType
- the AttributeValue's data typeobjectId
- the ID of the LibraryObject for which
this AttributeValue represents the value
of one of its AttributesattrIdVal
- the ID value of the Attributecount
- the number of elements in the AttributeValueIfsException
- if the operation failspublic static AttributeValue getMapTypeAttributeValue(int dataType, long objectId, long attrIdVal, S_LibrarySession session, LibraryConnection lconn, Connection conn) throws IfsException
For internal use only. Do not use this method.
The invoker of this method sucks the elements from the returned object, plugs them into the corresponding cached AttributeValue, and then discards the returned object.
dataType
- the AttributeValue's data typeobjectId
- the ID of the LibraryObject for which
this AttributeValue represents the value
of one of its AttributesattrIdVal
- the ID value of the Attributesession
- session, or null if not called from session contextlconn
- the LibraryConnection, or null if not called
from session contextconn
- the JDBC connectionIfsException
- if the operation failspublic Serializable DMGetObjectReferenceAttribute(Long id, Long classId, String attrName) throws IfsException
DMGetObjectReferenceAttribute
in interface S_LibrarySessionInterface
id
- the id of the objectclassId
- the class id of the objectattrName
- the name of the attributeIfsException
- if the operation failspublic Vector DMGetArrayReferencingObjects(Long attributeId, AttributeValue referencedValue, SortSpecification sort) throws IfsException
DMGetArrayReferencingObjects
in interface S_LibrarySessionInterface
attributeId
- the id of the array-type AttributereferencedValue
- the referenced valuesort
- how the referencing objects will be sortedIfsException
- if the operation failspublic S_LibraryObjectData DMgetLibraryObjectData(Long id, Long classId, String attributeName, boolean selectFully) throws IfsException
DMgetLibraryObjectData
in interface S_LibrarySessionInterface
id
- the id of interestclassId
- the id of the classattributeName
- if non-null, the returned data will be
selected at least as deeply as this attributeselectFully
- if true, the returned data will be fully
selected (i.e. as deep as possible)IfsException
- if the operation failsprotected S_LibraryObjectData getLibraryObjectData(Long id, Long classId, String attributeName, boolean selectFully) throws IfsException
id
- the id of interestclassId
- the id of the classattributeName
- if non-null, the returned data will be
selected at least as deeply as this attributeselectFully
- if true, the returned data will be fully
selected (i.e. as deep as possible)IfsException
- if the operation failsprotected final S_LibraryObjectData findLibraryObjectData(Long id) throws IfsException
id
- the id of interestIfsException
- if the operation failsprotected final boolean isMarkedDirty(Long id) throws IfsException
id
- the id of interestIfsException
- if the operation failsprotected S_LibraryObjectData constructLibraryObjectData(S_LibraryObjectSelector sel, Long id) throws IfsException
sel
- the selectorid
- the id of the objectIfsException
- if the operation failspublic S_LibraryObjectData DMGetPublicObjectData(Long id, Long classId) throws IfsException
DMGetPublicObjectData
in interface S_LibrarySessionInterface
id
- the id of interestclassId
- the classId of interestIfsException
- if the operation failspublic S_LibraryObjectData DMGetSystemObjectData(Long id, Long classId) throws IfsException
DMGetSystemObjectData
in interface S_LibrarySessionInterface
id
- the id of interestclassId
- the classId of interestIfsException
- if the operation failspublic S_LibraryObjectData DMGetSimpleObjectData(Long id, Long classId) throws IfsException
DMGetSimpleObjectData
in interface S_LibrarySessionInterface
id
- the id of interestclassId
- the classId of interestIfsException
- if the operation failspublic S_LibraryObjectData DMGetSchemaObjectData(Long id, Long classId) throws IfsException
DMGetSchemaObjectData
in interface S_LibrarySessionInterface
id
- the id of interestclassId
- the classId of interestIfsException
- if the operation failspublic void DMResolveObjects(Long[] ids, Long[] classIds, ObjectResolverSpecification spec) throws IfsException
DMResolveObjects
in interface S_LibrarySessionInterface
ids
- the ids for the objects of interestclassIds
- the classIds for the objects of interestspec
- the resolution specificationIfsException
- if the operation failspublic Vector getLibraryObjectDataVector(S_LibraryObject[] objs) throws IfsException
objs
- the objectsIfsException
- if the operation failspublic S_LibraryObject getLibraryObject(Long id, Long classId) throws IfsException
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_LibraryObject discoverLibraryObject(Long id, Long classId) throws IfsException
If unable to discover it because of security, return null instead of throwing an exception
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_LibraryObject discoverLibraryObject(Long id) throws IfsException
If unable to discover it because of security, return null instead of throwing an exception
id
- the idIfsException
- if the operation failspublic S_LibraryObject getLibraryObject(Long id, String className) throws IfsException
id
- the idclassName
- the name of the classobjectIfsException
- if the operation failspublic S_LibraryObject getLibraryObject(S_LibraryObjectData data) throws IfsException
data
- the dataIfsException
- if the operation failspublic S_LibraryObject[] getLibraryObjects(Vector vData) throws IfsException
vData
- a Vector of S_LibraryObjectDatasIfsException
- if the operation failsprotected Vector getPublicObjectsByIds(Long[] ids) throws IfsException
ids
- the idsIfsException
- if the operation failspublic Long[] DMGetDiscoverabilityOfPublicObjectsIds(Long[] ids) throws IfsException
The array specified contains the set of PublicObject IDs that are to be checked. A corresponding array is returned, which will be a clone of the one specified, with null values replaced for the IDs that correspond to objects the user cannot discover.
DMGetDiscoverabilityOfPublicObjectsIds
in interface S_LibrarySessionInterface
ids
- array of PublicObject IDsIfsException
- if the operation failsprotected Long[] getDiscoverabilityOfPublicObjectsIds(Long[] ids) throws IfsException
The array specified contains the set of PublicObject IDs that are to be checked. A corresponding array is returned, which will be a clone of the one specified, with null values replaced for the IDs that correspond to objects the user cannot discover.
ids
- array of PublicObject IDsIfsException
- if the operation failspublic S_PublicObject getPublicObject(Long id, Long classId) throws IfsException
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_PublicObject getPublicObject(Long id) throws IfsException
id
- the idIfsException
- if the operation failspublic S_PublicObject discoverPublicObject(Long id) throws IfsException
id
- the idIfsException
- if the operation failspublic S_SystemObject getSystemObject(Long id, Long classId) throws IfsException
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_SystemObject getSystemObject(Long id) throws IfsException
id
- the idIfsException
- if the operation failsprotected Vector getSystemObjectsByIds(Long[] ids) throws IfsException
ids
- the idsIfsException
- if the operation failspublic S_SimpleObject getSimpleObject(Long id, Long classId) throws IfsException
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_SimpleObject getSimpleObject(Long id) throws IfsException
id
- the idIfsException
- if the operation failsprotected Vector getSimpleObjectsByIds(Long[] ids) throws IfsException
ids
- the idsIfsException
- if the operation failspublic S_SchemaObject getSchemaObject(Long id, Long classId) throws IfsException
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_SchemaObject getSchemaObject(Long id) throws IfsException
id
- the idIfsException
- if the operation failsprotected Vector getSchemaObjectsByIds(Long[] ids) throws IfsException
ids
- the idsIfsException
- if the operation failspublic S_DirectoryObject getDirectoryObject(Long id, Long classId) throws IfsException
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_DirectoryObject getDirectoryObject(Long id) throws IfsException
id
- the idIfsException
- if the operation failspublic PublicObjectInterface getPublicObjectInterface(Long id) throws IfsException
getPublicObjectInterface
in interface LibrarySessionInterface
id
- the id of interestIfsException
- if the operation failspublic PublicObjectInterface[] getPublicObjectInterfaces(Long[] ids) throws IfsException
getPublicObjectInterfaces
in interface LibrarySessionInterface
ids
- the ids of interestIfsException
- if the operation failspublic SystemObjectInterface getSystemObjectInterface(Long id) throws IfsException
getSystemObjectInterface
in interface LibrarySessionInterface
id
- the id of interestIfsException
- if the operation failspublic SystemObjectInterface[] getSystemObjectInterfaces(Long[] ids) throws IfsException
getSystemObjectInterfaces
in interface LibrarySessionInterface
ids
- the ids of interestIfsException
- if the operation failspublic SimpleObjectInterface getSimpleObjectInterface(Long id, Long classId) throws IfsException
getSimpleObjectInterface
in interface LibrarySessionInterface
id
- the id of interestclassId
- the classId of interestIfsException
- if the operation failspublic SimpleObjectInterface[] getSimpleObjectInterfaces(Long[] ids) throws IfsException
getSimpleObjectInterfaces
in interface LibrarySessionInterface
ids
- the ids of interestIfsException
- if the operation failspublic SimpleObjectInterface[] getSimpleObjectInterfaces(Long[] ids, Long primaryClassId) throws IfsException
getSimpleObjectInterfaces
in interface LibrarySessionInterface
ids
- the ids of interestprimaryClassId
- the primary class IDIfsException
- if the operation failspublic Long getLowestCommonClassObjectIdAncestor(SimpleObjectInterface[] mos) throws IfsException
The class ID returned is null if all objects in the specified array are null. The class ID returned is zero if there is no common ancestor for the specified objects (at least one of which is non-null) that is non-tableless.
This is part of the LibrarySessionInterface.
getLowestCommonClassObjectIdAncestor
in interface LibrarySessionInterface
mos
- the SimpleObjectsIfsException
- if the operation failspublic SchemaObjectInterface getSchemaObjectInterface(Long id) throws IfsException
getSchemaObjectInterface
in interface LibrarySessionInterface
id
- the id of interestIfsException
- if the operation failspublic SchemaObjectInterface[] getSchemaObjectInterfaces(Long[] ids) throws IfsException
getSchemaObjectInterfaces
in interface LibrarySessionInterface
ids
- the ids of interestIfsException
- if the operation failspublic DirectoryObjectInterface getDirectoryObjectInterface(Long id) throws IfsException
getDirectoryObjectInterface
in interface LibrarySessionInterface
id
- the id of interestIfsException
- if the operation failspublic DirectoryObjectInterface[] getDirectoryObjectInterfaces(Long[] ids) throws IfsException
getDirectoryObjectInterfaces
in interface LibrarySessionInterface
ids
- the ids of interestIfsException
- if the operation failsprotected S_PublicObject verifyPublicObject(S_LibraryObject obj) throws IfsException
obj
- the object to test(IFS-30003)
- if the object is not an S_PublicObjectIfsException
protected S_SystemObject verifySystemObject(S_LibraryObject obj) throws IfsException
obj
- the object to test(IFS-30003)
- if the object is not an S_SystemObjectIfsException
protected S_SimpleObject verifySimpleObject(S_LibraryObject obj) throws IfsException
obj
- the object to test(IFS-30003)
- if the object is not an S_SimpleObjectIfsException
protected S_SchemaObject verifySchemaObject(S_LibraryObject obj) throws IfsException
obj
- the object to test(IFS-30003)
- if the object is not an S_SchemaObjectIfsException
protected S_DirectoryObject verifyDirectoryObject(S_LibraryObject obj) throws IfsException
obj
- the object to test(IFS-30003)
- if the object is not an S_DirectoryObjectIfsException
public S_LibraryObjectData DMNewPublicObject(S_LibraryObjectDefinition def) throws IfsException
DMNewPublicObject
in interface S_LibrarySessionInterface
def
- the definitionIfsException
- if the operation failspublic S_LibraryObjectData DMNewSystemObject(S_LibraryObjectDefinition def) throws IfsException
DMNewSystemObject
in interface S_LibrarySessionInterface
def
- the definitionIfsException
- if the operation failspublic S_LibraryObjectData DMNewSimpleObject(S_LibraryObjectDefinition def) throws IfsException
DMNewSimpleObject
in interface S_LibrarySessionInterface
def
- the definitionIfsException
- if the operation failspublic S_LibraryObjectData DMNewSchemaObject(S_LibraryObjectDefinition def) throws IfsException
DMNewSchemaObject
in interface S_LibrarySessionInterface
def
- the definitionIfsException
- if the operation failsprotected S_LibraryObject newLibraryObject(S_LibraryObjectDefinition def) throws IfsException
def
- the definitionIfsException
- if the operation failsprotected S_LibraryObject newLibraryObject(OperationState opState, S_LibraryObjectDefinition def) throws IfsException
opState
- the operation statedef
- the definitionIfsException
- if the operation failspublic S_PublicObject newPublicObject(S_LibraryObjectDefinition def) throws IfsException
def
- the definition for the new PublicObjectIfsException
- if the operation failspublic S_PublicObject newPublicObject(OperationState opState, S_LibraryObjectDefinition def) throws IfsException
If this isn't the originating operation (opState
is
non-null), the returned S_PublicObject will not have an ID until
the originating operation completes. For this reason, consider
using createPublicObjectInstance
, which returns an
AttributeValue, instead.
opState
- the operation statedef
- the definitionIfsException
- if the operation failspublic S_SystemObject newSystemObject(S_LibraryObjectDefinition def) throws IfsException
If this isn't the originating operation (opState
is
non-null), the returned S_SystemObject will not have an ID until
the originating operation completes. For this reason, consider
using createSystemObjectInstance
, which returns an
AttributeValue, instead.
def
- the definitionIfsException
- if the operation failspublic S_SystemObject newSystemObject(OperationState opState, S_LibraryObjectDefinition def) throws IfsException
opState
- the operation statedef
- the definitionIfsException
- if the operation failspublic S_SimpleObject newSimpleObject(S_LibraryObjectDefinition def) throws IfsException
If this isn't the originating operation (opState
is
non-null), the returned S_SimpleObject will not have an ID until
the originating operation completes. For this reason, consider
using createSimpleObjectInstance
, which returns an
AttributeValue, instead.
def
- the definitionIfsException
- if the operation failspublic S_SimpleObject newSimpleObject(OperationState opState, S_LibraryObjectDefinition def) throws IfsException
opState
- the operation statedef
- the definitionIfsException
- if the operation failspublic S_SchemaObject newSchemaObject(S_LibraryObjectDefinition def) throws IfsException
def
- the definitionIfsException
- if the operation failspublic S_SchemaObject newSchemaObject(OperationState opState, S_LibraryObjectDefinition def) throws IfsException
If this isn't the originating operation (opState
is
non-null), the returned S_SchemaObject will not have an ID until
the originating operation completes. For this reason, consider
using createSchemaObjectInstance
, which returns an
AttributeValue, instead.
opState
- the operation statedef
- the definitionIfsException
- if the operation failspublic AttributeValue createPublicObjectInstance(OperationState opState, S_LibraryObjectDefinition sdef) throws IfsException
This is identical to newPublicObject
,
except that the new object is returned as an
AttributeValue.
opState
- the operation statesdef
- the definitionIfsException
- if the operation failsprotected AttributeValue createVersionedPublicObjectInstance(OperationState opState, S_LibraryObjectDefinition sdef) throws IfsException
This is identical to createPublicObjectInstance
,
except that an exception is thrown if the new object would
not be versionable.
opState
- the operation statesdef
- the definitionIfsException
- if the operation failspublic AttributeValue createSystemObjectInstance(OperationState opState, S_LibraryObjectDefinition sdef) throws IfsException
This is identical to newSystemObject
,
except that the new object is returned as an
AttributeValue.
opState
- the operation statesdef
- the definitionIfsException
- if the operation failspublic AttributeValue createSimpleObjectInstance(OperationState opState, S_LibraryObjectDefinition sdef) throws IfsException
This is identical to newSimpleObject
,
except that the new object is returned as an
AttributeValue.
opState
- the operation statesdef
- the definitionIfsException
- if the operation failspublic AttributeValue createSchemaObjectInstance(OperationState opState, S_LibraryObjectDefinition sdef) throws IfsException
This is identical to newSchemaObject
,
except that the new object is returned as an
AttributeValue.
opState
- the operation statesdef
- the definitionIfsException
- if the operation failsprotected S_LibraryObject constructLibraryObject(S_LibraryObjectData data) throws IfsException
data
- the dataIfsException
- if the operation failsprotected S_LibraryObject constructLibraryObject(Long class_id) throws IfsException
class_id
- the class idIfsException
- if the operation failspublic S_LibraryObjectDefinition DMSetAttributes(Long id, Long classId, S_LibraryObjectDefinition def) throws IfsException
DMSetAttributes
in interface S_LibrarySessionInterface
id
- the idclassId
- the classIddef
- the definition describing the updateIfsException
- if the operation failspublic void DMLockRows(Long id, Long classId) throws IfsException
DMLockRows
in interface S_LibrarySessionInterface
id
- the idclassId
- the classIdIfsException
- if the operation failspublic void DMFree(Long id, Long classId, S_LibraryObjectDefinition def) throws IfsException
DMFree
in interface S_LibrarySessionInterface
id
- the idclassId
- the classIddef
- the definition describing the freeIfsException
- if the operation failspublic ContentStreamSerializer DMRender(Long id, Long classId, String rendererType, String rendererName, Hashtable options, boolean reader) throws IfsException
DMRender
in interface S_LibrarySessionInterface
id
- the idclassId
- the class idrendererType
- the type of the desired rendererrendererName
- the name of the desired rendereroptions
- any renderer-specific optionsIfsException
- (IFS-30110) if the operation failspublic S_LibraryObjectData DMCopyLibraryObject(Long id, Long classId, S_LibraryObjectDefinition sdef) throws IfsException
DMCopyLibraryObject
in interface S_LibrarySessionInterface
id
- the idclassId
- the classIdsdef
- the definition describing the copyIfsException
- if the operation failspublic S_LibraryObjectDefinition DMGetSLibraryObjectDefinition(Long id, Long classId) throws IfsException
DMGetSLibraryObjectDefinition
in interface S_LibrarySessionInterface
id
- the idclassId
- the classIdIfsException
- if the operation failspublic Long[] DMGetIdsForNewObjects(int length) throws IfsException
DMGetIdsForNewObjects
in interface S_LibrarySessionInterface
length
- the number of ids to returnIfsException
- if the operation failspublic final S_ClassObject getClassObject(Long classid) throws IfsException
Do not use.
classid
- the class idIfsException
- if the operation failsprotected final String getClassName(Long classid) throws IfsException
Do not use.
classid
- the class idIfsException
- if the operation failspublic boolean DMIsInstanceOfClassVersionable(Long classId) throws IfsException
DMIsInstanceOfClassVersionable
in interface S_LibrarySessionInterface
classId
- the class id of interestIfsException
- if the operation failsprotected boolean isInstanceOfClassVersionable(Long classId) throws IfsException
classId
- the class id of interestIfsException
- if the operation failspublic Long DMAddAttributeToClassObject(Long id, S_LibraryObjectDefinition def) throws IfsException
DMAddAttributeToClassObject
in interface S_LibrarySessionInterface
id
- the id of the existing classobjectdef
- the definition of the new attributeIfsException
- (IFS-30820) if the operation failspublic void DMRemoveAttributeFromClassObject(Long id, S_LibraryObjectDefinition def) throws IfsException
DMRemoveAttributeFromClassObject
in interface S_LibrarySessionInterface
id
- the id of the attributedef
- a definition that influences how the attribute is
removed, or null for default behaviorIfsException
- (IFS-30821) if the operation failspublic String getAttributeSortName(String classname, String attributename) throws IfsException
getAttributeSortName
in interface LibrarySessionInterface
classname
- the name of the classobjectattributename
- the name of the attributeIfsException
- if the operation failspublic S_ClassObjectData DMGetResolvedClassObjectData(Long id) throws IfsException
DMGetResolvedClassObjectData
in interface S_LibrarySessionInterface
id
- the idIfsException
- if the operation failspublic boolean DMIsVersionable(Long id, Long classId) throws IfsException
DMIsVersionable
in interface S_LibrarySessionInterface
id
- the idclassId
- the classIdIfsException
- if the operation failspublic void DMDelete(Long id, Long classId, S_LibraryObjectDefinition def) throws IfsException
DMDelete
in interface S_LibrarySessionInterface
id
- the idclassId
- the class iddef
- the definition objectIfsException
- if the operation failspublic void DMUndelete(Long id, Long classId, S_LibraryObjectDefinition def) throws IfsException
DMUndelete
in interface S_LibrarySessionInterface
id
- the idclassId
- the class iddef
- the definition objectIfsException
- if the operation failsprotected S_Selector getWastebasketSelector(String searchClass, String searchDefinition, boolean recursive) throws IfsException
searchClass
- the classobject to search, e.g. FOLDERsearchDefinition
- the WHERE clauserecursive
- whether to search subclasses of
searchClass
IfsException
- if the operation failspublic Vector DMListWastebasketSelectorItems(String searchClass, String searchDefinition, boolean recursive, SortSpecification sort) throws IfsException
DMListWastebasketSelectorItems
in interface S_LibrarySessionInterface
searchClass
- the classobject to search, e.g. FOLDERsearchDefinition
- the WHERE clauserecursive
- whether to search subclasses of
searchClass
sort
- the sort orderIfsException
- if the operation failsprotected Vector listWastebasketSelectorItems(String searchClass, String searchDefinition, boolean recursive, SortSpecification sort) throws IfsException
searchClass
- the classobject to search, e.g. FOLDERsearchDefinition
- the WHERE clauserecursive
- whether to search subclasses of
searchClass
sort
- the sort orderIfsException
- if the operation failspublic long DMGetWastebasketSelectorItemCount(String searchClass, String searchDefinition, boolean recursive) throws IfsException
DMGetWastebasketSelectorItemCount
in interface S_LibrarySessionInterface
searchClass
- the classobject to search, e.g. FOLDERsearchDefinition
- the WHERE clauserecursive
- whether to search subclasses of
searchClass
IfsException
- if the operation failspublic long DMOpenWastebasketSelector(String searchClass, String searchDefinition, boolean recursive, SortSpecification sort) throws IfsException
DMOpenWastebasketSelector
in interface S_LibrarySessionInterface
searchClass
- the classobject to searchsearchDefinition
- the WHERE clauserecursive
- whether to search subclasses of
searchClass
sort
- the sort orderIfsException
- if the operation failspublic void DMEmptyWastebasket() throws IfsException
DMEmptyWastebasket
in interface S_LibrarySessionInterface
IfsException
- if the operation failsprotected void emptyWastebasket(S_DirectoryObject user) throws IfsException
IfsException
- if the operation failsprotected void addLockedForSessionObject(S_PublicObject obj) throws IfsException
obj
- the objectIfsException
- if the operation failsprotected void addLockedForSessionObject(Long objid) throws IfsException
objid
- the id of the objectIfsException
- if the operation failsprotected void removeLockedForSessionObject(S_PublicObject obj) throws IfsException
obj
- the objectIfsException
- if the operation failsprotected void removeLockedForSessionObject(Long objid)
objid
- the id of the objectpublic Vector DMGetLockedForSessionObjects() throws IfsException
DMGetLockedForSessionObjects
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic Vector DMGetPublicObjectsReferringToLockObject(Long id, Long classid, SortSpecification sort) throws IfsException
DMGetPublicObjectsReferringToLockObject
in interface S_LibrarySessionInterface
id
- the id of the lockobjectclassid
- the class id of the lockobjectsort
- the sortspecification to be usedIfsException
- if the operation failspublic boolean DMIsLockObjectShared(Long id, Long classid) throws IfsException
DMIsLockObjectShared
in interface S_LibrarySessionInterface
id
- the id of the lockobjectclassid
- the class id of the lockobjectIfsException
- if the operation failspublic S_LibraryObjectData DMConvertToPrivateACL(Long id, Long classId, S_LibraryObjectDefinition sdef) throws IfsException
DMConvertToPrivateACL
in interface S_LibrarySessionInterface
id
- the id of the objectclassId
- the class id of the objectsdef
- the definition to use in performing the ACL copyIfsException
- if the operation failspublic Long[] DMfetchACEs(Long id, Long classId) throws IfsException
DMfetchACEs
in interface S_LibrarySessionInterface
id
- the id the ACLclassId
- the class id of the ACLIfsException
- if the operation failspublic AccessLevel DMGetAccessLevel(Long id, Long classId, Long userId) throws IfsException
DMGetAccessLevel
in interface S_LibrarySessionInterface
id
- the id of the ACLclassId
- the class id of the ACLuserId
- the id of the userIfsException
- if the operation failspublic S_LibraryObjectData DMaddAccessControlEntry(Long id, Long classId, S_LibraryObjectDefinition sdef) throws IfsException
DMaddAccessControlEntry
in interface S_LibrarySessionInterface
id
- the id the ACLclassId
- the class id of the ACLsdef
- the access control entry definitionIfsException
- if the operation failspublic void DMupdateAccessControlEntry(Long id, Long classId, Long aceId, Long aceClassId, S_LibraryObjectDefinition sdef) throws IfsException
DMupdateAccessControlEntry
in interface S_LibrarySessionInterface
id
- the id the ACLclassId
- the class id of the ACLaceId
- the id of the ACEaceClassId
- the class id of the ACEsdef
- the access control entry definitionIfsException
- if the operation failspublic void DMRemoveAccessControlEntry(Long id, Long classId, Long aceId, Long aceClassId) throws IfsException
DMRemoveAccessControlEntry
in interface S_LibrarySessionInterface
id
- the id the ACLclassId
- the class id of the ACLaceId
- the id of the ACEaceClassId
- the class id of the ACEIfsException
- if the operation failspublic void DMremoveAllAccessControlEntries(Long id, Long classId) throws IfsException
DMremoveAllAccessControlEntries
in interface S_LibrarySessionInterface
id
- the id the ACLclassId
- the class id of the ACLIfsException
- if the operation failspublic void DMApplyAclIndexDeferredUpdate(AccessControlListDeferredUpdate entry, boolean deleteAfterProcessing) throws IfsException
DMApplyAclIndexDeferredUpdate
in interface S_LibrarySessionInterface
entry
- the ACL index deferred entryIfsException
- if the operation failspublic Vector DMGetAclIndexDeferredUpdates(int maxItems) throws IfsException
DMGetAclIndexDeferredUpdates
in interface S_LibrarySessionInterface
maxItems
- the maximum number of entries to returnIfsException
- if the operation failspublic void DMDeleteAclIndexDeferredUpdates(Long[] ids) throws IfsException
DMDeleteAclIndexDeferredUpdates
in interface S_LibrarySessionInterface
ids
- the set of AccessControlListDeferredUpdate
IDs to deleteIfsException
- if the operation failspublic boolean DMIsAclIndexUpdateModeSynchronous() throws IfsException
DMIsAclIndexUpdateModeSynchronous
in interface S_LibrarySessionInterface
IfsException
- if the operation failsprotected AccessControlListResolver findOrConstructAclResolver(Long key) throws IfsException
key
- the idIfsException
- if the operation failsprotected Long getComponentAclsAttributeId() throws IfsException
IfsException
- if the operation failsprotected Long[] getCachedAllAncestorIds()
protected void setCachedAllAncestorIds(Long[] ancestorIds)
ancestorIds
- the ancestor object IDs to cacheIfsException
- if the operation fails.protected void clearCachedAllAncestorIds()
public int getMemberThreshold() throws IfsException
IfsException
- if the operation failspublic int getAncestorThreshold() throws IfsException
IfsException
- if the operation failspublic boolean isArrayInputsUsedForMemberSelection() throws IfsException
IfsException
- if the operation failspublic boolean isArrayInputsUsedForAncestorSelection() throws IfsException
IfsException
- if the operation failspublic void DMCreateRetainedEventDatabaseObjects(RetainedEvent event) throws IfsException
DMCreateRetainedEventDatabaseObjects
in interface S_LibrarySessionInterface
event
- the RetainedEventIfsException
- if the operation failspublic void DMDropRetainedEventDatabaseObjects(RetainedEvent event) throws IfsException
DMDropRetainedEventDatabaseObjects
in interface S_LibrarySessionInterface
event
- the RetainedEventIfsException
- if the operation failspublic void DMInsertRetainedEvent(RetainedEvent event) throws IfsException
DMInsertRetainedEvent
in interface S_LibrarySessionInterface
event
- the RetainedEventIfsException
- if the operation failspublic void DMDeleteRetainedEvent(RetainedEvent event) throws IfsException
DMDeleteRetainedEvent
in interface S_LibrarySessionInterface
event
- the RetainedEventIfsException
- if the operation failspublic RetainedEvent[] DMGetRetainedEvents(RetainedEvent event, int maxItems) throws IfsException
DMGetRetainedEvents
in interface S_LibrarySessionInterface
event
- the RetainedEvent type to selectmaxItems
- the maximum items to returnIfsException
- if the operation failspublic S_LibraryObjectData DMAddRelationship(Long id, Long classId, S_LibraryObjectDefinition rdef) throws IfsException
DMAddRelationship
in interface S_LibrarySessionInterface
id
- the id of the objectclassId
- the class id of the objectIfsException
- if the operation failspublic void DMRemoveRelationship(Long id, Long classId, Long relId, Long relClassId) throws IfsException
DMRemoveRelationship
in interface S_LibrarySessionInterface
id
- the id of the objectclassId
- the class id of the objectrelId
- the id of the relationshiprelClassId
- the class id of the relationshipIfsException
- if the operation failspublic Vector DMGetRightwardRelationships(Long id, Long classId, Long relClassId, SortSpecification sort) throws IfsException
DMGetRightwardRelationships
in interface S_LibrarySessionInterface
id
- the id of the objectclassId
- the class id of the objectrelClassId
- the class id of the relationshipsort
- the sort specificationIfsException
- if the operation failspublic Vector DMGetRightwardRelationshipObjects(Long id, Long classId, Long relClassId, SortSpecification sort) throws IfsException
DMGetRightwardRelationshipObjects
in interface S_LibrarySessionInterface
id
- the id of the objectclassId
- the class id of the objectrelClassId
- the class id of the relationshipsort
- the sort specificationIfsException
- if the operation failspublic Vector DMGetLeftwardRelationships(Long id, Long classId, Long relClassId, SortSpecification sort) throws IfsException
DMGetLeftwardRelationships
in interface S_LibrarySessionInterface
id
- the id of the objectclassId
- the class id of the objectrelClassId
- the class id of the relationshipsort
- the sort specificationIfsException
- if the operation failspublic Vector DMGetLeftwardRelationshipObjects(Long id, Long classId, Long relClassId, SortSpecification sort) throws IfsException
DMGetLeftwardRelationshipObjects
in interface S_LibrarySessionInterface
id
- the id of the objectclassId
- the class id of the objectrelClassId
- the class id of the relationshipsort
- the sort specificationIfsException
- if the operation failspublic long DMGetLeftwardRelationshipsCount(Long id, Long classId, Long relClassId) throws IfsException
DMGetLeftwardRelationshipsCount
in interface S_LibrarySessionInterface
id
- the id of the objectclassId
- the class id of the objectrelClassId
- the class id of the relationshipIfsException
- if the operation failspublic void DMAddToFolder(Long folder_id, Long classid, Long rightObj, Long rightObjClassid) throws IfsException
DMAddToFolder
in interface S_LibrarySessionInterface
folder_id
- the id of the folderclassid
- the class id of the folderrightObj
- the id of the itemrightObjClassid
- the class id of the itemIfsException
- if the operation failspublic void DMAddFolderRelationship(Long id, Long classid, S_LibraryObjectDefinition rdef) throws IfsException
DMAddFolderRelationship
in interface S_LibrarySessionInterface
id
- the id of the folderclassid
- the class id of the folderrdef
- the definition of the folder relationshipIfsException
- if the operation failspublic void DMRemoveFromFolder(Long folder_id, Long classid, Long rightObj, Long rightObjClassid, S_LibraryObjectDefinition def) throws IfsException
DMRemoveFromFolder
in interface S_LibrarySessionInterface
folder_id
- the id of the folderclassid
- the class id of the folderrightObj
- the id of the itemrightObjClassid
- the class id of the itemdef
- the definition containing optionsIfsException
- if the operation failspublic long DMGetFolderItemCount(Long id, Long classId, String folderRelClassname) throws IfsException
DMGetFolderItemCount
in interface S_LibrarySessionInterface
id
- the idclassId
- the class idfolderRelClassname
- the name of the folder relationship
classobjectIfsException
- if the operation failspublic long DMGetSubfolderCount(Long id, Long classId, String folderRelClassname) throws IfsException
DMGetSubfolderCount
in interface S_LibrarySessionInterface
id
- the idclassId
- the class idfolderRelClassname
- the name of the folder relationship
classobjectIfsException
- if the operation failspublic Vector DMListItems(Long folder_id, Long classid, String folderRelClassname, SortSpecification sort) throws IfsException
DMListItems
in interface S_LibrarySessionInterface
folder_id
- the idclassid
- the class idfolderRelClassname
- the name of the folder relationship
classobjectsort
- the sort specificationIfsException
- if the operation failspublic Long[] DMGetFolderItemList(Long folder_id, Long classid, SortSpecification sort) throws IfsException
DMGetFolderItemList
in interface S_LibrarySessionInterface
folder_id
- the idclassid
- the class idsort
- the sort specificationIfsException
- if the operation failspublic int DMGetTotalFolderItemCount(Long folder_id, Long classid) throws IfsException
DMGetTotalFolderItemCount
in interface S_LibrarySessionInterface
folder_id
- the idclassid
- the class idIfsException
- if the operation failspublic boolean DMFolderHasSubFolders(Long folder_id, Long classid) throws IfsException
DMFolderHasSubFolders
in interface S_LibrarySessionInterface
folder_id
- the idclassid
- the class idIfsException
- if the operation failspublic void DMOpenFolder(Long folder_id, Long classid, String folderRelClassname, SortSpecification sort) throws IfsException
DMOpenFolder
in interface S_LibrarySessionInterface
folder_id
- the idclassid
- the class idfolderRelClassname
- the name of the folder relationship
classobjectsort
- the sort specificationIfsException
- if the operation failspublic S_LibraryObjectData DMNextFolderItem(Long folder_id, Long classid) throws IfsException
DMNextFolderItem
in interface S_LibrarySessionInterface
folder_id
- the idclassid
- the class idIfsException
- if the operation failspublic void DMCloseFolder(Long folder_id, Long classid) throws IfsException
DMCloseFolder
in interface S_LibrarySessionInterface
folder_id
- the idclassid
- the class idIfsException
- if the operation failspublic S_LibraryObjectData DMFindPublicObjectByPath(Long folder_id, Long classid, String path) throws IfsException
DMFindPublicObjectByPath
in interface S_LibrarySessionInterface
folder_id
- the id of the folderclassid
- the class id of the folderpath
- the relative pathIfsException
- if the operation failspublic boolean DMCheckExistenceOfPublicObjectByPath(Long folder_id, Long classid, String path) throws IfsException
DMCheckExistenceOfPublicObjectByPath
in interface S_LibrarySessionInterface
folder_id
- the id of the folderclassid
- the class id of the folderpath
- the relative pathIfsException
- if the operation failspublic String DMGetAnyFolderPath(Long id, Long classid, Long folderRefId, Long folderRefClassid, FolderPathOptions fpo, SortSpecification sort) throws IfsException
DMGetAnyFolderPath
in interface S_LibrarySessionInterface
id
- the id of the objectclassid
- the class id of the objectfolderRefId
- the id of the relative folder
(null indicates root)folderRefClassid
- the class id of the relative folder
(null indicates root)fpo
- Options describing the
path determination operation;
optional; if null is specified,
default beahvior will be in force.sort
- how referencing folders are to be sortedIfsException
- if the operation failspublic long DMGetConsumedStorage(Long id, Long classid) throws IfsException
DMGetConsumedStorage
in interface S_LibrarySessionInterface
id
- id of the objectclassid
- class id of the objectIfsException
- if the operation failspublic String[] DMGetAllFolderPaths(Long id, Long classid, Long folderRefId, Long folderRefClassid, FolderPathOptions fpo, SortSpecification sort) throws IfsException
DMGetAllFolderPaths
in interface S_LibrarySessionInterface
id
- the id of the objectclassid
- the class id of the objectfolderRefId
- the id of the relative folder
(null indicates root)folderRefClassid
- the class id of the relative folder
(null indicates root)fpo
- Options describing the
path determination operation;
optional; if null is specified,
default beahvior will be in force.sort
- how referencing folders are to be sortedIfsException
- if the operation failspublic Long[] DMGetFolderReferences(Long PublicObject_id, Long classid, SortSpecification sort) throws IfsException
DMGetFolderReferences
in interface S_LibrarySessionInterface
PublicObject_id
- the idclassid
- the class idsort
- the sort specificationIfsException
- if the operation failspublic Serializable DYNListAllFoldersWithSubfolders(Serializable payload) throws IfsException
payload
- unusedIfsException
- if the operation failspublic Serializable DYNGetUnreferencedContentObjectList(Serializable payload) throws IfsException
payload
- INteger batch sizeIfsException
- if the operation failspublic void DMAddMemberToDirectoryGroup(Long group_id, Long classid, Long member_id, Long memberClassid) throws IfsException
DMAddMemberToDirectoryGroup
in interface S_LibrarySessionInterface
group_id
- the id of the groupclassid
- the class id of the groupmember_id
- the id of the objectmemberClassid
- the class id of the objectIfsException
- if the operation failspublic void DMRemoveMemberFromDirectoryGroup(Long group_id, Long classid, Long member_id, Long memberClassid) throws IfsException
DMRemoveMemberFromDirectoryGroup
in interface S_LibrarySessionInterface
group_id
- the id of the groupclassid
- the class id of the groupmember_id
- the id of the objectmemberClassid
- the class id of the objectIfsException
- if the operation failspublic void DMAddMembersToDirectoryGroup(Long group_id, Long classid, Long[] rightObjIds, Long[] rightObjClassids) throws IfsException
DMAddMembersToDirectoryGroup
in interface S_LibrarySessionInterface
group_id
- the id of the groupclassid
- the class id of the grouprightObjIds
- the ids of the objectsrightObjClassids
- the class ids of the objectsIfsException
- if the operation failspublic void DMRemoveMembersFromDirectoryGroup(Long group_id, Long classid, Long[] rightObjIds, Long[] rightObjClassids) throws IfsException
DMRemoveMembersFromDirectoryGroup
in interface S_LibrarySessionInterface
group_id
- the id of the groupclassid
- the class id of the grouprightObjIds
- the ids of the objectsrightObjClassids
- the class ids of the objectsIfsException
- if the operation failspublic Long[] DMGetDirectMembersOfDirectoryGroup(Long id, Long classid, boolean filterForDiscoverability) throws IfsException
DMGetDirectMembersOfDirectoryGroup
in interface S_LibrarySessionInterface
id
- the id of the groupclassid
- the class id of the groupfilterForDiscoverability
- true if returned ID set reflects
the members the session could discoverIfsException
- if the operation failspublic Long[] DMGetAllMembersOfDirectoryGroup(Long id, Long classid, boolean filterForDiscoverability) throws IfsException
DMGetAllMembersOfDirectoryGroup
in interface S_LibrarySessionInterface
id
- the id of the groupclassid
- the class id of the groupfilterForDiscoverability
- true if returned ID set reflects
the members the session could discoverIfsException
- if the operation failspublic boolean DMIsDirectMemberOfDirectoryGroup(Long groupId, Long groupClassId, Long memberId, Long memberClassId) throws IfsException
DMIsDirectMemberOfDirectoryGroup
in interface S_LibrarySessionInterface
groupId
- the id of the groupgroupClassId
- the class id of the groupmemberId
- the id of the groupmemberClassId
- the class id of the groupIfsException
- if the operation failspublic boolean DMIsMemberOfDirectoryGroup(Long groupId, Long groupClassId, Long memberId, Long memberClassId) throws IfsException
DMIsMemberOfDirectoryGroup
in interface S_LibrarySessionInterface
groupId
- the id of the groupgroupClassId
- the class id of the groupmemberId
- the id of the groupmemberClassId
- the class id of the groupIfsException
- if the operation failspublic void DMInvalidateTokenCredentials(Long userId) throws IfsException
DMInvalidateTokenCredentials
in interface S_LibrarySessionInterface
userId
- ID of user whose token credentials need to be
invalidated.IfsException
- (IFS-10191) if the operation failspublic void invalidateTokenCredentials(Long userId) throws IfsException
userId
- id of the user whose token credentials need to
be invalidatedIfsException
- (IFS-10189) if the operation failspublic Serializable DYNGetSystemUserToken(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failsprotected static PreparedStatement getInvalidateTokenCredentialsStatement(LibraryConnection lconn, Connection conn) throws SQLException
lconn
- the CM SDK connectionconn
- the JDBC connectionSQLException
- if the operation failspublic Long[] DMGetDirectAncestorsOfDirectoryObject(Long id, Long classid) throws IfsException
DMGetDirectAncestorsOfDirectoryObject
in interface S_LibrarySessionInterface
id
- the id of the groupclassid
- the class id of the groupIfsException
- if the operation failspublic Long[] DMGetAllAncestorsOfDirectoryObject(Long id, Long classid) throws IfsException
DMGetAllAncestorsOfDirectoryObject
in interface S_LibrarySessionInterface
id
- the id of the groupclassid
- the class id of the groupIfsException
- if the operation failspublic int DMGetMemberThreshold() throws IfsException
DMGetMemberThreshold
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic int DMGetAncestorThreshold() throws IfsException
DMGetAncestorThreshold
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic boolean DMIsArrayInputsUsedForMemberSelection() throws IfsException
DMIsArrayInputsUsedForMemberSelection
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic boolean DMIsArrayInputsUsedForAncestorSelection() throws IfsException
DMIsArrayInputsUsedForAncestorSelection
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic Long[] DMGetCategoryIds(Long id, Long classid) throws IfsException
DMGetCategoryIds
in interface S_LibrarySessionInterface
id
- the id of the Objectclassid
- the class id of the ObjectIfsException
- if the operation failspublic Long[] DMGetCompositeAclIds(Long id, Long classid, SortSpecification sort) throws IfsException
DMGetCompositeAclIds
in interface S_LibrarySessionInterface
id
- the id of the ACLclassid
- the class id of the ACLsort
- how the composites are to be sortedIfsException
- if the operation failspublic Vector DMFetchProperties(Long propBundleId, Long propClassId) throws IfsException
DMFetchProperties
in interface S_LibrarySessionInterface
propBundleId
- the id of the property bundlepropClassId
- the class id of the property bundleIfsException
- if the operation failspublic AttributeValue DMGetProperty(Long propBundleId, Long propClassId, String propertyName) throws IfsException
DMGetProperty
in interface S_LibrarySessionInterface
propBundleId
- the id of the property bundlepropClassId
- the class id of the property bundlepropertyName
- name of the property to be fetchedIfsException
- if the operation failspublic Vector DMFetchPolicyListElements(Long policyListId, Long policyListClassId) throws IfsException
DMFetchPolicyListElements
in interface S_LibrarySessionInterface
policyListId
- the id of the PolicyListpolicyListClassId
- the class id of the PolicyListIfsException
- if the operation failspublic Vector DMGetEffectiveClassPolicyListElements(Long id, Long classId, String operation) throws IfsException
The PolicyListElements are returned in SORTSEQUENCE order. If more than one PolicyListElement has a particular SORTSEQUENCE value, a PolicyListElement introduced by a classobject precedes the PolicyListElements introduced by the superclasses of that classobject.
DMGetEffectiveClassPolicyListElements
in interface S_LibrarySessionInterface
id
- the classobject idclassId
- the classobject class idoperation
- the operation of interest, or null for
all operationsIfsException
- if the operation failspublic Vector DMGetEffectivePolicyListElements(Long id, Long classId, String operation) throws IfsException
The PolicyListElements are returned in SORTSEQUENCE order. If more than one PolicyListElement has a particular SORTSEQUENCE value, a PolicyListElement introduced by the object's PolicyLists precedes a PolicyListElement introduced by a ClassPolicyList. If more than one PolicyListElement is introduced by a ClassPolicyList for a particular SORTSEQUENCE value, a PolicyListElement introduced by a classobject precedes the PolicyListElements introduced by the superclasses of that classobject. If more than one PolicyListElement is introduced by a object-level PolicyList for a particular SORTSEQUENCE value, the array ordering of the PolicyList objects in the PolicyLists attribute is used to determine precedence.
DMGetEffectivePolicyListElements
in interface S_LibrarySessionInterface
id
- the idclassId
- the class idoperation
- the operation of interest, or null for
all operationsIfsException
- if the operation failsprotected PolicyAction getPolicyAction(String className) throws IfsException
className
- the fully-qualified class name of the PolicyActionIfsException
- if the operation failsprotected void putPolicyAction(String className, PolicyAction pa) throws IfsException
className
- the fully-qualified class name of the PolicyActionpa
- the PolicyActionIfsException
- if the operation failspublic Long[] DMGetLinks(Long id, Long classid) throws IfsException
DMGetLinks
in interface S_LibrarySessionInterface
id
- the id of the PublicObjectclassid
- the class id of the PublicObjectIfsException
- if the operation failspublic void DMReassociateLinks(Long oldId, Long oldClassId, Long newId, Long newClassId) throws IfsException
DMReassociateLinks
in interface S_LibrarySessionInterface
oldId
- the id of the current PublicObjectoldClassId
- the class id of the current PublicObjectnewId
- the id of the current PublicObjectnewClassId
- the class id of the current PublicObjectIfsException
- if the operation failspublic Long[] DMfetchVersionSerieses(Long id, Long classid) throws IfsException
DMfetchVersionSerieses
in interface S_LibrarySessionInterface
id
- the id of the familyclassid
- the class id of the familyIfsException
- if the operation failspublic Long[] DMfetchRevisions(Long id, Long classid) throws IfsException
DMfetchRevisions
in interface S_LibrarySessionInterface
id
- the id of the version seriesclassid
- the class id of the version seriesIfsException
- if the operation failspublic void DMReserveNext(Long id, Long classId, String contentPath, String comment) throws IfsException
DMReserveNext
in interface S_LibrarySessionInterface
id
- the id of the version seriesclassId
- the class id of the version seriescontentPath
- the value for the content path attributecomment
- the value for the comment attributeIfsException
- if the operation failspublic void DMUnReserve(Long id, Long classId) throws IfsException
DMUnReserve
in interface S_LibrarySessionInterface
id
- the id of the version seriesclassId
- the class id of the version seriesIfsException
- if the operation failspublic S_LibraryObjectData DMNewRevision(Long id, Long classId, S_LibraryObjectDefinition def) throws IfsException
DMNewRevision
in interface S_LibrarySessionInterface
id
- the id of the version seriesclassId
- the class id of the version seriesdef
- the definition for the new version descriptionIfsException
- if the operation failspublic S_LibraryObjectData DMNewVersionSeries(Long id, Long classId, S_LibraryObjectDefinition def) throws IfsException
DMNewVersionSeries
in interface S_LibrarySessionInterface
id
- the id of the familyclassId
- the class id of the familydef
- the definition of the first version description
in the new version seriesIfsException
- if the operation failspublic S_LibraryObjectData DMNewBranchedVersionSeries(Long id, Long classId, S_LibraryObjectDefinition def) throws IfsException
DMNewBranchedVersionSeries
in interface S_LibrarySessionInterface
id
- the id of the version descriptionclassId
- the class id of the version descriptiondef
- the definition of the new version descriptionIfsException
- if the operation failspublic void DMIntegrateIntoVersionSeries(Long sid, Long sclassId, Long tid, Long tclassId) throws IfsException
DMIntegrateIntoVersionSeries
in interface S_LibrarySessionInterface
sid
- the id of the source version descriptionsclassId
- the class id of the source version descriptiontid
- the target target version seriestclassId
- the class id of the target version seriesIfsException
- if the operation failspublic Long DMGetPartitionValue(Long id, Long classId) throws IfsException
DMGetPartitionValue
in interface S_LibrarySessionInterface
id
- the ContentObject idclassId
- the ContentObject class idIfsException
- if the operation failspublic Date DMGetLastAccessDate(Long id, Long classId) throws IfsException
DMGetLastAccessDate
in interface S_LibrarySessionInterface
id
- the ContentObject idclassId
- the ContentObject class idIfsException
- if the operation failspublic ContentStreamSerializer DMGetContentStream(Long id, Long classId, Long refObjId, Long refObjClassId) throws IfsException
DMGetContentStream
in interface S_LibrarySessionInterface
id
- classId
- refObjId
- refObjClassId
- IfsException
public ContentStreamSerializer DMNewContentStreamSerializer() throws IfsException
DMNewContentStreamSerializer
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic ContentStreamSerializer newContentStreamSerializer() throws IfsException
IfsException
- if the operation failspublic ContentStreamSerializer DMGetContentReader(Long id, Long classId, Long refObjId, Long refObjClassId) throws IfsException
DMGetContentReader
in interface S_LibrarySessionInterface
id
- the id of the content objectclassId
- the class id of the content objectrefObjId
- the id of the object referencing the content objectrefObjClassId
- the class id of the object referencing the content
objectIfsException
- if the operation failspublic RandomAccessor DMGetContentByRandomAccess(Long coId, Long coClassId, Long refObjId, Long refObjClassId) throws IfsException
DMGetContentByRandomAccess
in interface S_LibrarySessionInterface
coId
- the id of the ContentObjectcoClassId
- the class id of the ContentObjectrefObjId
- the id of a Document referencing the ContentObjectrefObjClassId
- the class id of a Document referencing the
ContentObjectIfsException
- if the operation failspublic RandomAccessor DMUpdateContentByRandomAccess(Long docId, Long docClassId, S_LibraryObjectDefinition sdocdef, Long expirationPeriod) throws IfsException
DMUpdateContentByRandomAccess
in interface S_LibrarySessionInterface
docId
- the id of the documentdocClassId
- the class id of the documentsdocdef
- a DocumentDefinition, as a
S_LibraryObjectDefinitionexpirationPeriod
- the expiration period for the RandomAccessor,
in seconds, or null for the default expiration
periodIfsException
- if the operation failspublic Long DMRandomAccessorGetDocumentId(S_RandomAccessorImpl ra) throws IfsException
DMRandomAccessorGetDocumentId
in interface S_LibrarySessionInterface
ra
- the RandomAccessorIfsException
- if the operation failspublic Long DMRandomAccessorGetContentObjectId(S_RandomAccessorImpl ra) throws IfsException
DMRandomAccessorGetContentObjectId
in interface S_LibrarySessionInterface
ra
- the RandomAccessorIfsException
- if the operation failspublic void DMRandomAccessorSetSession(S_RandomAccessorImpl ra) throws IfsException
DMRandomAccessorSetSession
in interface S_LibrarySessionInterface
ra
- the RandomAccessorIfsException
- if the operation failspublic int DMRandomAccessorRead(S_RandomAccessorImpl ra, long pos, byte[] b, int off, int len) throws IfsException
DMRandomAccessorRead
in interface S_LibrarySessionInterface
ra
- the RandomAccessorpos
- the position in content from which to readb
- the buffer into which to readoff
- the offset in the bufferlen
- the maximum number of bytes to readIfsException
- if the operation failspublic boolean DMRandomAccessorIsWriteable(S_RandomAccessorImpl ra) throws IfsException
DMRandomAccessorIsWriteable
in interface S_LibrarySessionInterface
ra
- the RandomAccessorIfsException
- if the operation failspublic void DMRandomAccessorWrite(S_RandomAccessorImpl ra, long pos, byte[] b, int off, int len) throws IfsException
DMRandomAccessorWrite
in interface S_LibrarySessionInterface
ra
- the RandomAccessorpos
- the position in content from which to writeb
- the buffer from which to writeoff
- the offset in the bufferlen
- the number of bytes to writeIfsException
- if the operation failspublic void DMRandomAccessorTruncate(S_RandomAccessorImpl ra, long len) throws IfsException
DMRandomAccessorTruncate
in interface S_LibrarySessionInterface
ra
- the RandomAccessorlen
- the desired content lengthIfsException
- if the operation failspublic long DMRandomAccessorLength(S_RandomAccessorImpl ra) throws IfsException
DMRandomAccessorLength
in interface S_LibrarySessionInterface
ra
- the RandomAccessorIfsException
- if the operation failspublic void DMRandomAccessorDispose(S_RandomAccessorImpl ra) throws IfsException
DMRandomAccessorDispose
in interface S_LibrarySessionInterface
ra
- the RandomAccessorIfsException
- if the operation failspublic void DMRandomAccessorClose(S_RandomAccessorImpl ra) throws IfsException
DMRandomAccessorClose
in interface S_LibrarySessionInterface
ra
- the RandomAccessorIfsException
- if the operation failspublic void DMCalculateConsumedStorage(Long quotaid, Long classid) throws IfsException
DMCalculateConsumedStorage
in interface S_LibrarySessionInterface
quotaid
- the id of the content quotaclassid
- the class id of the content quotaIfsException
- if the operation failspublic void DMSetContentReadByUser(Long id, Long classId, boolean readState, Long refObjId, Long refObjClassId) throws IfsException
DMSetContentReadByUser
in interface S_LibrarySessionInterface
id
- the id of the content objectclassId
- the class id of the content objectreadState
- whether the user has read the content objectrefObjId
- the id of the object referencing the content objectrefObjClassId
- the class id of the object referencing the content
objectIfsException
- if the operation failspublic boolean DMIsContentReadByUser(Long id, Long classId) throws IfsException
DMIsContentReadByUser
in interface S_LibrarySessionInterface
id
- the id of the content objectclassId
- the class id of the content objectIfsException
- if the operation failspublic boolean DMIsContextIndexEnabled() throws IfsException
DMIsContextIndexEnabled
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic void DMFilterContent(Long id, Long classId, boolean plaintext, Long refObjId, Long refObjClassId) throws IfsException
DMFilterContent
in interface S_LibrarySessionInterface
id
- the id of the content objectclassId
- the class id of the content objectplaintext
- plaintextrefObjId
- the id of the object referencing the content objectrefObjClassId
- the class id of the object referencing the content
objectIfsException
- if the operation failspublic ContentStreamSerializer DMGetFilteredContent(Long id, Long classId, Long refObjId, Long refObjClassId) throws IfsException
DMGetFilteredContent
in interface S_LibrarySessionInterface
id
- the id of the content objectclassId
- the class id of the content objectrefObjId
- the id of the object referencing the content objectrefObjClassId
- the class id of the object referencing the content
objectIfsException
- if the operation failspublic void DMGenerateSummary(Long id, Long classId, String pointOfView, long sizeAsPercent, long sizeAsNumParagraphs, String summaryLevel, Long refObjId, Long refObjClassId) throws IfsException
DMGenerateSummary
in interface S_LibrarySessionInterface
id
- the id of the content objectclassId
- the class id of the content objectpointOfView
- the point of viewsizeAsPercent
- the size, as a percentsizeAsNumParagraphs
- the size, as number of paragraphssummaryLevel
- the summary levelrefObjId
- the id of the object referencing the
content objectrefObjClassId
- the class id of the object referencing the
content objectIfsException
- if the operation failspublic ContentStreamSerializer DMGetSummary(Long id, Long classId, String pointOfView, Long refObjId, Long refObjClassId) throws IfsException
DMGetSummary
in interface S_LibrarySessionInterface
id
- the id of the content objectclassId
- the class id of the content objectpointOfView
- the point of viewrefObjId
- the id of the object referencing the content objectrefObjClassId
- the class id of the object referencing the content
objectIfsException
- if the operation failspublic void DMGenerateThemes(Long id, Long classId, boolean fullThemes, Long refObjId, Long refObjClassId) throws IfsException
DMGenerateThemes
in interface S_LibrarySessionInterface
id
- the id of the content objectclassId
- the class id of the content objectfullThemes
- full themesrefObjId
- the id of the object referencing the
content objectrefObjClassId
- the class id of the object referencing the
content objectIfsException
- if the operation failspublic void DMAddManualTextIndexing(Long id, Long classId, ContentStreamSerializer css) throws IfsException
This is currently only used in Postgres installations.
DMAddManualTextIndexing
in interface S_LibrarySessionInterface
id
- the id of the content objectclassId
- the class id of the content objectcss
- the ContentStreamSerializer that holds the
text stream to use for text indexingIfsException
- if the operation failspublic void DMEnqueueMessage(Long id, Long classId, oracle.sql.ORAData message) throws IfsException
DMEnqueueMessage
in interface S_LibrarySessionInterface
id
- id of the QueueclassId
- classId of the Queuemessage
- message to be enqueuedIfsException
- if the operation failspublic void DMEnqueueMessage(Long id, Long classId, oracle.sql.ORAData message, String correlation) throws IfsException
DMEnqueueMessage
in interface S_LibrarySessionInterface
id
- id of the QueueclassId
- classId of the Queuemessage
- message to be enqueuedcorrelation
- correlation for the messageIfsException
- if the operation failspublic oracle.sql.ORAData DMDequeueMessage(Long id, Long classId, String subscriberName) throws IfsException
DMDequeueMessage
in interface S_LibrarySessionInterface
id
- id of the QueueclassId
- classId of the QueuesubscriberName
- name of the subscriber dequeueing the messageIfsException
- if the operation failspublic oracle.sql.ORAData DMDequeueMessageFromExceptionQueue(Long id, Long classId) throws IfsException
DMDequeueMessageFromExceptionQueue
in interface S_LibrarySessionInterface
id
- id of the QueueclassId
- classId of the QueueIfsException
- if the operation failspublic ContextTheme[] DMGetThemes(Long id, Long classId, Long refObjId, Long refObjClassId) throws IfsException
DMGetThemes
in interface S_LibrarySessionInterface
id
- the id of the content objectclassId
- the class id of the content objectrefObjId
- the id of the object referencing the content objectrefObjClassId
- the class id of the object referencing the content
objectIfsException
- if the operation failsprotected boolean isFullTextIndexingEnabled() throws IfsException
IfsException
- if the operation failspublic Serializable DYNSyncContentIndex(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic Serializable DYNExtractContentForIndexing(Serializable payload) throws IfsException
extractContentForIndexing
method
of S_LibrarySessionContentStorageManager.
The payload
must be Vector with two elements:
previousContentObjectId
: LongbatchSize
: Integer; non-nullpayload
- see method descriptionextractContentForIndexing
IfsException
- 32385: if the operation failspublic Serializable DYNGetAbsolutePath(Serializable payload) throws IfsException
payload
- the String path, or nullpayload
; if
payload
is already an absolute path it
is returned unchanged; returns null if
payload
is nullIfsException
- if the operation failspublic boolean DMIsAttributeValueInValueDomain(Long id, Long classId, AttributeValue av) throws IfsException
DMIsAttributeValueInValueDomain
in interface S_LibrarySessionInterface
id
- the id of the ValueDomain objectclassId
- the class id of the ValueDomain objectav
- the attribute valueIfsException
- if the operation failspublic S_LibraryObjectData DMGetPrimaryUserProfile(Long id) throws IfsException
DMGetPrimaryUserProfile
in interface S_LibrarySessionInterface
id
- the id of the userIfsException
- if the operation failspublic void DMGrantAdmin(Long userid) throws IfsException
DMGrantAdmin
in interface S_LibrarySessionInterface
userid
- the id of the userIfsException
- if the operation failspublic Serializable DYNCreateAdminDirectoryObjects(Serializable payload) throws IfsException
The payload
must be a Vector containing four String
elements, as follows:
payload
- see method descriptionIfsException
- if the operation failspublic Long getIdForNewObject(S_LibraryObjectDefinition def) throws IfsException
def
- if not null, the setId
is invoked in this definitionIfsException
- if the operation failsprotected static PreparedStatement getNextSequenceQueryStatement(LibraryConnection lconn, Connection conn) throws SQLException
lconn
- the CM SDK connectionconn
- the JDBC connectionSQLException
- if the operation failspublic void setValueInStatement(PreparedStatement stmt, AttributeValue av, int position, int datatype) throws IfsException
stmt
- the statementav
- the valueposition
- the bind variable positiondatatype
- the bind variable datatypeIfsException
- if the operation failspublic void setValueInStatement(PreparedStatement stmt, AttributeValue av, int position, int datatype, int datalength) throws IfsException
stmt
- the statementav
- the valueposition
- the bind variable positiondatatype
- the bind variable datatypedatalength
- the bind variable data length; applicable
only for the String data typeIfsException
- if the operation failsprotected void clearValueInStatement(PreparedStatement stmt, int position, int datatype) throws SQLException
stmt
- the statementposition
- the bind variable positiondatatype
- the bind variable datatypeSQLException
- if the operation failsprotected String generateInsertStatement(String tableName, S_ClassObjectData clssdef) throws IfsException
tableName
- the database table for the classobjectclssdef
- the classobject dataIfsException
- if the operation failsprotected void clearPreparedInsertStatement(PreparedStatement stmt, S_ClassObjectData clssdef) throws IfsException, SQLException
stmt
- the statementclssdef
- the classobject dataIfsException
- if the operation failsSQLException
- if the operation failsprotected void setSpecifiedInsertColumns(AttributeValue[] avs, S_ClassObjectData classData, int position_offset, PreparedStatement stmt) throws IfsException
avs
- the valuesclassData
- the classobject dataposition_offset
- the bind variable position of the first valuestmt
- the statementIfsException
- if the operation failspublic static AttributeValue getValueFromResultSet(ResultSet rset, int position, int datatype, Long attributeId, long auditid, long objectId) throws IfsException
rset
- the result setposition
- the positiondatatype
- the datatype of the valueattributeId
- the Attribute IDauditid
- obsolete parameterobjectId
- the objectId associated with this resultSetIfsException
- if the operation failspublic static AttributeValue getValueFromResultSet(ResultSet rset, int position, int datatype, Long attributeId, long objectId) throws IfsException
rset
- the result setposition
- the positiondatatype
- the datatype of the valueattributeId
- the Attribute IDobjectId
- the objectId associated with this resultSetIfsException
- if the operation failspublic static AttributeValue getValueFromResultSet(ResultSet rset, int position, int datatype, Long attributeId, long auditid, long objectId, S_AttributeData attrData, S_LibrarySession session) throws IfsException
rset
- the result setposition
- the positiondatatype
- the datatype of the valueattributeId
- the Attribute IDobjectId
- the objectId associated with this resultSetattrData
- the AttributeData definition for the attribute;
may be nullsession
- the session context; may be nullIfsException
- if the operation failspublic static AttributeValue getValueFromResultSet(ResultSet rset, int position, int datatype, Long attributeId, long objectId, S_AttributeData attrData, S_LibrarySession session) throws IfsException
rset
- the result setposition
- the positiondatatype
- the datatype of the valueattributeId
- if this AttributeValue represents the value
of a LibraryObject's Attribute, this is the
id of that Attribute; if this AttributeValue
represents the value of a system audit entry
property, this is the system audit entry
property idobjectId
- the objectId associated with this resultSetattrData
- the AttributeData definition for the attribute;
may be nullsession
- the session context; may be nullIfsException
- if the operation failsprotected final Statement getStatementInProgress()
protected final boolean isStatementInProgressCancelled()
protected final boolean isInterrupted()
protected final void verifyNotInterrupted() throws IfsException
IfsException
protected final void interrupt()
public final boolean execute(Statement stmt, String sql) throws IfsException, SQLException
stmt
- a JDBC statementsql
- any SQL stringIfsException
- (IFS-21030) if the database operation times outSQLException
- if the operation otherwise failspublic final ResultSet executeQuery(Statement stmt, String sql) throws IfsException, SQLException
stmt
- a JDBC statementsql
- typically this is a static SQL SELECT statementIfsException
- (IFS-21030) if the database operation times outSQLException
- if the operation otherwise failspublic final int executeUpdate(Statement stmt, String sql) throws IfsException, SQLException
stmt
- a JDBC statementsql
- a SQL INSERT, UPDATE or DELETE statement or a SQL
statement that returns nothingIfsException
- (IFS-21030) if the database operation times outSQLException
- if the operation otherwise failspublic final boolean execute(PreparedStatement stmt) throws IfsException, SQLException
stmt
- a JDBC PreparedStatementIfsException
- (IFS-21030) if the database operation times outSQLException
- if the operation otherwise failspublic final int[] executeBatch(Statement stmt) throws IfsException, SQLException
stmt
- a JDBC StatementIfsException
- (IFS-21030) if the database operation times outSQLException
- if the operation otherwise failspublic final ResultSet executeQuery(PreparedStatement stmt) throws IfsException, SQLException
stmt
- a JDBC PreparedStatementIfsException
- (IFS-21030) if the database operation times outSQLException
- if the operation otherwise failspublic final int executeUpdate(PreparedStatement stmt) throws IfsException, SQLException
stmt
- a JDBC PreparedStatementIfsException
- (IFS-21030) if the database operation times outSQLException
- if the operation otherwise failspublic void DMCancelOperation() throws IfsException
DMCancelOperation
in interface S_LibrarySessionInterface
IfsException
- if the operation failsprotected S_LibraryObjectData getDataInstance(long selectClassId, S_ClassObjectData classData, S_LibraryObjectData[] selectAttributeDatas, ResultSet rset) throws IfsException, SQLException
selectClassId
- the id of the classobject against which
the SELECT was performedclassData
- the data of the classobject against which
the SELECT was performedselectAttributeDatas
- the datas of the effective attributes of
the classobject against which the SELECT
was performedrset
- the results setIfsException
- if the operation failsSQLException
- if the operation failsprotected S_LibraryObjectData getDataInstance(long selectClassId, S_ClassObjectData classData, S_LibraryObjectData[] selectAttributeDatas, ResultSet rset, int rsetStartIndex) throws IfsException, SQLException
selectClassId
- the id of the classobject against which
the SELECT was performedclassData
- the data of the classobject against which
the SELECT was performedselectAttributeDatas
- the datas of the effective attributes of
the classobject against which the SELECT
was performedrset
- the results setrsetStartIndex
- the position of the first effective
attributeIfsException
- if the operation failsSQLException
- if the operation failsprotected S_LibraryObjectCursor createLibraryObjectCursor(LibraryQueryStatement lstmt, ResultSet resultSet, S_LibraryObjectSelector selector)
lstmt
- the statementresultSet
- the result setselector
- the selectorprotected S_LibraryObjectCursor findLibraryObjectCursor(long cursorId)
cursorId
- the cursor sequenceprotected void removeLibraryObjectCursor(long cursorId)
cursorId
- the cursor sequenceprotected void removeLibraryObjectCursor(S_LibraryObjectCursor cursor)
cursor
- the cursorprotected boolean usesSecureSqlSyntax(String whereclause)
whereclause
- the WHERE clauseprotected void verifyHasLegalSyntax(String searchDefinition) throws IfsException
searchDefinition
- the WHERE clauseIfsException
- (IFS-30061) if the WHERE clause references
secured database objects and not in administration discover modepublic Transaction DMBeginTransaction(boolean writeable) throws IfsException
This method should be invoked only by its LibrarySession counterpart.
DMBeginTransaction
in interface S_LibrarySessionInterface
writeable
- whether the transaction is writeablecompleteTransaction
or
abortTransaction
IfsException
- (IFS-10651) if the operation failspublic final Transaction beginTransaction(boolean writeable) throws IfsException
writeable
- whether the transaction is writeablecompleteTransaction
or
abortTransaction
IfsException
- (IFS-10651) if the operation failspublic final Transaction beginTransaction() throws IfsException
completeTransaction
or
abortTransaction
IfsException
- (IFS-10651) if the operation failspublic final Transaction beginImplicitTransaction() throws IfsException
completeImplicitTransaction
or
abortImplicitTransaction
.
The token is null if an implicit transaction
is already started.IfsException
- (IFS-10651) if the operation failspublic final Transaction beginReadonlyTransaction() throws IfsException
completeTransaction
or
abortTransaction
IfsException
- (IFS-10651) if the operation failspublic final Transaction beginImplicitReadonlyTransaction() throws IfsException
completeImplicitTransaction
or
abortImplicitTransaction
.
The token is null if an implicit transaction
is already started.IfsException
- (IFS-10651) if the operation failspublic void DMCompleteTransaction(Transaction transaction) throws IfsException
This method should be invoked only by its LibrarySession counterpart.
DMCompleteTransaction
in interface S_LibrarySessionInterface
transaction
- the transaction to completeIfsException
- (IFS-10652) if the operation failspublic final void completeTransaction(Transaction transaction) throws IfsException
transaction
- the transaction to completeIfsException
- (IFS-10652) if the operation failspublic final void completeImplicitTransaction(Transaction transaction) throws IfsException
transaction
- the transaction to completeIfsException
- (IFS-10652) if the operation failspublic void DMAbortTransaction(Transaction transaction) throws IfsException
This method should be invoked only by its LibrarySession counterpart.
DMAbortTransaction
in interface S_LibrarySessionInterface
transaction
- the transaction to abortIfsException
- (IFS-10653) if the operation failspublic final void abortTransaction(Transaction transaction) throws IfsException
transaction
- the transaction to abortIfsException
- (IFS-10653) if the operation failspublic final void abortImplicitTransaction(Transaction transaction) throws IfsException
transaction
- the transaction to abortIfsException
- (IFS-10653) if the operation failspublic final void abortImplicitTransaction(Transaction transaction, IfsException originalException) throws IfsException
If an exception is thrown in aborting the transaction,
originalException
will be nested within IFS-10653.
transaction
- the transaction to abortoriginalException
- the IfsException that caused this
transaction to be abortedIfsException
- (IFS-10653) if the operation failspublic final void abortTransaction(Transaction transaction, IfsException originalException) throws IfsException
If an exception in thrown in aborting the transaction,
originalException
will be nested within IFS-10653.
transaction
- the transaction to abortoriginalException
- the IfsException that caused this
transaction to be abortedIfsException
- (IFS-10653) if the operation failspublic void DMCommit() throws IfsException
This method should be invoked only by its LibrarySession counterpart.
After this method is invoked, attempting to abort any of the in-progress Transactions for this S_LibrarySession will throw an exception.
DMCommit
in interface S_LibrarySessionInterface
IfsException
- (IFS-10654) if the operation failspublic final void commit() throws IfsException
After this method is invoked, attempting to abort any of the in-progress Transactions for this S_LibrarySession will throw an exception.
IfsException
- (IFS-10654) if the operation failspublic void DMRollback() throws IfsException
This method should be invoked only by its LibrarySession counterpart.
After this method is invoked, attempting to complete any of the in-progress Transactions for this S_LibrarySession will throw an exception.
DMRollback
in interface S_LibrarySessionInterface
IfsException
- (IFS-10655) if the operation failspublic final void rollback() throws IfsException
After this method is invoked, attempting to complete any of the in-progress Transactions for this S_LibrarySession will throw an exception.
IfsException
- (IFS-10655) if the operation failspublic boolean DMIsTransactionInProgress() throws IfsException
NOTE: this method intentionally deviates from the standard DMFoo pattern.
DMIsTransactionInProgress
in interface S_LibrarySessionInterface
IfsException
- if the operation failsprotected final boolean isWriteableTransactionInProgress() throws IfsException
IfsException
- if the operation failsprotected final boolean isTransactionInProgress() throws IfsException
IfsException
- if the operation failsprotected final void notifyUncommittedDataCacheEnabled() throws IfsException
This occurs when a writeable transaction is started with no enclosing writeable transactions.
IfsException
- if the operation failsprotected OperationDriver getOperationDriver()
This will return null if no operation is in progress.
protected OperationDriver constructOperationDriver() throws IfsException
This will construct and initialize an OperationDriver, and return that instnace to the caller. It also holds this instance and returns it when getOperationDriver() is invoked.
IfsException
- if the operation failsprotected void destroyOperationDriver()
This is called by the operation which initiated the OperationDriver via a call to constructOperationDriver.
IfsException
- if the operation failspublic Serializable DYNGetCommittedLibraryObjectDataCachePerformanceString(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic Serializable DYNGetCommittedResolvedAclCachePerformanceString(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic final CachePerformance getUncommittedLibraryObjectDataCachePerformance()
public Serializable DYNGetUncommittedLibraryObjectDataCachePerformanceString(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic final CachePerformance getUncommittedResolvedAclCachePerformance()
public Serializable DYNGetUncommittedResolvedAclCachePerformanceString(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic final CachePerformance getLibraryObjectCachePerformance()
public Serializable DYNGetLibraryObjectCachePerformanceString(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic Serializable DYNGetFolderPathCachePerformanceString(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic final IfsConnection getIfsConnection() throws IfsException
A writeable transaction must be in progress; if not, an IfsException (IFS-10665) is thrown.
IfsException
- (IFS-10665) if the operation failspublic final LibraryConnection getLibraryConnection() throws IfsException
If a LibraryConnection is not already assigned to this S_LibrarySession, one is allocated.
IfsException
- (IFS-10656) if the operation failspublic final Connection acquireAuxiliaryConnection() throws IfsException
Each acquired auxiliary Connection should be released as soon as it
is unneeded by invoking releaseAuxiliaryConnection
.
IfsException
- (IFS-10640) if the operation failspublic final LibraryConnection acquireAuxiliaryLibraryConnection() throws IfsException
Each acquired auxiliary LibraryConnection should be released as soon as it
is unneeded by invoking releaseAuxiliaryLibraryConnection
.
IfsException
- (IFS-10640) if the operation failspublic final void releaseAuxiliaryConnection(Connection conn) throws IfsException
Any uncommitted changes are rolled back.
conn
- the Connection to releaseIfsException
- (IFS-10641) if the operation failspublic final void releaseAuxiliaryLibraryConnection(LibraryConnection lconn) throws IfsException
Any uncommitted changes are rolled back.
lconn
- the Connection to releaseIfsException
- (IFS-10641) if the operation failspublic Serializable DYNGetReadonlyConnectionPoolPerformanceString(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic Serializable DYNGetWriteableConnectionPoolPerformanceString(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic void DMRegisterEventHandler(Long id) throws IfsException
DMRegisterEventHandler
in interface S_LibrarySessionInterface
id
- the object ID that has a registered handlerIfsException
- if the operation failspublic void DMDeregisterEventHandler(Long id) throws IfsException
DMDeregisterEventHandler
in interface S_LibrarySessionInterface
id
- the object ID that no longer has any registered handlersIfsException
- if the operation failspublic void DMRegisterClassEventHandler(Long classId) throws IfsException
DMRegisterClassEventHandler
in interface S_LibrarySessionInterface
classId
- the Class ID that has a registered handlerIfsException
- if the operation failspublic void DMDeregisterClassEventHandler(Long classId) throws IfsException
DMDeregisterClassEventHandler
in interface S_LibrarySessionInterface
classId
- the Class ID that no longer has any registered handlersIfsException
- if the operation failspublic void DMRegisterServiceEventHandler(IfsEventHandler handler) throws IfsException
DMRegisterServiceEventHandler
in interface S_LibrarySessionInterface
handler
- the handler to registerIfsException
- if the operation failspublic void DMDeregisterServiceEventHandler(IfsEventHandler handler) throws IfsException
DMDeregisterServiceEventHandler
in interface S_LibrarySessionInterface
handler
- the handler to de-register; if null, de-register all
service handlersIfsException
- if the operation failspublic final void registerEventHandler(S_LibraryObject lo, IfsEventHandler handler) throws IfsException
This method allows any object implementing the IfsEventHandler interface to receive notification of events for any LibraryObject.
lo
- the S_LibraryObject of interesthandler
- the IfsEventHandlerIfsException
- (IFS-11000) if the operation failspublic final void deregisterEventHandler(S_LibraryObject lo, IfsEventHandler handler) throws IfsException
lo
- the S_LibraryObject. If null, all S_LibraryObjects
previously registered for the IfsEventHandler
using registerEventHandler
are
deregistered.handler
- the IfsEventHandler. If null, all
IfsEventHandlers previously registered
for the S_LibraryObject using
registerEventHandler
are deregistered.IfsException
- (IFS-11001) if the operation failspublic final void registerClassEventHandler(S_ClassObject co, boolean includeSubclasses, IfsEventHandler handler) throws IfsException
This method allows any object implementing the IfsEventHandler interface to receive notification of events for any S_LibraryObject.
co
- the S_ClassObject of interestincludeSubclasses
- whether to include current subclasses
of co
; if a new subclass is
subsequently created, it must be explicitly
registered for IfsEventHandler to receive
events on S_LibraryObjects of that new classhandler
- the IfsEventHandlerIfsException
- (IFS-11000) if the operation failspublic final void deregisterClassEventHandler(S_ClassObject co, boolean includeSubclasses, IfsEventHandler handler) throws IfsException
co
- the S_ClassObject. If null, all S_ClassObjects
previously registered for the IfsEventHandler
using registerClassEventHandler
are
deregistered.includeSubclasses
- whether to include current subclasses
of co
handler
- the IfsEventHandler. If null, all
IfsEventHandlers previously registered
for the S_ClassObject using
registerClassEventHandler
are
deregistered.IfsException
- (IFS-11001) if the operation failspublic final void DMPostEvent(IfsEvent event) throws IfsException
DMPostEvent
in interface S_LibrarySessionInterface
event
- the eventIfsException
- if the operation failsprotected final void postEvent(IfsEvent event) throws IfsException
event
- the eventIfsException
- if the operation failsprotected final void queueEventForProcessing(IfsEvent event) throws IfsException
This method is invoked by S_LibrarySession.postEvent()
for events originating in this session. It is also invoked by
S_LibraryService.processEvent()
for events originating
in other sessions.
event
- the event to processIfsException
- if the operation failspublic void DMProcessEvents() throws IfsException
DMProcessEvents
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic void DMFlushEvents() throws IfsException
DMFlushEvents
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic void DMForceReadEvents() throws IfsException
DMForceReadEvents
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic Vector DMProcessEventsInBackground() throws IfsException
DMProcessEventsInBackground
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic void flushEvents() throws IfsException
IfsException
- if the operation failspublic void handleEvent(IfsEvent event) throws IfsException
handleEvent
in interface IfsEventHandler
event
- the eventIfsException
- if the operation failspublic void DMPostAuditEvent(AuditEvent event, int mode) throws IfsException
DMPostAuditEvent
in interface S_LibrarySessionInterface
event
- the event to addmode
- the success/fail mode for the postIfsException
- if the operation failspublic Long DMDirectlyDispatchAuditEvent(AuditEvent event, Long specId) throws IfsException
DMDirectlyDispatchAuditEvent
in interface S_LibrarySessionInterface
event
- the event to directly addspecId
- the AuditSpecification (event history) IDIfsException
- if the operation failspublic RawAuditEvent[] DMSelectRawAuditEvents(String filterClause, int maxItems) throws IfsException
The filter clause is almost always set to null.
DMSelectRawAuditEvents
in interface S_LibrarySessionInterface
filterClause
- the filter criteria (where clause)maxItems
- max number of items to returnIfsException
- if the operation failspublic void DMRemoveRawAuditEvents(RawAuditEvent[] rawEvents) throws IfsException
Should only be done after the raw event has been dispatched.
DMRemoveRawAuditEvents
in interface S_LibrarySessionInterface
rawEvents
- array of events to freeIfsException
- if the operation failspublic void DMHandleAuditEventDispatchRequests(ArrayList reqList, String tableName) throws IfsException
DMHandleAuditEventDispatchRequests
in interface S_LibrarySessionInterface
reqList
- a list of AuditEventDispatchRequesttableName
- the table name where the events are to be storedIfsException
- if the operation failspublic AuditEvent[] DMSelectAuditEvents(Long auditSpec, String filterClause, AttributeValue[] bindValues, String sortClause, int maxItems) throws IfsException
DMSelectAuditEvents
in interface S_LibrarySessionInterface
auditSpec
- the audit history ID to searchfilterClause
- the filter criteria (where clause)bindValues
- the bind values to include withthe filter clausesortClause
- the sort criteria (order by clause)maxItems
- max number of items to returnIfsException
- if the operation failspublic AttributeValue[] DMSelectAggregateAuditEventColumns(Long auditSpec, String aggFunction, String[] columnNames, String[] innerColNames, String filterClause, String sortClause) throws IfsException
DMSelectAggregateAuditEventColumns
in interface S_LibrarySessionInterface
auditSpec
- the audit history ID to searchaggFunction
- the SQL aggregate function (can be null)columnNames
- the audit table column names to selectinnerColNames
- the audit table column names to use in the
inner select; if null, no inner select is usedfilterClause
- the filter criteria (where clause)sortClause
- the sort criteria (order by clause)IfsException
- if the operation failspublic void DMRemoveAuditEvents(long[] eventIds, String tableName) throws IfsException
Should only be done for normal disposition of audit histories.
DMRemoveAuditEvents
in interface S_LibrarySessionInterface
eventIds
- array of event IDstableName
- event table nameIfsException
- if the operation failspublic void DMRemoveAuditEventsForTarget(Long specId, Long targetId) throws IfsException
DMRemoveAuditEventsForTarget
in interface S_LibrarySessionInterface
specId
- the audit history identifiertargetId
- the target IDIfsException
- if the operation failspublic Serializable DYNDeleteUnusedAuditProperties(Serializable payload) throws IfsException
Performed as a periodic cleanup task.
payload
- ignoredIfsException
- if the operation failspublic Serializable DYNSelectUnusedAuditTypeLists(Serializable payload) throws IfsException
Performed during a periodic cleanup task.
payload
- expirationPeriod in ms (Long object)IfsException
- if the operation failspublic AuditFolderPath DMSelectSpecificAuditFolderPath(long folderPathId) throws IfsException
DMSelectSpecificAuditFolderPath
in interface S_LibrarySessionInterface
folderPathId
- the folder path ID of interestIfsException
- if the operation failspublic Serializable DYNDeleteExpiredAuditFolderPaths(Serializable payload) throws IfsException
Performed as a periodic cleanup task.
payload
- expiration period in milliseconds (as a Long)IfsException
- if the operation failspublic Serializable DYNDeleteExpiredGlobalAuditEvents(Serializable payload) throws IfsException
Performed as a periodic cleanup task.
payload
- a Vector containing three elements in order as shown
below.
IfsException
- if the operation failspublic Serializable DYNDeleteUnusedAuditFolderPathOverflowEntries(Serializable payload) throws IfsException
Performed as a periodic cleanup task.
payload
- ignoredIfsException
- if the operation failspublic int DMRegisterAuditEventOperationType(String opTypeKey, int targetCode, String targetClass, int opCode, Boolean createOrFree) throws IfsException
Occurs during schema creation, upgrade, and when registering new custom event types. Is coded so that services can be running, as they correctly invalidate their type map caches.
DMRegisterAuditEventOperationType
in interface S_LibrarySessionInterface
opTypeKey
- operation type keytargetCode
- code for the target object typetargetClass
- class name for the target object typeopCode
- code for the type of operationcreateOrFree
- indication as to whther the operation is
a Create (true) or Free (false) operation;
should be null if neitherIfsException
- if the operation failspublic void DMUnregisterAuditEventOperationType(String opTypeKey) throws IfsException
Only occurs during upgrade, but is coded so that services can be running, as they correctly invalidate their type map caches.
DMUnregisterAuditEventOperationType
in interface S_LibrarySessionInterface
opTypeKey
- operation type keyIfsException
- if the operation failspublic int[] DMLookupAuditEventOperationTypes(String[] opTypeKeys) throws IfsException
DMLookupAuditEventOperationTypes
in interface S_LibrarySessionInterface
opTypeKeys
- operation type keysIfsException
- if the operation failspublic String[] DMLookupAuditEventOperationTypeKeys(int[] opTypes) throws IfsException
DMLookupAuditEventOperationTypeKeys
in interface S_LibrarySessionInterface
opTypes
- numeric operation typesIfsException
- if the operation failspublic AuditTargetCode DMLookupAuditTargetCode(String className) throws IfsException
DMLookupAuditTargetCode
in interface S_LibrarySessionInterface
className
- class name associated with a registered
audit target typeIfsException
- if the operation failspublic AttributeValue[] DMGetAuditTypesForClass(String className, boolean includeNested) throws IfsException
The AttributeValues returned use the operation type key as the name, and the numeric operation type as the value.
DMGetAuditTypesForClass
in interface S_LibrarySessionInterface
className
- the class name of interest, force to upper case
(e.g. FOLDER)includeNested
- whether or not to include operations for classes
that are descendents of the specified classIfsException
- if the operation failspublic AttributeValue[] DMGetAuditTypesForCreateOperations() throws IfsException
Used to indicate when an object has been created simply by inspecting event types.
DMGetAuditTypesForCreateOperations
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic AttributeValue[] DMGetAuditTypesForFreeOperations() throws IfsException
Used to indicate when an object has been freed simply by inspecting event types.
DMGetAuditTypesForFreeOperations
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic AttributeValue[] DMGetCustomAuditTypes() throws IfsException
DMGetCustomAuditTypes
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic int DMRegisterCustomAuditEventOperationCodeKey(String opCodeKey) throws IfsException
If the key is already registered, this simply returns the numeric value of the previous registration.
DMRegisterCustomAuditEventOperationCodeKey
in interface S_LibrarySessionInterface
opCodeKey
- operation code key; e.g. "FAXED"IfsException
- if the operation failspublic long DMGetHighestAuditId() throws IfsException
Currently approximates this by selecting the next ID by selecting from the audit sequence, and subtracting 1.
DMGetHighestAuditId
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic AuditCertificate[] DMGetAuditCertificates(Long[] objectIds) throws IfsException
DMGetAuditCertificates
in interface S_LibrarySessionInterface
objectIds
- object IDsIfsException
- if the operation failspublic void postAuditEvent(AuditEvent event, int mode) throws IfsException
event
- the event to addmode
- the success/fail mode for the postIfsException
- if the operation failspublic Long directlyDispatchAuditEvent(AuditEvent event, Long specId) throws IfsException
event
- the event to directly addspecId
- the AuditSpecification (event history) IDIfsException
- if the operation failsprotected void postAuditEventsUponCommit(LibraryConnection lconn, Connection conn, List rawEventList) throws IfsException
This is called as a normal part of an completeTransaction operation,
initiated from within UncommittedLibraryObjectDataCache
.
lconn
- the repos connectionconn
- the JDBC connectionrawEventList
- list of AuditExecutor.PreparedRawAuditEventIfsException
- if the operation failsprotected void postFailedAuditEventsUponRollback(LibraryConnection lconn, Connection conn, List rawEventList) throws IfsException
This is called as a normal part of an abortTransaction operation,
initiated from within UncommittedLibraryObjectDataCache
.
lconn
- the repos connectionconn
- the JDBC connectionrawEventList
- list of AuditExecutor.PreparedRawAuditEventIfsException
- if the operation failsprotected void scheduleRawAuditEvent(AuditExecutor.PreparedRawAuditEvent rawEvent, int postMode) throws IfsException
This is called from AuditExecutor to schedule posting audit events in coordination with the current transaction.
rawEvent
- the raw event to schedulepostMode
- the post mode for the eventIfsException
- if the operation failsprotected AuditFolderPath selectLatestAuditFolderPath(Long folderId) throws IfsException
Delegates to AuditExecutor.
folderId
- the folder ID of interestIfsException
- if the operation failspublic AuditEvent[] selectAuditEvents(Long auditSpec, String filterClause, String sortClause, int maxItems) throws IfsException
auditSpec
- the audit history ID to searchfilterClause
- the filter criteria (where clause)sortClause
- the sort criteria (order by clause)maxItems
- max number of items to returnIfsException
- if the operation failspublic AuditEvent[] selectAuditEvents(Long auditSpec, String filterClause, AttributeValue[] bindValues, String sortClause, int maxItems) throws IfsException
auditSpec
- the audit history ID to searchfilterClause
- the filter criteria (where clause)bindValues
- the bind values to include withthe filter clausesortClause
- the sort criteria (order by clause)maxItems
- max number of items to returnIfsException
- if the operation failspublic AttributeValue[] selectAggregateAuditEventColumns(Long auditSpec, String aggFunction, String[] columnNames, String[] innerColNames, String filterClause, String sortClause) throws IfsException
auditSpec
- the audit history ID to searchaggFunction
- the SQL aggregate function (can be null)columnNames
- the audit table column names to selectinnerColNames
- the audit table column names to use in the
inner select; if null, no inner select is usedfilterClause
- the filter criteria (where clause)sortClause
- the sort criteria (order by clause)IfsException
- if the operation failspublic void removeAuditEvents(long[] eventIds, String tableName) throws IfsException
Should only be done for normal disposition of audit histories.
eventIds
- array of event IDstableName
- event table nameIfsException
- if the operation failspublic void removeAuditEventsForTarget(Long specId, Long targetId) throws IfsException
specId
- the audit history identifiertargetId
- the target IDIfsException
- if the operation failspublic AuditFolderPath selectSpecificAuditFolderPath(long folderPathId) throws IfsException
folderPathId
- the folder path ID of interestIfsException
- if the operation failspublic void deleteUnusedAuditProperties() throws IfsException
Performed as a periodic cleanup task.
IfsException
- if the operation failspublic ArrayList selectUnusedAuditTypeLists(long expirationPeriod) throws IfsException
Performed during a periodic cleanup task.
expirationPeriod
- expiration periodIfsException
- if the operation failspublic void deleteExpiredAuditFolderPaths(long expPeriod) throws IfsException
Performed as a periodic cleanup task.
expPeriod
- the minimum amount of time, in milliseconds, that
the AuditFolderPaths have to be expired in order
to be deletedIfsException
- if the operation failspublic void deleteExpiredGlobalAuditEvents(Long domainId, Long specId, Long expPeriod) throws IfsException
Performed as a periodic cleanup task.
domainId
- domain on which we are working onspecId
- global audit spec idexpPeriod
- the minimum amount of time, in milliseconds, that
the GlobalAuditEvents have to be expired in order
to be deleted; if null, no expirationIfsException
- if the operation failspublic void deleteUnusedAuditFolderPathOverflowEntries() throws IfsException
Performed as a periodic cleanup task.
IfsException
- if the operation failspublic int registerAuditEventOperationType(String opTypeKey, int targetCode, String targetClass, int opCode, Boolean createOrFree) throws IfsException
Only occurs during schema creation and upgrade, but is coded so that services can be running, as they correctly invalidate their type map caches.
opTypeKey
- operation type keytargetCode
- code for the target object typetargetClass
- class name for the target object typeopCode
- code for the type of operationcreateOrFree
- indication as to whther the operation is
a Create (true) or Free (false) operation;
should be null if neitherIfsException
- if the operation failspublic int registerCustomAuditEventOperationCodeKey(String opCodeKey) throws IfsException
If the key is already registered, this simply returns the numeric value of the previous registration.
opCodeKey
- operation code key; e.g. "FAXED"IfsException
- if the operation failspublic void unregisterAuditEventOperationType(String opTypeKey) throws IfsException
Only occurs during upgrade, but is coded so that services can be running, as they correctly invalidate their type map caches.
opTypeKey
- operation type keyIfsException
- if the operation failspublic AttributeValue[] getAuditTypesForClass(String className, boolean includeNested) throws IfsException
The AttributeValues returned use the operation type key as the name, and the numeric operation type as the value.
className
- the class name of interest, force to upper case
(e.g. FOLDER)includeNested
- whether or not to include operations for classes
that are descendents of the specified classIfsException
- if the operation failspublic AttributeValue[] getAuditTypesForCreateOperations() throws IfsException
Used to indicate when an object has been created simply by inspecting event types.
IfsException
- if the operation failspublic AttributeValue[] getAuditTypesForFreeOperations() throws IfsException
Used to indicate when an object has been freed simply by inspecting event types.
IfsException
- if the operation failspublic AttributeValue[] getCustomAuditTypes() throws IfsException
IfsException
- if the operation failspublic int[] lookupAuditEventOperationTypes(String[] opTypeKeys) throws IfsException
opTypeKeys
- operation type keysIfsException
- if the operation failspublic String[] lookupAuditEventOperationTypeKeys(int[] opTypes) throws IfsException
opTypes
- numeric operation typesIfsException
- if the operation failspublic AuditTargetCode lookupAuditTargetCode(String className) throws IfsException
className
- class name associated with a registered
audit target typeIfsException
- if the operation failspublic String lookupAuditEventOperationTypeKey(int opType) throws IfsException
opType
- numeric operation typeIfsException
- if the operation failspublic long getHighestAuditId() throws IfsException
Currently approximates this by selecting the next ID in a way that ensures the ID will never be used for an event.
IfsException
- if the operation failspublic AuditCertificate[] getAuditCertificates(Long[] objectIds) throws IfsException
objectIds
- object IDsIfsException
- if the operation failsprotected BoundedCache getAuditCertificateCache()
protected BoundedCache getAuditInlineStringCache()
protected BoundedCache getAuditInlineStringReferenceCache()
public DirectoryService getDirectoryService() throws IfsException
IfsException
- if the operation failspublic Serializable DYNCredentialManagerAuthenticate(Serializable payload) throws IfsException
This does not create a new session or change the existing session in any way. It simply determines the whether the supplied credential is valid for the specified distinguished name. It does not check the existence of a DirectoryUser for that user.
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API; instead, operate directly on the
DirectoryService obtained by calling getDirectoryService
.
To invoke this method, the session must be in administration mode.
The payload
must be a Vector containing four String
elements, as follows:
payload
- see method descriptionIfsException
- if the operation failspublic Serializable DYNCredentialManagerUserExists(Serializable payload) throws IfsException
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API; instead, operate directly on the
DirectoryService obtained by calling getDirectoryService
.
The payload
must be a Vector containing two String
elements, as follows:
payload
- see method descriptionIfsException
- if the operation failspublic Serializable DYNCredentialManagerSupportsCreateUser(Serializable payload) throws IfsException
DYNCredentialManagerCreateUser
method.
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API; instead, operate directly on the
DirectoryService obtained by calling getDirectoryService
.
payload
- the String name of the CredentialManagerDYNCredentialManagerCreateUser
is supportedIfsException
- if the operation failspublic Serializable DYNCredentialManagerSupportsDeleteUser(Serializable payload) throws IfsException
DYNCredentialManagerDeleteUser
method.
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API; instead, operate directly on the
DirectoryService obtained by calling getDirectoryService
.
payload
- the String name of the CredentialManagerDYNCredentialManagerDeleteUser
is supportedIfsException
- if the operation failspublic Serializable DYNCredentialManagerSupportsSetPassword(Serializable payload) throws IfsException
DYNCredentialManagerSetPassword
method.
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API; instead, operate directly on the
DirectoryService obtained by calling getDirectoryService
.
payload
- the String name of the CredentialManagerDYNCredentialManagerSetPassword
is supportedIfsException
- if the operation failspublic Serializable DYNCredentialManagerSupportsListUsers(Serializable payload) throws IfsException
DYNCredentialManagerListUsers
method.
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API; instead, operate directly on the
DirectoryService obtained by calling getDirectoryService
.
payload
- the String name of the CredentialManagerDYNCredentialManagerListUsers
is supportedIfsException
- if the operation failspublic Serializable DYNCredentialManagerGetProperty(Serializable payload) throws IfsException
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API; instead, operate directly on the
DirectoryService obtained by calling getDirectoryService
.
The payload
must be a Vector containing two elements,
as follows:
payload
- see method descriptionIfsException
- if the operation failspublic Serializable DYNCredentialManagerCreateInitialContext(Serializable payload) throws IfsException
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API.
The payload
must be a Vector containing at least the
following first two elements and optionally the last two elements:
payload
may be the String name of
an OidCredentialManager running in the current LibraryService.
The returned value is a Vector of one element, which is the
javax.naming.directory.DirContext
of the JNDI connection.
payload
- see method descriptionIfsException
- if the operation failspublic Serializable DYNRemoveInvalidTokenCredentials(Serializable payload) throws IfsException
A Token Credential is expired when its timeout value is less than current time. A Token Credential is expended when its remaining authorization count is <= 0.
payload
- ignoredIfsException
- (IFS-10199) if the operation failspublic void DMPersistTokenCredential(TokenCredential credential) throws IfsException
DMPersistTokenCredential
in interface S_LibrarySessionInterface
credential
- the TokenCredentialIfsException
- (IFS-10191) if the operation failspublic boolean DMReauthenticate(Credential credential, ConnectOptions options) throws IfsException
getAuthenticatedUser
).
This does not create a new session or change the existing session in any way. It simply determines the whether the supplied credential is a valid credential for the previously authenticated DIRECTORYUSER.
DMReauthenticate
in interface S_LibrarySessionInterface
credential
- the credential to authenticate; this must
be a credential for the authenticated user
of this S_LibrarySessionoptions
- the ConnectOptions supplied by the usercredential
is a valid
credentialIfsException
- (IFS-10162) if the operation fails (other
than the supplied credential simply being invalid)public boolean reauthenticate(Credential credential, ConnectOptions options) throws IfsException
getAuthenticatedUser
).
This does not create a new session or change the existing session in any way. It simply determines the whether the supplied credential is a valid credential for the previously authenticated DIRECTORYUSER.
credential
- the credential to authenticate; this must
be a credential for the authenticated user
of this S_LibrarySessionoptions
- the ConnectOptions supplied by the usercredential
is a valid
credentialIfsException
- (IFS-10162) if the operation fails (other
than the supplied credential simply being invalid)public Serializable DYNGetRichMediaDocsWithoutRichMediaCategories(Serializable payload) throws IfsException
payload
- the Long class id of the media against which to
search.IfsException
- if the operation fails.public final TraceLogger getTraceLogger() throws IfsException
getTraceLogger
in interface Traceable
IfsException
- if the operation failspublic final boolean isTraced(int channel, int level) throws IfsException
isTraced
in interface Traceable
channel
- the channel numberlevel
- the levelIfsException
- (IFS-11201) if the channel is invalidpublic final void DMTrace(int channel, int level, Long serviceId, Long sessionId, Long id, String className, String payload) throws IfsException
DMTrace
in interface S_LibrarySessionInterface
channel
- the channel numberlevel
- the levelserviceId
- the service id of the object performing the tracesessionId
- the session id of the object performing the trace,
or 0 if the trace is requested by a serviceid
- the id of the object performing the trace, or 0
if the trace is requested by a service or sessionclassName
- the classname of the object performing the tracepayload
- a string containing any additional information to
be placed in the trace logIfsException
- if the operation failspublic final void trace(int channel, int level, String payload)
public final void DMSetSessionTraceLoggerLevels(int[] levels) throws IfsException
DMSetSessionTraceLoggerLevels
in interface S_LibrarySessionInterface
levels
- an array of levels. The array index
corresponds to the channel number.IfsException
- if the operation failspublic final int[] DMGetSessionTraceLoggerLevels() throws IfsException
DMGetSessionTraceLoggerLevels
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic final void DMSetServiceTraceLoggerLevels(int[] levels) throws IfsException
DMSetServiceTraceLoggerLevels
in interface S_LibrarySessionInterface
levels
- an array of levels. The array index
corresponds to the channel number.IfsException
- if the operation failspublic final int[] DMGetServiceTraceLoggerLevels() throws IfsException
DMGetServiceTraceLoggerLevels
in interface S_LibrarySessionInterface
IfsException
- if the operation failspublic Serializable DYNDeleteOldFilteredContent(Serializable payload) throws IfsException
payload
- a Long indicating the number of seconds
at which a row is old enough to deleteIfsException
- if the operation failspublic Serializable DYNCleanUpDanglingObjectReferences(Serializable payload) throws IfsException
payload
must be a Vector containing three string
elements, as follows:
payload
- see method descriptionIfsException
- if the operation failspublic Serializable DYNCleanUpDanglingArrayReferences(Serializable payload) throws IfsException
payload
- see method descriptionIfsException
- if the operation failspublic Serializable DYNPurgeEvents(Serializable payload) throws IfsException
payload
- the Long maximum desired event age, in seconds,
or null if unspecifiedIfsException
- if the operation failspublic Serializable DYNCleanupDeadServices(Serializable payload) throws IfsException
payload
- the Long period, in seconds, after which a
service for which no keep-alive packets have
been received is deemed deadIfsException
- if the operation failspublic Serializable DYNVacuumAnalyze(Serializable payload) throws IfsException
payload
- no payload is expected for this opeationIfsException
- if the operation failspublic Vector DMGetExpiredTimedLocks(int maxItems, int offset) throws IfsException
DMGetExpiredTimedLocks
in interface S_LibrarySessionInterface
maxItems
- the maximum number of entries to returnoffset
- the offset to be used in the query for expired locksIfsException
- if the operation failspublic int DMReleaseExpiredLockObject(Long id, Long classId) throws IfsException
DMReleaseExpiredLockObject
in interface S_LibrarySessionInterface
id
- the ID of the LockObject to releaseclassId
- the class ID of the LockObject to releaseIfsException
- if the operation failspublic void DMApplyFolderIndexDeferredUpdate(FolderIndexDeferredUpdate entry) throws IfsException
DMApplyFolderIndexDeferredUpdate
in interface S_LibrarySessionInterface
entry
- the Folder index deferred entryIfsException
- if the operation failspublic Vector DMGetFolderIndexDeferredUpdates(int maxItems) throws IfsException
DMGetFolderIndexDeferredUpdates
in interface S_LibrarySessionInterface
maxItems
- the maximum number of entries to returnIfsException
- if the operation failspublic Serializable DYNIsFolderIndexEnabled(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic Serializable DYNInitializeFolderIndexTables(Serializable payload) throws IfsException
payload
- an Integer containing the initial max levelIfsException
- if the operation failspublic Serializable DYNChangeFolderIndexUpdateMode(Serializable payload) throws IfsException
payload
- the desired update mode as a Boolean;
true indicates synchronous,
false indicates asynchronousIfsException
- if the operation failspublic Serializable DYNTruncateFolderIndexTables(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic Serializable DYNCreateInitialSelfRows(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic Serializable DYNCreateInitialDeferredEntries(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic Serializable DYNResetFolderIndex(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic Serializable DYNGetFoldersNeedingPromotion(Serializable payload) throws IfsException
payload
- Vector containing Integer objects maxParentsThreshold,
maxChildrenThreshold and level in that order.IfsException
- if the operation failspublic Serializable DYNGetFolderIndexMaxLevel(Serializable payload) throws IfsException
payload
- null; ignoredIfsException
- if the operation failspublic Serializable DYNIsFolderIndexUpdateModeSynchronous(Serializable payload) throws IfsException
payload
- null; ignoredIfsException
- if the operation failspublic Serializable DYNCompleteIndexCreation(Serializable payload) throws IfsException
payload
- ignoredIfsException
- if the operation failspublic Serializable DYNChangeAclResolutionMode(Serializable payload) throws IfsException
payload
- the desired update mode as a Boolean;
true indicates synchronous,
false indicates asynchronousIfsException
- if the operation failsprotected S_LibraryObjectDataSharedStateFactory getSharedStateFactory()
protected final S_LibraryObjectDataSharedState constructSharedState()
The type returned is controlled by the Shared State factory in effect for the domain.
public Serializable DYNCredentialManagerCreateUser(Serializable payload) throws IfsException
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API; instead, operate directly on the
DirectoryService obtained by calling getDirectoryService
.
The payload
must be a Vector containing three elements,
as follows:
options
element
was introduced in iFS 9.0.2. Although it is currently optional, future
releases of CM SDK will require that it be specified.payload
- see method descriptionIfsException
- if the operation failspublic Serializable DYNCredentialManagerListUsers(Serializable payload) throws IfsException
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API; instead, operate directly on the
DirectoryService obtained by calling getDirectoryService
.
The payload
must be a Vector containing two elements,
as follows:
payload
- see method descriptionIfsException
- if the operation failspublic Serializable DYNCredentialManagerSetPassword(Serializable payload) throws IfsException
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API; instead, operate directly on the
DirectoryService obtained by calling getDirectoryService
.
The payload
must be a Vector containing four elements,
as follows:
options
element
was introduced in iFS 9.0.2. Although it is currently optional, future
releases of CM SDK will require that it be specified.payload
- see method descriptionIfsException
- if the operation failspublic Serializable DYNCredentialManagerDeleteUser(Serializable payload) throws IfsException
This method should only be invoked from the beans API by calling
invokeServerMethod
on LibrarySession. Do not call
this method from the server API; instead, operate directly on the
DirectoryService obtained by calling getDirectoryService
.
The payload
must be a Vector containing three elements,
as follows:
options
element
was introduced in iFS 9.0.2. Although it is currently optional, future
releases of CM SDK will require that it be specified.payload
- see method descriptionIfsException
- if the operation failsCopyright © 2023. All rights reserved.