|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ifs.server.S_LibrarySession
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 |
public final void verifyConnected() throws IfsException
IfsException
- (IFS-21000) if the session is not connectedpublic java.lang.Long getId() throws IfsException
IfsException
- if the operation failspublic S_LibraryService getService() throws IfsException
IfsException
- if the operation failspublic final Localizer getLocalizer() throws IfsException
getLocalizer
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final java.lang.String getFolderPathDelimiter() throws IfsException
IfsException
- if the operation failspublic java.lang.String getDefaultFolderRelationshipClassname() throws IfsException
IfsException
- if the operation failspublic S_DirectoryUser getAuthenticatedUser() 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 boolean isAdministrationMode() throws IfsException
IfsException
- if the operation failspublic final Collection getClassObjectCollection() throws IfsException
getClassObjectCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final S_ClassObject getClassObjectByName(java.lang.String classname) throws IfsException
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 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 getSharedAccessControlListCollection() throws IfsException
getSharedAccessControlListCollection
in interface LibrarySessionInterface
IfsException
- if the operation failspublic final Collection getSystemAccessControlListCollection() throws IfsException
getSystemAccessControlListCollection
in interface LibrarySessionInterface
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 S_LibraryObject getLibraryObject(java.lang.Long id, java.lang.Long classId) throws IfsException
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_PublicObject getPublicObject(java.lang.Long id, java.lang.Long classId) throws IfsException
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_PublicObject getPublicObject(java.lang.Long id) throws IfsException
id
- the idIfsException
- if the operation failspublic S_SystemObject getSystemObject(java.lang.Long id, java.lang.Long classId) throws IfsException
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_SystemObject getSystemObject(java.lang.Long id) throws IfsException
id
- the idIfsException
- if the operation failspublic S_SchemaObject getSchemaObject(java.lang.Long id, java.lang.Long classId) throws IfsException
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_SchemaObject getSchemaObject(java.lang.Long id) throws IfsException
id
- the idIfsException
- if the operation failspublic S_DirectoryObject getDirectoryObject(java.lang.Long id, java.lang.Long classId) throws IfsException
id
- the idclassId
- the classIdIfsException
- if the operation failspublic S_DirectoryObject getDirectoryObject(java.lang.Long id) throws IfsException
id
- the idIfsException
- if the operation failspublic java.io.Serializable DYNGetCommittedLibraryObjectDataCachePerformanceString(java.io.Serializable payload) throws IfsException
IfsException
- if the operation failspublic java.io.Serializable DYNGetUncommittedLibraryObjectDataCachePerformanceString(java.io.Serializable payload) throws IfsException
IfsException
- if the operation failspublic java.io.Serializable DYNGetLibraryObjectCachePerformanceString(java.io.Serializable payload) throws IfsException
IfsException
- if the operation failspublic java.io.Serializable DYNGetFolderPathCachePerformanceString(java.io.Serializable payload) throws IfsException
IfsException
- if the operation failspublic java.io.Serializable DYNGetReadonlyConnectionPoolPerformanceString(java.io.Serializable payload) throws IfsException
IfsException
- if the operation failspublic java.io.Serializable DYNGetWriteableConnectionPoolPerformanceString(java.io.Serializable payload) throws IfsException
IfsException
- if the operation failspublic java.io.Serializable DYNCredentialManagerUserExists(java.io.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 java.io.Serializable DYNCredentialManagerSupportsCreateUser(java.io.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 java.io.Serializable DYNCredentialManagerCreateUser(java.io.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 String
elements, as follows:
payload
- see method descriptionIfsException
- if the operation failspublic java.io.Serializable DYNCredentialManagerSupportsDeleteUser(java.io.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 java.io.Serializable DYNCredentialManagerDeleteUser(java.io.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 java.io.Serializable DYNCredentialManagerSupportsSetPassword(java.io.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 java.io.Serializable DYNCredentialManagerSetPassword(java.io.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 String
elements, as follows:
payload
- see method descriptionIfsException
- if the operation failspublic java.io.Serializable DYNCredentialManagerSupportsListUsers(java.io.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 java.io.Serializable DYNCredentialManagerListUsers(java.io.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
.
payload
- the String name of the CredentialManagerIfsException
- if the operation failspublic 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 trace(int channel, int level, java.lang.String payload)
trace
in interface Traceable
channel
- the channel numberlevel
- the levelpayload
- a string containing any additional information to
be placed in the trace log
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |