Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Content Management SDK
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

oracle.ifs.server
Class S_LibraryService

java.lang.Object
  |
  +--oracle.ifs.server.S_LibraryService
All Implemented Interfaces:
IfsEventHandler, LibraryConstants, oracle.ifs.common.remoted.Remoteable, oracle.ifs.management.domain.ServiceManagerInterface, Traceable
public final class S_LibraryService
extends java.lang.Object
implements IfsEventHandler, Traceable, oracle.ifs.management.domain.ServiceManagerInterface, LibraryConstants

S_LibraryService is the iFS repository service.

An S_LibraryService hosts one or more user sessions, S_LibrarySessions. In addition to performing session management, the service provides a set of subservices shared by the sessions.

A Java VM can have one or more S_LibraryServices, each identified by a unique name. In establishing a connection, the user specifies the name of the desired service.

Application developers rarely need to operate on S_LibraryService. However, a reference to the service can be obtained by invoking the getService method of S_LibrarySession.

Fields inherited from interface oracle.ifs.beans.resources.LibraryConstants
IFS_DOMAIN_ACLINDEX_EVENTTARGET, IFS_DOMAIN_AUDIT_AUDITINGENABLED, IFS_DOMAIN_AUDITRULEEVALUATORCLASS, IFS_DOMAIN_CREDENTIALMANAGER_ANONYMOUSUSERNAME, IFS_DOMAIN_DOMAINREGISTRY_PASSWORDREQUIRED, IFS_DOMAIN_FOLDERINDEX_EVENTTARGET, 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_MEDIA_READMODEGETBYTES, IFS_DOMAIN_LIBRARYOBJECT_SERVICECONFIGURATION_DEFAULTSERVICECONFIGURATION, 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_PROPERTYBUNDLE_NAME, IFS_SERVICE_ACLCACHE_EMERGENCYTRIGGER, IFS_SERVICE_ACLCACHE_NORMALTRIGGER, IFS_SERVICE_ACLCACHE_PURGETARGET, IFS_SERVICE_ACLCACHE_SIZE, IFS_SERVICE_ACLCACHE_URGENTTRIGGER, IFS_SERVICE_AUDITINGENABLED, IFS_SERVICE_CASESENSITIVEAUTHENTICATION, IFS_SERVICE_CHECKFORORPHANSESSIONSPERIOD, IFS_SERVICE_CONNECTIONPOOL_READONLY_MAXIMUMSIZE, IFS_SERVICE_CONNECTIONPOOL_READONLY_MAXIMUMSIZETIMEOUT, IFS_SERVICE_CONNECTIONPOOL_READONLY_MINIMUMSIZE, 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_TARGETSIZE, IFS_SERVICE_CONNECTIONPOOL_WRITEABLE_TARGETSIZETIMEOUT, 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_JDBC_DATABASEURL, IFS_SERVICE_JDBC_DEFAULTROWPREFETCH, IFS_SERVICE_JDBC_DRIVER, IFS_SERVICE_JDBC_DRIVERTYPE, IFS_SERVICE_JDBC_SCHEMA, IFS_SERVICE_JDBC_TRACINGENABLED, IFS_SERVICE_MAXIMUMCONCURRENTSESSIONS, IFS_SERVICE_MAXIMUMCONCURRENTSESSIONSPERUSER, IFS_SERVICE_ORPHANSESSIONTIMEOUTPERIOD, IFS_SERVICE_POLLFOREVENTSFROMOTHERSERVICESPERIOD, IFS_SERVICE_SERVICEKEEPALIVEEVENTPERIOD, IFS_SERVICE_SESSION_BEANSOBJECTCACHE_SIZE, 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_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_ISUNBOUNDED, 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_TRANSPORTEVENTSTOOTHERSERVICESPERIOD
 
Method Summary
 CredentialNameTokenizer getCredentialNameTokenizer()
          Gets the CredentialNameTokenizer for this S_LibraryService.
 java.lang.Long getId()
          Gets the id of this service.
 long getSchemaVersionNumber()
          Gets the schema version as a long.
 java.lang.String getSchemaVersionString()
          Gets the schema version as a string.
 AttributeValue getServiceConfigurationProperty(java.lang.String name)
          Gets the specified service configuration property.
 boolean getServiceConfigurationProperty(java.lang.String name, boolean defaultValue)
          Gets the value of the specified service configuration property, as a boolean.
 int getServiceConfigurationProperty(java.lang.String name, int defaultValue)
          Gets the value of the specified service configuration property, as an integer.
 java.lang.String getServiceConfigurationProperty(java.lang.String name, java.lang.String defaultValue)
          Gets the value of the specified service configuration property, as a string.
 TraceLogger getTraceLogger()
          Gets the TraceLogger of this S_LibraryService.
static long getVersionNumber()
          Gets the version of this S_LibraryService as a long.
static java.lang.String getVersionString()
          Gets the version of this S_LibraryService as a string.
 boolean isAclResolutionSynchronous()
          Returns the ACL resolution mode.
 boolean isTraced(int channel, int level)
          Gets whether tracing is enabled for the specified channel and level.
 void trace(int channel, int level, java.lang.String payload)
          Issues a trace request to the trace logger.
 

Method Detail

getId

public java.lang.Long getId()
                     throws IfsException
Gets the id of this service.
Returns:
the id
Throws:
IfsException - if the operation fails

getVersionString

public static final java.lang.String getVersionString()
                                               throws IfsException
Gets the version of this S_LibraryService as a string.
Returns:
the version
Throws:
IfsException - if the operation fails

getVersionNumber

public static final long getVersionNumber()
                                   throws IfsException
Gets the version of this S_LibraryService as a long.
Returns:
the version
Throws:
IfsException - if the operation fails

getSchemaVersionString

public final java.lang.String getSchemaVersionString()
                                              throws IfsException
Gets the schema version as a string.
Returns:
the version
Throws:
IfsException - (IFS-20001) if the operation fails

getSchemaVersionNumber

public final long getSchemaVersionNumber()
                                  throws IfsException
Gets the schema version as a long.
Returns:
the version
Throws:
IfsException - (IFS-20001) if the operation fails

getServiceConfigurationProperty

public AttributeValue getServiceConfigurationProperty(java.lang.String name)
                                               throws IfsException
Gets the specified service configuration property.
Parameters:
name - the property name
Returns:
the property, or null if there is no such property
Throws:
IfsException - (IFS-20004) if the operation fails

getServiceConfigurationProperty

public java.lang.String getServiceConfigurationProperty(java.lang.String name,
                                                        java.lang.String defaultValue)
                                                 throws IfsException
Gets the value of the specified service configuration property, as a string.
Parameters:
name - the property name
defaultValue - the default value
Returns:
the property value
Throws:
IfsException - (IFS-20004) if the operation fails

getServiceConfigurationProperty

public boolean getServiceConfigurationProperty(java.lang.String name,
                                               boolean defaultValue)
                                        throws IfsException
Gets the value of the specified service configuration property, as a boolean.
Parameters:
name - the property name
defaultValue - the default value
Returns:
the property value
Throws:
IfsException - (IFS-20004) if the operation fails

getServiceConfigurationProperty

public int getServiceConfigurationProperty(java.lang.String name,
                                           int defaultValue)
                                    throws IfsException
Gets the value of the specified service configuration property, as an integer.
Parameters:
name - the property name
defaultValue - the default value
Returns:
the property value
Throws:
IfsException - (IFS-20004) if the operation fails

getCredentialNameTokenizer

public CredentialNameTokenizer getCredentialNameTokenizer()
                                                   throws IfsException
Gets the CredentialNameTokenizer for this S_LibraryService.
Returns:
the CredentialNameTokenizer
Throws:
IfsException - (IFS-12790) if the operation fails

getTraceLogger

public final TraceLogger getTraceLogger()
                                 throws IfsException
Gets the TraceLogger of this S_LibraryService.
Specified by:
getTraceLogger in interface Traceable
Returns:
the trace logger
Throws:
IfsException - if the operation fails

isTraced

public final boolean isTraced(int channel,
                              int level)
                       throws IfsException
Gets whether tracing is enabled for the specified channel and level.
Specified by:
isTraced in interface Traceable
Parameters:
channel - the channel number
level - the level
Returns:
whether tracing is enabled
Throws:
IfsException - (IFS-11201) if the channel is invalid

trace

public final void trace(int channel,
                        int level,
                        java.lang.String payload)
Issues a trace request to the trace logger.
Specified by:
trace in interface Traceable
Parameters:
channel - the channel number
level - the level
payload - a string containing any additional information to be placed in the trace log

isAclResolutionSynchronous

public final boolean isAclResolutionSynchronous()
                                         throws IfsException
Returns the ACL resolution mode.
Returns:
true if the resolution mode is synchronous; false otherwise
Throws:
IfsException - (IFS-20001) if the operation fails
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Content Management SDK
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
(c) 2002 Copyright Oracle Corporation. All rights reserved.