Managers (Oracle Content Services Java API Reference)

Package

Class

Tree

Index

Help

Oracle® Content Services Web Services Java API Reference
10g Release 1 (10.1.1)
B19047-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.ifs.fdk
Class Managers

java.lang.Object oracle.ifs.fdk.Managers

public class Managers
extends java.lang.Object

A collection of static methods that retrieve the appropriate module managers such as the session manager, file manager, version manager, etc.

Method Summary
`static ArchiveManager`	`getArchiveManager(FdkSession session)` Returns the Archive manager.
`static AutoTimeoutSessionManager`	`getAutoTimeoutSessionManager(oracle.ifs.management.domain.Server server, long timeout, java.util.Map options)` Returns the session manager that features an auto timeout for sessions that are not used.
`static CacheManager`	`getCacheManager(FdkSession session)` Returns the cache manager used to perform cahe-related operations.
`static CategoryManager`	`getCategoryManager(FdkSession session)` Returns the Category manager used to support custom metadata.
`static CommonManager`	`getCommonManager(FdkSession session)` Returns the common manager used to perform common operations.
`static ContainerManager`	`getContainerManager(FdkSession session)` Returns the container manager.
`static DomainManager`	`getDomainManager(FdkSession session)` Returns the domain manager.
`static FileContentManager`	`getFileContentManager(FdkSession session)` Returns the version manager used to perform versioning operations.
`static FileManager`	`getFileManager(FdkSession session)` Returns the file manager used to perform basic file management operations.
`static GroupManager`	`getGroupManager(FdkSession session)` Returns the group manager used to perform operations on groups.
`static ExtendedLockManager`	`getLockManager(FdkSession session)` Returns the lock manager.
`static LoginManager`	`getLoginManager()` Returns the login manager used to create and dispose sessions.
`static MailManager`	`getMailManager(FdkSession session)` Returns the Mail manager.
`static PagingManager`	`getPagingManager(FdkSession session)` Returns the Paging manager.
`static ProgressManager`	`getProgressManager(FdkSession session)` Returns the progress manager used to perform operations to check for progress and cancel operations.
`static QuotaManager`	`getQuotaManager(FdkSession session)` Returns the quota manager.
`static RecordsManager`	`getRecordsManager(FdkSession session)` Returns the records manager used to perform records management operations.
`static RequestManager`	`getRequestManager(FdkSession session)` Returns the request manager.
`static SearchManager`	`getSearchManager(FdkSession session)` Returns the search manager.
`static SecurityManager`	`getSecurityManager(FdkSession session)` Returns the security manager.
`static SessionManager`	`getSessionManager(FdkSession session)` Returns the session manager used to perform session and transaction operations.
`static SortManager`	`getSortManager(FdkSession session)` Returns the sort manager.
`static SystemConfigurationManager`	`getSystemConfigurationManager(FdkSession session)` Returns the system configuration manager used to query the configuration of the server.
`static TrashManager`	`getTrashManager(FdkSession session)` Returns the trash manager used to perform operations on trash folders.
`static UserManager`	`getUserManager(FdkSession session)` Returns the User manager used to support user operations.
`static VersionManager`	`getVersionManager(FdkSession session)` Returns the version manager used to perform versioning operations.
`static VirusManager`	`getVirusManager(FdkSession session)` Returns the virus manager used to perform antivirus operations.
`static WorkflowManager`	`getWorkflowManager(FdkSession session)` Returns the workflow manager.
`static WorkspaceManager`	`getWorkspaceManager(FdkSession session)` Returns the workspace manager.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getArchiveManager

public static final ArchiveManager getArchiveManager(FdkSession session)
                                              throws FdkException

Returns the Archive manager.

Parameters:: session - the session context
Returns:: the archive manager instance that can be used with the specified session context
Throws:: FdkException - if the operation fails

getAutoTimeoutSessionManager

public static final AutoTimeoutSessionManager getAutoTimeoutSessionManager(oracle.ifs.management.domain.Server server,
                                                                           long timeout,
                                                                           java.util.Map options)
                                                                    throws FdkException

Returns the session manager that features an auto timeout for sessions that are not used. This specialized session manager should only be used by sessionless protocols such as NFS (technically HTTP is a sessionless protocol but the servlet container manages the session hence there is no need for HTTP to use this session manager, it should just use a regular one returned by getSessionManager()).

Parameters:: server - The server that uses this manager.; timeout - The session timeout in seconds. After this period of inactivity, a session managed by this manager will be disconnected. A less or equal than zero value will let the manager choose a default value (1800 sec.); options - Options used when creating new sessions.
Throws:: FdkException

getCacheManager

public static final CacheManager getCacheManager(FdkSession session)
                                          throws FdkException

Returns the cache manager used to perform cahe-related operations.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getCategoryManager

public static final CategoryManager getCategoryManager(FdkSession session)
                                                throws FdkException

Returns the Category manager used to support custom metadata.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getCommonManager

public static final CommonManager getCommonManager(FdkSession session)
                                            throws FdkException

Returns the common manager used to perform common operations.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getContainerManager

public static final ContainerManager getContainerManager(FdkSession session)
                                                  throws FdkException

Returns the container manager.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getDomainManager

public static final DomainManager getDomainManager(FdkSession session)
                                            throws FdkException

Returns the domain manager.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getFileContentManager

public static final FileContentManager getFileContentManager(FdkSession session)
                                                      throws FdkException

Returns the version manager used to perform versioning operations.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getFileManager

public static final FileManager getFileManager(FdkSession session)
                                        throws FdkException

Returns the file manager used to perform basic file management operations.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getGroupManager

public static final GroupManager getGroupManager(FdkSession session)
                                          throws FdkException

Returns the group manager used to perform operations on groups.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getLockManager

public static final ExtendedLockManager getLockManager(FdkSession session)
                                                throws FdkException

Returns the lock manager.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getLoginManager

public static final LoginManager getLoginManager()

Returns the login manager used to create and dispose sessions.

Returns:: The login manager.

getMailManager

public static final MailManager getMailManager(FdkSession session)
                                        throws FdkException

Returns the Mail manager.

Parameters:: session - the session context
Returns:: the mail manager instance that can be used with the specified session context
Throws:: FdkException - if the operation fails

getPagingManager

public static final PagingManager getPagingManager(FdkSession session)
                                            throws FdkException

Returns the Paging manager.

Parameters:: session - the session context
Returns:: the paging manager instance that can be used with the specified session context
Throws:: FdkException - if the operation fails

getProgressManager

public static final ProgressManager getProgressManager(FdkSession session)
                                                throws FdkException

Returns the progress manager used to perform operations to check for progress and cancel operations.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - if the operation fails

getQuotaManager

public static final QuotaManager getQuotaManager(FdkSession session)
                                          throws FdkException

Returns the quota manager.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getRecordsManager

public static final RecordsManager getRecordsManager(FdkSession session)
                                              throws FdkException

Returns the records manager used to perform records management operations.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getRequestManager

public static final RequestManager getRequestManager(FdkSession session)
                                              throws FdkException

Returns the request manager.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getSearchManager

public static final SearchManager getSearchManager(FdkSession session)
                                            throws FdkException

Returns the search manager.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getSecurityManager

public static final SecurityManager getSecurityManager(FdkSession session)
                                                throws FdkException

Returns the security manager.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getSessionManager

public static final SessionManager getSessionManager(FdkSession session)
                                              throws FdkException

Returns the session manager used to perform session and transaction operations.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getSortManager

public static final SortManager getSortManager(FdkSession session)
                                        throws FdkException

Returns the sort manager.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getSystemConfigurationManager

public static final SystemConfigurationManager getSystemConfigurationManager(FdkSession session)
                                                                      throws FdkException

Returns the system configuration manager used to query the configuration of the server.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getTrashManager

public static final TrashManager getTrashManager(FdkSession session)
                                          throws FdkException

Returns the trash manager used to perform operations on trash folders.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getUserManager

public static final UserManager getUserManager(FdkSession session)
                                        throws FdkException

Returns the User manager used to support user operations.

Parameters:: session - the session context
Returns:: the manager instance that can be used with the specified session context
Throws:: FdkException - other: if the operation fails

getVersionManager

public static final VersionManager getVersionManager(FdkSession session)
                                              throws FdkException