Skip navigation links

oracle.ifs.fdk
Class ManagersFactory

java.lang.Object
oracle.ifs.fdk.ManagersFactory

Direct Known Subclasses:

InProcessManagersFactory

public abstract class ManagersFactory

extends java.lang.Object

Represents an abstraction factory that can return the right instances to be used in various environments such as in-process, remoted or to connect to other systems.

The subclass instances are associated with a specific session and they require credentials in order to get started. An instance is obtained via the various login() static methods.

When the client no longer needs the instance, it must call logout() on it 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()
abstract CategoryManager	getCategoryManager()
abstract CommonManager	getCommonManager()
abstract ContainerManager	getContainerManager()
abstract DomainManager	getDomainManager()
abstract FileContentManager	getFileContentManager()
abstract FileManager	getFileManager()
abstract GroupManager	getGroupManager()
abstract LockManager	getLockManager()
abstract PagingManager	getPagingManager()
abstract QuotaManager	getQuotaManager()
abstract RequestManager	getRequestManager()
abstract SearchManager	getSearchManager()
abstract SecurityManager	getSecurityManager()
abstract SessionManager	getSessionManager()
abstract SortManager	getSortManager()
abstract SystemConfigurationManager	getSystemConfigurationManager()
abstract TrashManager	getTrashManager()
abstract Item	getUser(AttributeRequest[] attributes) Returns the user as an Item that was authenticated for this instance.
abstract UserManager	getUserManager()
abstract VersionManager	getVersionManager()
abstract VirusManager	getVirusManager()
abstract WorkflowManager	getWorkflowManager()
abstract WorkspaceManager	getWorkspaceManager()
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

CONFIG_SERVER_VERSION

public static final java.lang.String CONFIG_SERVER_VERSION

Description copied from class: ManagersFactory

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. This is mainly used when connecting over Web Services. Not all underlying implementations may support this parameter or they may support only specific version values. The value is of the form 10.1.2.x.x, 10.1.3.x.x but the implementation may also support major version only such as 10.1.2, 10.1.3, etc.

CONFIG_WS_URL

protected static final java.lang.String CONFIG_WS_URL

Description copied from class: ManagersFactory

The Web Services URL configuration property name passed to the implementation subclass in the Map configuration. The value is guaranteed to be non-null and it represents the URL of the server to connect to, e.g. http://localhost:7777/content/ws

Constructor Detail

ManagersFactory

protected ManagersFactory(java.util.Map config)
                   throws FdkException

Protected constructor.

Throws:

FdkException

Method Detail

login

public static ManagersFactory login(FdkCredential credential,
                                    java.lang.String wsUrl)
                             throws FdkException

Description copied from class: ManagersFactory

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.

Parameters:

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
If null, the in-process instance is returned, which is equivalent to calling ManagersFactory.login(FdkCredential)

Throws:

FdkException

login

public static ManagersFactory login(FdkCredential credential,
                                    java.lang.String wsUrl,
                                    java.util.Map config)
                             throws FdkException

Description copied from class: ManagersFactory

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. Additionally, configuration parameters for the underlying implementation may be provided.

Parameters:

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
If null, the in-process instance is returned, which is equivalent to calling ManagersFactory.login(FdkCredential)

config - The custom configuration parameters. Optional.

Throws:

FdkException

login

public static ManagersFactory login(FdkCredential credential)
                             throws FdkException

Description copied from class: ManagersFactory

Returns an authenticated instance for use by in-process clients only. Note that the returned class type will be oracle.ifs.fdk.InProcessManagersFactory and it is safe to cast to it in order to use its additional functionality.

Parameters:

credential - The credential to use for authentication. Required.

Throws:

FdkException

logout

public abstract void logout()
                     throws FdkException

Description copied from class: ManagersFactory

The counterpart of the 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).

Throws:

FdkException

getUser

public abstract Item getUser(AttributeRequest[] attributes)
                      throws FdkException

Description copied from class: ManagersFactory

Returns the user as an Item that was authenticated for this instance. Additional attributes of the user can be requested.

Parameters:

attributes - Optional attributes to return. Can be null.

Throws:

FdkException

getCommonManager

public abstract CommonManager getCommonManager()
                                        throws FdkException

Returns:

The CommonManager instance.

Throws:

FdkException

getFileManager

public abstract FileManager getFileManager()
                                    throws FdkException

Returns:

The FileManager instance.

Throws:

FdkException

getSessionManager

public abstract SessionManager getSessionManager()
                                          throws FdkException

Returns:

The SessionManager instance.

Throws:

FdkException

getArchiveManager

public abstract ArchiveManager getArchiveManager()
                                          throws FdkException

Returns:

The ArchiveManager instance.

Throws:

FdkException

getCategoryManager

public abstract CategoryManager getCategoryManager()
                                            throws FdkException

Returns:

The CategoryManager instance.

Throws:

FdkException

getContainerManager

public abstract ContainerManager getContainerManager()
                                              throws FdkException

Returns:

The ContainerManager instance.

Throws:

FdkException

getDomainManager

public abstract DomainManager getDomainManager()
                                        throws FdkException

Returns:

The DomainManager instance.

Throws:

FdkException

getGroupManager

public abstract GroupManager getGroupManager()
                                      throws FdkException

Returns:

The GroupManager instance.

Throws:

FdkException

getLockManager

public abstract LockManager getLockManager()
                                    throws FdkException

Returns:

The LockManager instance.

Throws:

FdkException

getPagingManager

public abstract PagingManager getPagingManager()
                                        throws FdkException

Returns:

The PagingManager instance.

Throws:

FdkException

getQuotaManager

public abstract QuotaManager getQuotaManager()
                                      throws FdkException

Returns:

The QuotaManager instance.

Throws:

FdkException

getRequestManager

public abstract RequestManager getRequestManager()
                                          throws FdkException

Returns:

The RequestManager instance.

Throws:

FdkException

getSearchManager

public abstract SearchManager getSearchManager()
                                        throws FdkException

Returns:

The SearchManager instance.

Throws:

FdkException

getSecurityManager

public abstract SecurityManager getSecurityManager()
                                            throws FdkException

Returns:

The SecurityManager instance.

Throws:

FdkException

getSortManager

public abstract SortManager getSortManager()
                                    throws FdkException

Returns:

The SortManager instance.

Throws:

FdkException

getSystemConfigurationManager

public abstract SystemConfigurationManager getSystemConfigurationManager()
                                                                  throws FdkException

Returns:

The SystemConfigurationManager instance.

Throws:

FdkException

getTrashManager

public abstract TrashManager getTrashManager()
                                      throws FdkException

Returns:

The TrashManager instance.

Throws:

FdkException

getUserManager

public abstract UserManager getUserManager()
                                    throws FdkException

Returns:

The UserManager instance.

Throws:

FdkException

getVersionManager

public abstract VersionManager getVersionManager()
                                          throws FdkException

Returns:

The VersionManager instance.

Throws:

FdkException

getVirusManager

public abstract VirusManager getVirusManager()
                                      throws FdkException

Returns:

The VirusManager instance.

Throws:

FdkException

getWorkflowManager

public abstract WorkflowManager getWorkflowManager()
                                            throws FdkException

Returns:

The WorkflowManager instance.

Throws:

FdkException

getWorkspaceManager

public abstract WorkspaceManager getWorkspaceManager()
                                              throws FdkException

Returns:

The WorkspaceManager instance.

Throws:

FdkException

getFileContentManager

public abstract FileContentManager getFileContentManager()
                                                  throws FdkException

Returns:

The FileContentManager instance.

Throws:

FdkException

Skip navigation links