Skip navigation links

oracle.stellent.wcm.core.idc
Class IdcClientFactory

java.lang.Object
oracle.stellent.wcm.core.idc.IdcClientFactory

public class IdcClientFactory

extends java.lang.Object

Initializes an IdcClient from the given IdcConfiguration. Allows initialization from both ADF and using the specified properties in the configuration.

Constructor Summary

IdcClientFactory(IdcConfiguration idcConfig)

Method Summary

oracle.stellent.ridc.IdcContext	getAdminContext()
oracle.stellent.ridc.IdcClientManager	getClientManager()
oracle.stellent.ridc.IdcContext	getGuestContext()
oracle.stellent.ridc.IdcClient	getIdcClient() Initialize the IdcClient.
IdcConfiguration	getIdcConfig()
protected oracle.stellent.ridc.IdcClient	initialize() Perform the idc client initialization
protected oracle.stellent.ridc.IdcClient	initializeIdcClient(IdcConfiguration idcConfiguration) Initialize the IdcClient based on the IdcConfiguration properties
protected void	populateConfigFromADF(IdcConfiguration idcConfiguration) Populate the IdcConfiguration object using this IdcConnection via the ADF Connection Architecture.
void	validateConfiguration() Validate the configuration of the IdcClient; outputs an error message

Methods inherited from class java.lang.Object

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

Constructor Detail

IdcClientFactory

public IdcClientFactory(IdcConfiguration idcConfig)

Method Detail

getClientManager

public oracle.stellent.ridc.IdcClientManager getClientManager()

Returns:

the client manager used to create the idc client

getIdcConfig

public IdcConfiguration getIdcConfig()

Returns:

the idc configuration used to initialize this factory

getIdcClient

public oracle.stellent.ridc.IdcClient getIdcClient()
                                            throws LocalizedRuntimeException

Initialize the IdcClient. This will try to build an IdcClient by switching based on the presence of the "intradocServerPortUrl" property in the IdcClient properties. If present, the system will initialize the IdcClient using all specified properties. If not present, the system will attempt to use ADF to locate the connection information.

Returns:

the initialized component

Throws:

LocalizedRuntimeException - if an error occurs during initialization

getAdminContext

public oracle.stellent.ridc.IdcContext getAdminContext()

Returns:

the system admin context

getGuestContext

public oracle.stellent.ridc.IdcContext getGuestContext()

Returns:

the guest runtime context

validateConfiguration

public void validateConfiguration()

Validate the configuration of the IdcClient; outputs an error message

initialize

protected oracle.stellent.ridc.IdcClient initialize()
                                             throws LocalizedRuntimeException

Perform the idc client initialization

Returns:

the intiailzed idc client

Throws:

LocalizedRuntimeException

initializeIdcClient

protected oracle.stellent.ridc.IdcClient initializeIdcClient(IdcConfiguration idcConfiguration)
                                                      throws oracle.stellent.ridc.IdcClientException

Initialize the IdcClient based on the IdcConfiguration properties

Parameters:

idcConfiguration - the configuration

Returns:

the initialized IdcClient

Throws:

oracle.stellent.ridc.IdcClientException - if an error occurs

populateConfigFromADF

protected void populateConfigFromADF(IdcConfiguration idcConfiguration)
                              throws LocalizedRuntimeException

Populate the IdcConfiguration object using this IdcConnection via the ADF Connection Architecture. This requires ADF is installed and configured. The ADF system will be queried for the connection matching the configuration connection name.

Parameters:

idcConfiguration - the idc configuration

Throws:

LocalizedRuntimeException - if an error occurs during ADF processing

Skip navigation links