oracle.ifs.server
Class S_LibrarySession

java.lang.Object

  |

  +--oracle.ifs.server.S_LibrarySession

All Implemented Interfaces:

oracle.ifs.common.CollectionResolver, IfsEventHandler, LibrarySessionInterface, oracle.ifs.server.S_LibrarySessionInterface, Traceable

public class S_LibrarySession

extends java.lang.Object

implements LibrarySessionInterface, oracle.ifs.server.S_LibrarySessionInterface, oracle.ifs.common.CollectionResolver, IfsEventHandler, Traceable

An S_LibrarySession represents a user session in the iFS repository.

For every S_LibrarySession there is a corresponding LibrarySession. LibrarySession, in the package oracle.ifs.beans, forms part of the iFS application development API, informally known as the "beans API". Applications invoke iFS functionality by calling the beans API. S_LibrarySession, however, is in the oracle.ifs.server package, and forms part of the iFS server extensibility API, also known as the "server API". The server API is used to override or extend out-of-the-box iFS behavior by injecting your code into certain methods that are automatically invoked by the iFS repository. Applications do not directly call the server API.

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 cannot change the behavior of S_LibrarySession itself.

Method Summary

java.io.Serializable	DYNCredentialManagerCreateUser(java.io.Serializable payload) Creates a new user in the specified CredentialManager.
java.io.Serializable	DYNCredentialManagerDeleteUser(java.io.Serializable payload) Deletes the specified user from the specified CredentialManager.
java.io.Serializable	DYNCredentialManagerListUsers(java.io.Serializable payload) Gets the distinguished names of all users managed by the specified CredentialManager.
java.io.Serializable	DYNCredentialManagerSetPassword(java.io.Serializable payload) Sets the password of the specified user in the specified CredentialManager.
java.io.Serializable	DYNCredentialManagerSupportsCreateUser(java.io.Serializable payload) Determines whether the specified CredentialManager supports the DYNCredentialManagerCreateUser method.
java.io.Serializable	DYNCredentialManagerSupportsDeleteUser(java.io.Serializable payload) Determines whether the specified CredentialManager supports the DYNCredentialManagerDeleteUser method.
java.io.Serializable	DYNCredentialManagerSupportsListUsers(java.io.Serializable payload) Determines whether the specified CredentialManager supports the DYNCredentialManagerListUsers method.
java.io.Serializable	DYNCredentialManagerSupportsSetPassword(java.io.Serializable payload) Determines whether the specified CredentialManager supports the DYNCredentialManagerSetPassword method.
java.io.Serializable	DYNCredentialManagerUserExists(java.io.Serializable payload) Determines whether the specified CredentialManager can authenticate the specified user.
java.io.Serializable	DYNGetCommittedLibraryObjectDataCachePerformanceString(java.io.Serializable payload) Gets the cache performance of the committed S_LibraryObjectData cache, as a string.
java.io.Serializable	DYNGetFolderPathCachePerformanceString(java.io.Serializable payload) Gets the cache performance of the FolderPathCache, as a string.
java.io.Serializable	DYNGetLibraryObjectCachePerformanceString(java.io.Serializable payload) Gets the cache performance of the S_LibraryObject cache, as a string.
java.io.Serializable	DYNGetReadonlyConnectionPoolPerformanceString(java.io.Serializable payload) Gets performance statistics of the readonly connection pool.
java.io.Serializable	DYNGetUncommittedLibraryObjectDataCachePerformanceString(java.io.Serializable payload) Gets the cache performance of the uncommitted S_LibraryObjectData cache, as a string.
java.io.Serializable	DYNGetWriteableConnectionPoolPerformanceString(java.io.Serializable payload) Gets performance statistics of the writeable connection pool.
S_DirectoryUser	getAuthenticatedUser() Gets the S_DirectoryUser for which this S_LibrarySession was authenticated.
Collection	getClassAccessControlListCollection() Gets a reference to the ClassAccessControlList collection.
Collection	getClassDomainCollection() Gets a reference to the S_ClassDomain collection.
S_ClassObject	getClassObjectByName(java.lang.String classname) Returns a class object given a class name.
Collection	getClassObjectCollection() Gets a reference to the S_ClassObject collection.
java.lang.String	getDefaultFolderRelationshipClassname() Gets the name of the default folder relationship classobject.
S_DirectoryObject	getDirectoryObject(java.lang.Long id) Gets an S_DirectoryObject by id.
S_DirectoryObject	getDirectoryObject(java.lang.Long id, java.lang.Long classId) Gets an S_DirectoryObject by id and classId.
Collection	getDirectoryUserCollection() Gets a reference to the DirectoryUser collection.
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.
java.lang.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.
java.lang.Long	getId() Gets the id of this S_LibrarySession.
S_LibraryObject	getLibraryObject(java.lang.Long id, java.lang.Long classId) Gets an S_LibraryObject by id and classId.
Localizer	getLocalizer() Gets the Localizer of this S_LibrarySession.
Collection	getMediaCollection() Gets a reference to the Media collection.
Collection	getPermissionBundleCollection() Gets a reference to the S_PermissionBundle collection.
Collection	getPolicyCollection() Gets a reference to the S_Policy collection.
S_PublicObject	getPublicObject(java.lang.Long id) Gets an S_PublicObject by id.
S_PublicObject	getPublicObject(java.lang.Long id, java.lang.Long classId) Gets an S_PublicObject by id and classId.
S_SchemaObject	getSchemaObject(java.lang.Long id) Gets an S_SchemaObject by id.
S_SchemaObject	getSchemaObject(java.lang.Long id, java.lang.Long classId) Gets an S_SchemaObject by id and classId.
S_LibraryService	getService() Gets the S_LibraryService hosting this S_LibrarySession.
Collection	getSharedAccessControlListCollection() Gets a reference to the shared AccessControlList collection.
Collection	getSystemAccessControlListCollection() Gets a reference to the SystemAccessControlList collection.
S_SystemObject	getSystemObject(java.lang.Long id) Gets an S_SystemObject by id.
S_SystemObject	getSystemObject(java.lang.Long id, java.lang.Long classId) Gets an S_SystemObject by id and classId.
TraceLogger	getTraceLogger() Gets the trace logger of this session.
S_DirectoryUser	getUser() Gets 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.
boolean	isAdministrationMode() Gets whether this S_LibrarySession is in administration 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.
void	verifyConnected() Asserts that this S_LibrarySession is connected.

Method Detail

verifyConnected

public final void verifyConnected()
                           throws IfsException

Asserts that this S_LibrarySession is connected.

Throws:

IfsException - (IFS-21000) if the session is not connected

getId

public java.lang.Long getId()
                     throws IfsException

Gets the id of this S_LibrarySession.

Returns:

the id

Throws:

IfsException - if the operation fails

getService

public S_LibraryService getService()
                            throws IfsException

Gets the S_LibraryService hosting this S_LibrarySession.

Returns:

the service

Throws:

IfsException - if the operation fails

getLocalizer

public final Localizer getLocalizer()
                             throws IfsException

Gets the Localizer of this S_LibrarySession.

Specified by:

getLocalizer in interface LibrarySessionInterface

Returns:

the Localizer

Throws:

IfsException - if the operation fails

getFolderPathDelimiter

public final java.lang.String getFolderPathDelimiter()
                                              throws IfsException

Gets the Folder Path Delimiter for this session

Returns:

the delimiter

Throws:

IfsException - if the operation fails

getDefaultFolderRelationshipClassname

public java.lang.String getDefaultFolderRelationshipClassname()
                                                       throws IfsException

Gets the name of the default folder relationship classobject.

Returns:

the classobject name

Throws:

IfsException - if the operation fails

getAuthenticatedUser

public S_DirectoryUser getAuthenticatedUser()
                                     throws IfsException

Gets the S_DirectoryUser for which this S_LibrarySession was authenticated.

Returns:

the user

Throws:

IfsException - if the operation fails

getUser

public S_DirectoryUser getUser()
                        throws IfsException

Gets the current S_DirectoryUser for this S_LibrarySession.

This is the same as the authenticated user, unless a "feign user" operation has been performed.

Returns:

the current user

Throws:

IfsException - if the operation fails

isAdministrationMode

public boolean isAdministrationMode()
                             throws IfsException

Gets whether this S_LibrarySession is in administration mode.

Returns:

whether in administration mode

Throws:

IfsException - if the operation fails

getClassObjectCollection

public final Collection getClassObjectCollection()
                                          throws IfsException

Gets a reference to the S_ClassObject collection.

Specified by:

getClassObjectCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getClassObjectByName

public final S_ClassObject getClassObjectByName(java.lang.String classname)
                                         throws IfsException

Returns a class object given a class name. This uses the ClassObjectCollection and is simply a convenience method.

Parameters:

the - name of a class

Returns:

the S_ClassObject

Throws:

IfsException - if the operation fails

getClassDomainCollection

public final Collection getClassDomainCollection()
                                          throws IfsException

Gets a reference to the S_ClassDomain collection.

Specified by:

getClassDomainCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getValueDefaultCollection

public final Collection getValueDefaultCollection()
                                           throws IfsException

Gets a reference to the S_ValueDefault collection.

Specified by:

getValueDefaultCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getValueDomainCollection

public final Collection getValueDomainCollection()
                                          throws IfsException

Gets a reference to the S_ValueDomain collection.

Specified by:

getValueDomainCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getPolicyCollection

public final Collection getPolicyCollection()
                                     throws IfsException

Gets a reference to the S_Policy collection.

Specified by:

getPolicyCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getPermissionBundleCollection

public final Collection getPermissionBundleCollection()
                                               throws IfsException

Gets a reference to the S_PermissionBundle collection.

Specified by:

getPermissionBundleCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getExtendedPermissionCollection

public final Collection getExtendedPermissionCollection()
                                                 throws IfsException

Gets a reference to the S_ExtendedPermission collection.

Specified by:

getExtendedPermissionCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getExtendedUserProfileCollection

public final Collection getExtendedUserProfileCollection()
                                                  throws IfsException

Gets a reference to the S_ExtendedUserProfile collection for this S_LibrarySessions user.

Specified by:

getExtendedUserProfileCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getFormatCollection

public final Collection getFormatCollection()
                                     throws IfsException

Gets a reference to the S_Format collection, organized by name.

Specified by:

getFormatCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getFormatExtensionCollection

public final Collection getFormatExtensionCollection()
                                              throws IfsException

Gets a reference to the S_Format collection, organized by extension.

Specified by:

getFormatExtensionCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getMediaCollection

public final Collection getMediaCollection()
                                    throws IfsException

Gets a reference to the Media collection.

Specified by:

getMediaCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getSharedAccessControlListCollection

public final Collection getSharedAccessControlListCollection()
                                                      throws IfsException

Gets a reference to the shared AccessControlList collection.

Specified by:

getSharedAccessControlListCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getSystemAccessControlListCollection

public final Collection getSystemAccessControlListCollection()
                                                      throws IfsException

Gets a reference to the SystemAccessControlList collection.

Specified by:

getSystemAccessControlListCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getClassAccessControlListCollection

public final Collection getClassAccessControlListCollection()
                                                     throws IfsException

Gets a reference to the ClassAccessControlList collection.

Specified by:

getClassAccessControlListCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getDirectoryUserCollection

public final Collection getDirectoryUserCollection()
                                            throws IfsException

Gets a reference to the DirectoryUser collection.

Specified by:

getDirectoryUserCollection in interface LibrarySessionInterface

Returns:

the collection

Throws:

IfsException - if the operation fails

getLibraryObject

public S_LibraryObject getLibraryObject(java.lang.Long id,
                                        java.lang.Long classId)
                                 throws IfsException

Gets an S_LibraryObject by id and classId.

Parameters:

id - the id

classId - the classId

Returns:

the object

Throws:

IfsException - if the operation fails

getPublicObject

public S_PublicObject getPublicObject(java.lang.Long id,
                                      java.lang.Long classId)
                               throws IfsException

Gets an S_PublicObject by id and classId.

Parameters:

id - the id

classId - the classId

Returns:

the object

Throws:

IfsException - if the operation fails

getPublicObject

public S_PublicObject getPublicObject(java.lang.Long id)
                               throws IfsException

Gets an S_PublicObject by id.

Parameters:

id - the id

Returns:

the object

Throws:

IfsException - if the operation fails

getSystemObject

public S_SystemObject getSystemObject(java.lang.Long id,
                                      java.lang.Long classId)
                               throws IfsException

Gets an S_SystemObject by id and classId.

Parameters:

id - the id

classId - the classId

Returns:

the object

Throws:

IfsException - if the operation fails

getSystemObject

public S_SystemObject getSystemObject(java.lang.Long id)
                               throws IfsException

Gets an S_SystemObject by id.

Parameters:

id - the id

Returns:

the object

Throws:

IfsException - if the operation fails

getSchemaObject

public S_SchemaObject getSchemaObject(java.lang.Long id,
                                      java.lang.Long classId)
                               throws IfsException

Gets an S_SchemaObject by id and classId.

Parameters:

id - the id

classId - the classId

Returns:

the object

Throws:

IfsException - if the operation fails

getSchemaObject

public S_SchemaObject getSchemaObject(java.lang.Long id)
                               throws IfsException

Gets an S_SchemaObject by id.

Parameters:

id - the id

Returns:

the object

Throws:

IfsException - if the operation fails

getDirectoryObject

public S_DirectoryObject getDirectoryObject(java.lang.Long id,
                                            java.lang.Long classId)
                                     throws IfsException

Gets an S_DirectoryObject by id and classId.

Parameters:

id - the id

classId - the classId

Returns:

the object

Throws:

IfsException - if the operation fails

getDirectoryObject

public S_DirectoryObject getDirectoryObject(java.lang.Long id)
                                     throws IfsException

Gets an S_DirectoryObject by id.

Parameters:

id - the id

Returns:

the object

Throws:

IfsException - if the operation fails

DYNGetCommittedLibraryObjectDataCachePerformanceString

public java.io.Serializable DYNGetCommittedLibraryObjectDataCachePerformanceString(java.io.Serializable payload)
                                                                            throws IfsException

Gets the cache performance of the committed S_LibraryObjectData cache, as a string.

Returns:

a string

Throws:

IfsException - if the operation fails

DYNGetUncommittedLibraryObjectDataCachePerformanceString

public java.io.Serializable DYNGetUncommittedLibraryObjectDataCachePerformanceString(java.io.Serializable payload)
                                                                              throws IfsException

Gets the cache performance of the uncommitted S_LibraryObjectData cache, as a string.

Returns:

a string

Throws:

IfsException - if the operation fails

DYNGetLibraryObjectCachePerformanceString

public java.io.Serializable DYNGetLibraryObjectCachePerformanceString(java.io.Serializable payload)
                                                               throws IfsException

Gets the cache performance of the S_LibraryObject cache, as a string.

Returns:

a string

Throws:

IfsException - if the operation fails

DYNGetFolderPathCachePerformanceString

public java.io.Serializable DYNGetFolderPathCachePerformanceString(java.io.Serializable payload)
                                                            throws IfsException

Gets the cache performance of the FolderPathCache, as a string.

Returns:

a string

Throws:

IfsException - if the operation fails

DYNGetReadonlyConnectionPoolPerformanceString

public java.io.Serializable DYNGetReadonlyConnectionPoolPerformanceString(java.io.Serializable payload)
                                                                   throws IfsException

Gets performance statistics of the readonly connection pool.

Returns:

a String

Throws:

IfsException - if the operation fails

DYNGetWriteableConnectionPoolPerformanceString

public java.io.Serializable DYNGetWriteableConnectionPoolPerformanceString(java.io.Serializable payload)
                                                                    throws IfsException

Gets performance statistics of the writeable connection pool.

Returns:

a String

Throws:

IfsException - if the operation fails

DYNCredentialManagerUserExists

public java.io.Serializable DYNCredentialManagerUserExists(java.io.Serializable payload)
                                                    throws IfsException

Determines whether the specified CredentialManager can authenticate the specified 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.

The payload must be a Vector containing two String elements, as follows:

• credentialManagerName: the name of the CredentialManager
• distinguishedName: the distinguished name of the user

Parameters:

payload - see method description

Returns:

a Boolean indicating whether the CredentialManager manages the user

Throws:

IfsException - if the operation fails

DYNCredentialManagerSupportsCreateUser

public java.io.Serializable DYNCredentialManagerSupportsCreateUser(java.io.Serializable payload)
                                                            throws IfsException

Determines whether the specified CredentialManager supports the 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.

Parameters:

payload - the String name of the CredentialManager

Returns:

a Boolean indicating whether DYNCredentialManagerCreateUser is supported

Throws:

IfsException - if the operation fails

DYNCredentialManagerCreateUser

public java.io.Serializable DYNCredentialManagerCreateUser(java.io.Serializable payload)
                                                    throws IfsException

Creates a new user in the specified CredentialManager.

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 String elements, as follows:

• credentialManagerName: the name of the CredentialManager
• name: the name of the user; some CredentialManagers may convert this name into a distinguished name if required; other CredentialManagers may require this to be a distinguished name to begin with
• password: the password of the user

Parameters:

payload - see method description

Returns:

the String distinguished name of the created user

Throws:

IfsException - if the operation fails

DYNCredentialManagerSupportsDeleteUser

public java.io.Serializable DYNCredentialManagerSupportsDeleteUser(java.io.Serializable payload)
                                                            throws IfsException

Determines whether the specified CredentialManager supports the 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.

Parameters:

payload - the String name of the CredentialManager

Returns:

a Boolean indicating whether DYNCredentialManagerDeleteUser is supported

Throws:

IfsException - if the operation fails

DYNCredentialManagerDeleteUser

public java.io.Serializable DYNCredentialManagerDeleteUser(java.io.Serializable payload)
                                                    throws IfsException

Deletes the specified user from the specified CredentialManager.

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:

• credentialManagerName: the name of the CredentialManager
• distinguishedName: the distinguished name of the user

Parameters:

payload - see method description

Returns:

null

Throws:

IfsException - if the operation fails

DYNCredentialManagerSupportsSetPassword

public java.io.Serializable DYNCredentialManagerSupportsSetPassword(java.io.Serializable payload)
                                                             throws IfsException

Determines whether the specified CredentialManager supports the 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.

Parameters:

payload - the String name of the CredentialManager

Returns:

a Boolean indicating whether DYNCredentialManagerSetPassword is supported

Throws:

IfsException - if the operation fails

DYNCredentialManagerSetPassword

public java.io.Serializable DYNCredentialManagerSetPassword(java.io.Serializable payload)
                                                     throws IfsException

Sets the password of the specified user in the specified CredentialManager.

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 String elements, as follows:

• credentialManagerName: the name of the CredentialManager
• distinguishedName: the distinguished name of the user
• password: the new password

Parameters:

payload - see method description

Returns:

null

Throws:

IfsException - if the operation fails

DYNCredentialManagerSupportsListUsers

public java.io.Serializable DYNCredentialManagerSupportsListUsers(java.io.Serializable payload)
                                                           throws IfsException

Determines whether the specified CredentialManager supports the 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.

Parameters:

payload - the String name of the CredentialManager

Returns:

a Boolean indicating whether DYNCredentialManagerListUsers is supported

Throws:

IfsException - if the operation fails

DYNCredentialManagerListUsers

public java.io.Serializable DYNCredentialManagerListUsers(java.io.Serializable payload)
                                                   throws IfsException

Gets the distinguished names of all users managed by the specified CredentialManager.

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.

Parameters:

payload - the String name of the CredentialManager

Returns:

a Vector of String distinguished names

Throws:

IfsException - if the operation fails

getTraceLogger

public final TraceLogger getTraceLogger()
                                 throws IfsException

Gets the trace logger of this session.

Specified by:

getTraceLogger in interface Traceable

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