Skip navigation links

Oracle® WebCenter Content Site Studio for External Applications Java API Reference
11g Release 1 (11.1.1)

E17273-03


oracle.stellent.wcm.core.idc
Class IdcClientFactory

java.lang.Object
  extended by 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)
          Create IdcClientFactory using default configuration class
IdcClientFactory(IdcConfiguration idcConfig, javax.servlet.ServletConfig servletConfig)
          Create IdcClientFactory optionally using a custom configuration class

 

Method Summary
 oracle.stellent.ridc.IdcContext getAdminContext()
           
 oracle.stellent.ridc.IdcClientManager getClientManager()
           
 oracle.stellent.ridc.IdcContext getGuestContext()
           
 oracle.stellent.ridc.convenience.adf.mbeans.IdcClientAdapter getIdcClientAdapter()
          Initialize the IdcClient.
 IdcConfiguration getIdcConfig()
           
 javax.servlet.ServletConfig getServletConfig()
           
 java.lang.String getSSUrlFieldName()
           
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
 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,
                        javax.servlet.ServletConfig servletConfig)
Create IdcClientFactory optionally using a custom configuration class
Parameters:
idcConfig - IdcConfiguration to be used
servletConfig - ServletConfiguration used

IdcClientFactory

public IdcClientFactory(IdcConfiguration idcConfig)
Create IdcClientFactory using default configuration class
Parameters:
idcConfig - IdcConfiguration to be used

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

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

getSSUrlFieldName

public java.lang.String getSSUrlFieldName()
Returns:
field name holding the Friendly Name value. If null, then no Friendly name has been configured on Content Server

getIdcClientAdapter

public oracle.stellent.ridc.convenience.adf.mbeans.IdcClientAdapter getIdcClientAdapter()
                                                                                 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()
                           throws oracle.stellent.ridc.IdcClientException
Validate the configuration of the IdcClient; outputs an error message
Throws:
oracle.stellent.ridc.IdcClientException

initialize

protected oracle.stellent.ridc.IdcClient initialize()
                                             throws java.lang.Exception
Perform the idc client initialization
Returns:
the initialized idc client
Throws:
java.lang.Exception

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

Skip navigation links

Oracle® WebCenter Content Site Studio for External Applications Java API Reference
11g Release 1 (11.1.1)

E17273-03


Copyright © 2010, 2011, Oracle and/or its affiliates. All rights reserved.