public class LibraryService extends Object implements LibraryConstants
CM SDK services are uniquely identified by name within each process. This class provides static methods to determine whether a specified service has been started, to find a service by name, and to start a new service in this process.
To connect to an CM SDK service, thereby creating a new CM SDK session,
call the connect(Credential, ConnectOptions)
method.
Modifier and Type | Field and Description |
---|---|
static String |
JDBCDRIVERTYPE_OCI8
The JDBC OCI8 driver.
|
static String |
JDBCDRIVERTYPE_THIN
The JDBC Thin driver.
|
static String |
RESOURCES_BASENAME
The repository resource bundle.
|
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 and Type | Method and Description |
---|---|
LibrarySession |
connect(Credential credential,
ConnectOptions options)
Connects to this CM SDK service, creating a new CM SDK session.
|
void |
dispose(DataSource dataSource)
Disposes the sevice.
|
void |
dispose(String schemaPassword)
Disposes this service.
|
void |
dispose(SystemUserCredential cred)
Disposes the sevice.
|
static LibraryObjectLookupCache |
findLibraryObjectLookupCache(LibrarySessionInterface session,
String key)
Finds a registered LibraryObjectLookupCache instance by key.
|
static LibraryService |
findService(String serviceName)
Finds an existing CM SDK service with the specified name.
|
CredentialNameTokenizer |
getCredentialNameTokenizer()
Gets the CredentialNameTokenizer for this CM SDK service.
|
static String |
getDatabaseUrlUsingDomainName(String domainName,
String jdbcDriverType)
Deprecated.
9.2.5: use 3-arg variant of
getDatabaseUrlUsingDomainName |
static String |
getDatabaseUrlUsingDomainName(String databaseType,
String domainName,
String jdbcDriverType)
Resolves a domain name to a database URL.
|
GssApiCredential |
getGssApiCredential(byte[] inputTicket,
Hashtable parameters)
Gets a new GssApiCredential using the supplied ticket.
|
Long |
getId()
Gets the ID that identifies this service instance.
|
static String |
getSchemaName(String domainName)
Resolves a domain name to a schema name.
|
static AttributeValue[] |
getServiceConfigurationProperties(String serviceConfigurationName,
DataSource ds)
Gets service configuration properties from a ServiceConfiguration
object.
|
static AttributeValue[] |
getServiceConfigurationProperties(String domainName,
String schemaPassword,
String serviceConfigurationName)
Deprecated.
9.2.5: use
getServiceConfigurationProperties(String, DataSource) |
static AttributeValue[] |
getServiceConfigurationProperties(String schemaPassword,
String serviceConfigurationName,
String databaseUrl,
String schemaName)
Deprecated.
9.2.5: use
getServiceConfigurationProperties(String, DataSource) |
TokenCredential |
getTokenCredential(String token,
Hashtable parameters)
Gets the previously-created TokenCredential for the specified token.
|
static long |
getVersionNumber()
Gets the software version as a long.
|
static String |
getVersionString()
Gets the software version as a string.
|
void |
invalidateTokenCredential(String token,
Hashtable parameters)
Invalidates the previously-created TokenCredential for the specified
token.
|
static boolean |
isPostgres()
Returns true if a Postgres service is active.
|
static boolean |
isServiceStarted(String serviceName)
Determines whether there exists an CM SDK service with the specified name.
|
static void |
registerLibraryObjectLookupCache(LibrarySessionInterface session,
String key,
LibraryObjectLookupCache lolc)
Register a LibraryObjectLookupCache instance by key.
|
static Vector |
selectProperties(Connection conn,
String fromWhereOrderBy,
String propertyTableAlias,
Object[] bindValues)
Gets a set of Properties as AttributeValues using raw JDBC.
|
void |
setBootstrapClassPolicyActionContexts(HashMap pacs,
String schemaPassword)
Puts the service in "policy bootstrap" mode.
|
static void |
setPostgres()
Sets Postgres service is active.
|
static LibraryService |
startService(String serviceName,
String schemaPassword,
String serviceConfigurationName,
String domainName)
Starts a new CMSDK service.
|
static LibraryService |
startService(String serviceName,
String nodeName,
String schemaPassword,
String serviceConfigurationName,
String domainName)
Starts a new CMSDK service.
|
static LibraryService |
startService(String serviceName,
String nodeName,
String schemaPassword,
String serviceConfigurationName,
String domainName,
String databaseType)
Starts a new CMSDK service.
|
static LibraryService |
startService(String serviceName,
String schemaPassword,
String serviceConfigurationName,
String schemaName,
String domainDisplayName,
String databaseUrl,
String domainName)
Starts a new CMSDK service.
|
static LibraryService |
startService(String serviceName,
String nodeName,
String schemaPassword,
String serviceConfigurationName,
String schemaName,
String domainDisplayName,
String databaseUrl,
String domainName)
Starts a new CMSDK service.
|
static LibraryService |
startService(String serviceName,
String nodeName,
String schemaPassword,
String serviceConfigurationName,
String schemaName,
String domainDisplayName,
String databaseUrl,
String domainName,
String databaseType)
Starts a new CMSDK service.
|
static LibraryService |
startServiceUsingDatabaseUrl(String serviceName,
String nodeName,
String schemaPassword,
String serviceConfigurationName,
String schemaName,
String databaseUrl)
Starts a new CMSDK service.
|
static LibraryService |
startServiceUsingDatabaseUrl(String serviceName,
String nodeName,
String schemaPassword,
String serviceConfigurationName,
String schemaName,
String databaseUrl,
String databaseType)
Starts a new CMSDK service.
|
static LibraryService |
startServiceUsingDataSource(String serviceName,
String nodeName,
String serviceConfigurationName,
DataSource ds)
Deprecated.
9.2.5: use 5-arg variant of
startServiceUsingDataSource |
static LibraryService |
startServiceUsingDataSource(String serviceName,
String nodeName,
String serviceConfigurationName,
DataSource ds,
String databaseType)
Starts a new CMSDK service.
|
public static final String RESOURCES_BASENAME
public static final String JDBCDRIVERTYPE_THIN
public static final String JDBCDRIVERTYPE_OCI8
public Long getId() throws IfsException
IfsException
- (IFS-20100) if the operation failspublic static LibraryService findService(String serviceName) throws IfsException
If there is no service with that name, an exception is thrown.
serviceName
- the name of the serviceIfsException
- (IFS-20100) if the operation failspublic static boolean isServiceStarted(String serviceName) throws IfsException
serviceName
- the name of the serviceIfsException
- (IFS-20101) if the operation failspublic static LibraryService startService(String serviceName, String schemaPassword, String serviceConfigurationName, String domainName) throws IfsException
See notes on the 6-arg variant of startService
.
serviceName
- the name to assign to the serviceschemaPassword
- the password of the CMSDK schemaserviceConfigurationName
- the service configuration (see above);
if null a default configuration is useddomainName
- the domain name (see above)IfsException
- (IFS-20102) if the operation failspublic static LibraryService startService(String serviceName, String nodeName, String schemaPassword, String serviceConfigurationName, String domainName) throws IfsException
See notes on the 6-arg variant of startService
.
serviceName
- the name to assign to the servicenodeName
- the name of the node that runs this serviceschemaPassword
- the password of the CMSDK schemaserviceConfigurationName
- the service configuration (see above);
if null a default configuration is useddomainName
- the domain name (see above)IfsException
- (IFS-20102) if the operation failspublic static LibraryService startService(String serviceName, String nodeName, String schemaPassword, String serviceConfigurationName, String domainName, String databaseType) throws IfsException
To start a service, you must specify three things:
serviceConfigurationName
and a
domainName
.
The serviceConfigurationName
specifies the name
of the desired SERVICECONFIGURATION object.
The domainName
identifies the CMSDK schema.
It has the format
ifs://host:port:globalDatabaseName:schema
,
where host
is the hostname of the database
server, port
is the port number of the database
listener, globalDatabaseName
is the global
database name, and schema
is the CMSDK schema
name. For example,
ifs://test.foo.com:1521:ora.test_foo_com:ifssys
.
serviceName
- the name to assign to the servicenodeName
- the name of the node that runs this serviceschemaPassword
- the password of the CMSDK schemaserviceConfigurationName
- the service configuration (see above);
if null a default configuration is useddomainName
- the domain name (see above)databaseType
- the database type ("oracle" or "postgres");
if null, assume oracleIfsException
- (IFS-20102) if the operation failspublic static LibraryService startService(String serviceName, String schemaPassword, String serviceConfigurationName, String schemaName, String domainDisplayName, String databaseUrl, String domainName) throws IfsException
See notes on the 9-arg variant of startService
.
serviceName
- the name to assign to the serviceschemaPassword
- the password of the CMSDK schemaserviceConfigurationName
- the service configuration (see above);
if null a default configuration is usedschemaName
- the schema name (see above)domainDisplayName
- this parameter is ignoreddatabaseUrl
- the database url (see above)domainName
- the domain name (see above)IfsException
- (IFS-20102) if the operation failspublic static LibraryService startService(String serviceName, String nodeName, String schemaPassword, String serviceConfigurationName, String schemaName, String domainDisplayName, String databaseUrl, String domainName) throws IfsException
See notes on the 9-arg variant of startService
.
serviceName
- the name to assign to the servicenodeName
- the name of the node that runs this serviceschemaPassword
- the password of the CMSDK schemaserviceConfigurationName
- the service configuration (see above);
if null a default configuration is usedschemaName
- the schema name (see above)domainDisplayName
- this parameter is ignoreddatabaseUrl
- the database url (see above)domainName
- the domain name (see above)IfsException
- (IFS-20102) if the operation failspublic static LibraryService startService(String serviceName, String nodeName, String schemaPassword, String serviceConfigurationName, String schemaName, String domainDisplayName, String databaseUrl, String domainName, String databaseType) throws IfsException
To start a service, you must specify the following:
serviceConfigurationName
and either of the
following:
schemaName
and databaseUrl
, or
domainName
The serviceConfigurationName
specifies the name
of the desired SERVICECONFIGURATION object.
The schemaName
specifies the name of CMSDK schema.
The domainDisplayName
This parameter is ignored.
The databaseUrl
specifies the descriptor for connecting
to the database
The domainName
identifies the CMSDK schema.
It has the format
ifs://host:port:globalDatabaseName:schema
,
where host
is the hostname of the database
server, port
is the port number of the database
listener, globalDatabaseName
is the global
database name, and schema
is the CMSDK schema
name. For example,
ifs://test.foo.com:1521:ora.test_foo_com:ifssys
.
serviceName
- the name to assign to the servicenodeName
- the name of the node that runs this serviceschemaPassword
- the password of the CMSDK schemaserviceConfigurationName
- the service configuration (see above);
if null a default configuration is usedschemaName
- the schema name (see above)domainDisplayName
- this parameter is ignoreddatabaseUrl
- the database url (see above)domainName
- the domain name (see above)databaseType
- the database type ("oracle" or "postgres");
if null, assume oracleIfsException
- (IFS-20102) if the operation failspublic static LibraryService startServiceUsingDatabaseUrl(String serviceName, String nodeName, String schemaPassword, String serviceConfigurationName, String schemaName, String databaseUrl) throws IfsException
See notes on the 7-arg variant of startServiceUsingDatabaseUrl
.
serviceName
- the name to assign to the servicenodeName
- the name of the node that runs this serviceschemaPassword
- the password of the CMSDK schemaserviceConfigurationName
- the service configuration (see above);
if null a default configuration is usedschemaName
- the schema name (see above)databaseUrl
- the database url (see above)IfsException
- (IFS-20102) if the operation failspublic static LibraryService startServiceUsingDatabaseUrl(String serviceName, String nodeName, String schemaPassword, String serviceConfigurationName, String schemaName, String databaseUrl, String databaseType) throws IfsException
To start a service, you must specify the following:
serviceConfigurationName
,
schemaName
and databaseUrl
.
The serviceConfigurationName
specifies the name
of the desired SERVICECONFIGURATION object.
The schemaName
specifies the name of CMSDK schema.
The databaseUrl
specifies the descriptor for connecting
to the database
serviceName
- the name to assign to the servicenodeName
- the name of the node that runs this serviceschemaPassword
- the password of the CMSDK schemaserviceConfigurationName
- the service configuration (see above);
if null a default configuration is usedschemaName
- the schema name (see above)databaseUrl
- the database url (see above)databaseType
- the database type: oracle or postgresIfsException
- (IFS-20102) if the operation failspublic static LibraryService startServiceUsingDataSource(String serviceName, String nodeName, String serviceConfigurationName, DataSource ds) throws IfsException
startServiceUsingDataSource
See notes on the 5-arg variant of startServiceUsingDataSource
.
serviceName
- the name to assign to the servicenodeName
- the name of the node that runs this serviceserviceConfigurationName
- the service configuration (see above);
if null a default configuration is usedds
- data source for db connectivityIfsException
- (IFS-20102) if the operation failspublic static LibraryService startServiceUsingDataSource(String serviceName, String nodeName, String serviceConfigurationName, DataSource ds, String databaseType) throws IfsException
To start a service, you must specify the following:
serviceConfigurationName
,
schemaName
and databaseUrl
.
The serviceConfigurationName
specifies the name
of the desired SERVICECONFIGURATION object.
The dataSource
dataSource used for connecting
to the database
serviceName
- the name to assign to the servicenodeName
- the name of the node that runs this serviceserviceConfigurationName
- the service configuration (see above);
if null a default configuration is usedds
- data source for db connectivitydatabaseType
- the database type: oracle or postgresIfsException
- (IFS-20102) if the operation failspublic static AttributeValue[] getServiceConfigurationProperties(String domainName, String schemaPassword, String serviceConfigurationName) throws IfsException
getServiceConfigurationProperties(String, DataSource)
This variant obtains the properties without a session or service.
domainName
- the domain nameschemaPassword
- the schema passwordserviceConfigurationName
- the ServiceConfiguration name,
or null for the default service
configurationIfsException
- (IFS-20010) if the operation failspublic static AttributeValue[] getServiceConfigurationProperties(String schemaPassword, String serviceConfigurationName, String databaseUrl, String schemaName) throws IfsException
getServiceConfigurationProperties(String, DataSource)
schemaPassword
- schema passwordserviceConfigurationName
- name of the service configdatabaseUrl
- database URLschemaName
- name of the schemaIfsException
- if the operation failspublic static AttributeValue[] getServiceConfigurationProperties(String serviceConfigurationName, DataSource ds) throws IfsException
This variant obtains the properties without a session or service.
serviceConfigurationName
- the ServiceConfiguration name,
or null for the default service
configurationds
- DataSource used to connect to the schemaIfsException
- (IFS-20010) if the operation failspublic static String getVersionString() throws IfsException
"1.0.8.3.1" would be returned for version 1.0.8.3.1.
IfsException
- if the operation failspublic static long getVersionNumber() throws IfsException
Each element in the version number is represented by two digits in the long value.
0100080301L would be returned for version 1.0.8.3.1.
IfsException
- if the operation failspublic static LibraryObjectLookupCache findLibraryObjectLookupCache(LibrarySessionInterface session, String key)
Currently uses a static map rather, as currently it is difficult to use a LibraryService instance as this isn't readily available from a LibrarySession context. A session is passed for this method in order to make it easier to re-implement this in terms of an instance method once this is fixed.
session
- the session contextkey
- the key used in registering the instanceIfsException
- if the operation failspublic static void registerLibraryObjectLookupCache(LibrarySessionInterface session, String key, LibraryObjectLookupCache lolc) throws IfsException
Currently uses a static map rather, as currently it is difficult to use a LibraryService instance as this isn't readily available from a LibrarySession context. A session is passed for this method in order to make it easier to re-implement this in terms of an instance method once this is fixed.
session
- the session contextkey
- the key used to register the instancelolc
- the LibraryObjectLookupCache instance to registerIfsException
- if the operation failspublic void setBootstrapClassPolicyActionContexts(HashMap pacs, String schemaPassword) throws IfsException
In policy bootstrap mode, the in-play policies are not determined by the ClassPolicyList attribute of CLASSOBJECT and the PolicyList and ApplicationPolicyList attributes of PUBLICOBJECT, SCHEMAOBJECT, and SYSTEMOBJECT. Instead they are explicitly specified using this method.
The pacs
argument must be a HashMap whose names are
uppercased ClassObject names, and whose values are Lists of the
PolicyActionContexts for the ClassObject's ClassPolicyList. The
getClassPolicyActionContexts
method of PolicyManager
returns a value in this form.
If pacs
is null, the service is taken out of bootstrap
mode.
pacs
- see method descriptionschemaPassword
- the schema passwordIfsException
- (IFS-20014) if the operation failspublic TokenCredential getTokenCredential(String token, Hashtable parameters) throws IfsException
token
- the tokenparameters
- the required parameters. For this method to return
a TokenCredential, this hashtable must contain a
matching entry for every required parameter that
was specified in creating the TokenCredential.IfsException
- (IFS-10192) if the operation failspublic GssApiCredential getGssApiCredential(byte[] inputTicket, Hashtable parameters) throws IfsException
inputTicket
- client supplied GSS api ticketparameters
- currently not usedIfsException
- (IFS-10192) if the operation failspublic void invalidateTokenCredential(String token, Hashtable parameters) throws IfsException
Once invalidated, the token can no longer be used to authenticate.
token
- the tokenparameters
- the required parameters. For this method to
invalidate a TokenCredential, this hashtable
must contain a matching entry for every required
parameter that was specified in creating the
TokenCredential.IfsException
- (IFS-10189) if the operation failspublic CredentialNameTokenizer getCredentialNameTokenizer() throws IfsException
IfsException
- (IFS-12790) if the operation failspublic LibrarySession connect(Credential credential, ConnectOptions options) throws IfsException
credential
- the user's credentialsoptions
- connect options; may be nullIfsException
- (IFS-21008) if the operation failspublic void dispose(String schemaPassword) throws IfsException
schemaPassword
- the schema password, to prove authorityIfsException
- if the operation failspublic void dispose(DataSource dataSource) throws IfsException
dataSource
- data source, to prove authorityIfsException
- if the operation failspublic void dispose(SystemUserCredential cred) throws IfsException
cred
- the SystemUserCredentialIfsException
- if the operation failspublic static String getDatabaseUrlUsingDomainName(String domainName, String jdbcDriverType) throws IfsException
getDatabaseUrlUsingDomainName
A database URL is synthesized from the specified domain name and JDBC driver type.
domainName
- the domain namejdbcDriverType
- the JDBC driver type; either
JDBCDRIVERTYPE_THIN or JDBCDRIVERTYPE_OCI8IfsException
- (IFS-20130) if the operation failspublic static String getDatabaseUrlUsingDomainName(String databaseType, String domainName, String jdbcDriverType) throws IfsException
A database URL is synthesized from the specified domain name, database type (oracle or postgres), and JDBC driver type.
databaseType
- the database type ("oracle" or "postgres");
if null assume postgresdomainName
- the domain namejdbcDriverType
- the JDBC driver type for Oracle;
either "thin" or "oci8"IfsException
- (IFS-20130) if the operation failspublic static String getSchemaName(String domainName) throws IfsException
domainName
- the domain nameIfsException
- (IFS-20131) if the operation failspublic static Vector selectProperties(Connection conn, String fromWhereOrderBy, String propertyTableAlias, Object[] bindValues) throws Exception
This method can select Properties from odmv_property, or from any table or view that contains a superset of the columns in that view.
conn
- the connectionfromWhereOrderBy
- the FROM, WHERE, and ORDER BY clauses of
the SELECTpropertyTableAlias
- the alias of the odmv_property-like table
in the FROM clause, or null for no aliasbindValues
- the positional bind values, or null for
noneException
- if the operation failspublic static boolean isPostgres()
public static void setPostgres()
Copyright © 2023. All rights reserved.