|
Oracle Content Database Web Services Java API Reference 10g Release 1 (10.2) B31408-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.ifs.fdk.ManagersFactory
An abstract factory that returns instances of Oracle Content DB Manager classes, which serve as the entry point for accessing and using a Content DB instance.
Instances of this factory will return the appropriate Manager instances based on the environment from which it is being used, such as from an in-process server plug-in or from a remote web-services connection.
Instances of this factory are associated with a specific session and require credentials to be instantiated. Instances are obtained via the various login()
static methods.
When a client no longer needs an instance of this class, it must call logout()
so that the implementation can release any allocated resources. Failure to do so may result in sessions being kept alive forever.
THREAD SAFETY NOTE: The consumer of these objects must not assume that the implementations of this class are thread safe, though some may be. Because each instance returned by the login()
methods and instances of the Managers returned by the methods in this class are usually associated with a user session, the calling code should ensure that proper synchronization is done when calling the methods of this class or calling the methods of the Managers returned by this class. Please see the Java Memory Model (JSR-133) for more information.
Field Summary | |
static java.lang.String |
CONFIG_SERVER_VERSION The optional configuration parameter that can be passed to the underlying implementation in the configuration map, representing the server version the client is trying to connect to. |
protected static java.lang.String |
CONFIG_WS_URL The Web Services URL configuration property name passed to the implementation subclass in the Map configuration. |
Constructor Summary | |
protected |
ManagersFactory(java.util.Map config) Protected constructor. |
Method Summary | |
abstract ArchiveManager |
getArchiveManager() Returns the ArchiveManager instance. |
abstract AuditManager |
getAuditManager() Returns the AuditManager instance. |
abstract CategoryManager |
getCategoryManager() Returns the CategoryManager instance. |
abstract CommonManager |
getCommonManager() Returns the CommonManager instance. |
abstract ContainerManager |
getContainerManager() Returns the ContainerManager instance. |
abstract DomainManager |
getDomainManager() Returns the DomainManager instance. |
abstract FileContentManager |
getFileContentManager() Returns the FileContentManager instance. |
abstract FileManager |
getFileManager() Returns the FileManager instance. |
abstract GroupManager |
getGroupManager() Returns the GroupManager instance. |
abstract LockManager |
getLockManager() Returns the LockManager instance. |
abstract PagingManager |
getPagingManager() Returns the PagingManager instance. |
abstract QuotaManager |
getQuotaManager() Returns the QuotaManager instance. |
abstract RecordsManager |
getRecordsManager() Returns the RecordsManager instance. |
abstract RequestManager |
getRequestManager() Returns the RequestManager instance. |
abstract SearchManager |
getSearchManager() Returns the SearchManager instance. |
abstract SecurityManager |
getSecurityManager() Returns the SecurityManager instance. |
abstract SessionManager |
getSessionManager() Returns the SessionManager instance. |
abstract SortManager |
getSortManager() Returns the SortManager instance. |
abstract SystemConfigurationManager |
getSystemConfigurationManager() Returns the SystemConfigurationManager instance. |
abstract TrashManager |
getTrashManager() Returns the TrashManager instance. |
abstract Item |
getUser(AttributeRequest[] attributes) Returns the user as an Item that was authenticated for this instance. |
abstract UserManager |
getUserManager() Returns the UserManager instance. |
abstract VersionManager |
getVersionManager() Returns the VersionManager instance. |
abstract VirusManager |
getVirusManager() Returns the VirusManager instance. |
abstract WorkflowManager |
getWorkflowManager() Returns the WorkflowManager instance. |
abstract WorkspaceManager |
getWorkspaceManager() Returns the WorkspaceManager instance. |
static ManagersFactory |
login(FdkCredential credential) Returns an authenticated instance for use by in-process clients only. |
static ManagersFactory |
login(FdkCredential credential, java.lang.String wsUrl) Returns an authenticated instance for use by either remoted clients over Web Services if an URL is provided or in-process clients if the URL is null . |
static ManagersFactory |
login(FdkCredential credential, java.lang.String wsUrl, java.util.Map config) Returns an authenticated instance for use by either remoted clients over Web Services if an URL is provided or in-process clients if the URL is null . |
abstract void |
logout() The counterpart of the login() methods. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String CONFIG_SERVER_VERSION
protected static final java.lang.String CONFIG_WS_URL
null
and it represents the URL of the server to connect to, e.g. http://localhost:7777/content/ws
Constructor Detail |
protected ManagersFactory(java.util.Map config) throws FdkException
Method Detail |
public static ManagersFactory login(FdkCredential credential, java.lang.String wsUrl) throws FdkException
null
.credential
- The credential to use for authentication. Required.wsUrl
- The web services URL of the server to connect to, e.g. http://localhost:7777/content/ws
null
, the in-process instance is returned, which is equivalent to calling ManagersFactory.login(FdkCredential)
FdkException
public static ManagersFactory login(FdkCredential credential, java.lang.String wsUrl, java.util.Map config) throws FdkException
null
. Additionally, configuration parameters for the underlying implementation may be provided.credential
- The credential to use for authentication. Required.wsUrl
- The web services URL of the server to connect to, e.g. http://localhost:7777/content/ws
null
, the in-process instance is returned, which is equivalent to calling ManagersFactory.login(FdkCredential)
config
- The custom configuration parameters. Optional.FdkException
public static ManagersFactory login(FdkCredential credential) throws FdkException
Note that this method returns an instance of oracle.ifs.fdk.InProcessManagersFactory
and it is safe to cast to it in order to use its additional functionality.
credential
- The credential to use for authentication. Required.FdkException
public abstract void logout() throws FdkException
login()
methods.
Logs out any underlying session and disposes the resources allocated by this instance.
Clients must call this method when the instance is no longer needed (i.e. when the user session needs to be terminated).
FdkException
public abstract Item getUser(AttributeRequest[] attributes) throws FdkException
attributes
- Optional attributes to return. Can be null
.FdkException
public abstract CommonManager getCommonManager() throws FdkException
FdkException
public abstract FileManager getFileManager() throws FdkException
FdkException
public abstract RecordsManager getRecordsManager() throws FdkException
FdkException
public abstract SessionManager getSessionManager() throws FdkException
FdkException
public abstract ArchiveManager getArchiveManager() throws FdkException
FdkException
public abstract CategoryManager getCategoryManager() throws FdkException
FdkException
public abstract ContainerManager getContainerManager() throws FdkException
FdkException
public abstract DomainManager getDomainManager() throws FdkException
FdkException
public abstract GroupManager getGroupManager() throws FdkException
FdkException
public abstract LockManager getLockManager() throws FdkException
FdkException
public abstract PagingManager getPagingManager() throws FdkException
FdkException
public abstract QuotaManager getQuotaManager() throws FdkException
FdkException
public abstract RequestManager getRequestManager() throws FdkException
FdkException
public abstract SearchManager getSearchManager() throws FdkException
FdkException
public abstract SecurityManager getSecurityManager() throws FdkException
FdkException
public abstract SortManager getSortManager() throws FdkException
FdkException
public abstract SystemConfigurationManager getSystemConfigurationManager() throws FdkException
FdkException
public abstract TrashManager getTrashManager() throws FdkException
FdkException
public abstract UserManager getUserManager() throws FdkException
FdkException
public abstract VersionManager getVersionManager() throws FdkException
FdkException
public abstract VirusManager getVirusManager() throws FdkException
FdkException
public abstract WorkflowManager getWorkflowManager() throws FdkException
FdkException
public abstract WorkspaceManager getWorkspaceManager() throws FdkException
FdkException
public abstract FileContentManager getFileContentManager() throws FdkException
FdkException
public abstract AuditManager getAuditManager() throws FdkException
FdkException
|
Oracle Content Database Web Services Java API Reference 10g Release 1 (10.2) B31408-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |