oracle.webcenter.doclib.model

Class DocLibUtils

java.lang.Object

oracle.webcenter.doclib.model.DocLibUtils

public final class DocLibUtils
extends java.lang.Object

Utility APIs for leveraging the Documents Service configuration in custom code

Since:

11.1.1.6.0

Constructor Summary

Constructors

Constructor and Description
DocLibUtils()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultConnectionName() Gets the name of the default content repository connection (see the setJCRContentServerConnection WLST command and other similar commands).
IdcContext	getDefaultIdcContext(java.lang.String connectionName) Reads the configuration for the Content Server connection identified by connectionName and return an IdcContext object that can be used to make calls to the Content Server.
<any>	getIdcClient(java.lang.String connectionName) Reads the configuration for the Content Server connection identified by connectionName and return an IdcClient object that can be used to make calls to the Content Server.
boolean	isConfiguredForSpaces() Checks if the Documents Service integration with WebCenter Portal: Spaces has been configured.
static boolean	isConfiguredForWCCRUI() Checks if the portal is configured for WCC RUI to function.
static boolean	provisionService(java.lang.String serviceId, oracle.webcenter.framework.service.Scope scope) Provisions the service if it is enabled.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocLibUtils

public DocLibUtils()

Method Detail

isConfiguredForSpaces

public boolean isConfiguredForSpaces()

Checks if the Documents Service integration with WebCenter Portal: Spaces has been configured. This checks all the prerequisite for the personal and space folders to be enabled:

• A default Content Server connection is configured (for more information see the createJCRContentServerConnection WLST command;
• The spaces root folder and application name have been configured (for more information, see the setDocumentsSpacesProperties WLST command).

Returns:

true If the documents service spaces features are configured

getDefaultConnectionName

public java.lang.String getDefaultConnectionName()

Gets the name of the default content repository connection (see the setJCRContentServerConnection WLST command and other similar commands).

Returns:

The default content repository connection name, or null if none is configured.

getIdcClient

public <any> getIdcClient(java.lang.String connectionName)
                   throws javax.naming.NameNotFoundException,
                          javax.naming.NamingException,
                          IdcClientException

Reads the configuration for the Content Server connection identified by connectionName and return an IdcClient object that can be used to make calls to the Content Server.

Parameters:

connectionName - The Content Server connection name

Returns:

The IdcClient that can be used to make calls to the Content Server. See the Remote Intradoc Client documentation for information on how to make calls to the Content Server.

Throws:

javax.naming.NameNotFoundException - If no Content Server connection can be found for that name

javax.naming.NamingException - If an error occurs reading the connection information

IdcClientException - If an error occurs while creating the IdcClient

getDefaultIdcContext

public IdcContext getDefaultIdcContext(java.lang.String connectionName)
                                throws javax.naming.NamingException,
                                       IdcClientException

Reads the configuration for the Content Server connection identified by connectionName and return an IdcContext object that can be used to make calls to the Content Server. This context object will carry the user's identity as specified in the configuration (using either identity propagation or credentials defined in an external application definition).

Parameters:

connectionName - The Content Server connection name

Returns:

The IdcContext that can be used to make calls to the Content Server using the same credentials that would be used in the documents service task-flows.

Throws:

javax.naming.NameNotFoundException - If no Content Server connection can be found for that name

javax.naming.NamingException - If an error occurs reading the connection information

IdcClientException - If an error occurs while creating the IdcClient

provisionService

public static boolean provisionService(java.lang.String serviceId,
                                       oracle.webcenter.framework.service.Scope scope)
                                throws SpacesException

Provisions the service if it is enabled. The call to provisionEnabledService should end up being a no-op if this is a custom app or the Personal "space"/"home portal".

Throws:

SpacesException

isConfiguredForWCCRUI

public static boolean isConfiguredForWCCRUI()

Checks if the portal is configured for WCC RUI to function. This involves checking if documents is configured and if RIDC connection required by WCC RUI exists. Also checking if the UCM configured is using Framework folders

Returns:

whether RIDC connection is configured or not