Skip navigation links

oracle.stellent.ridc.convenience.adf.connection
Class AdfConnectionFacade

java.lang.Object
oracle.stellent.ridc.convenience.adf.connection.AdfConnectionFacade

public class AdfConnectionFacade

extends Object

Nested Class Summary

class

AdfConnectionFacade.ResultTestConnection Contains boolean for test's success, and a message from the test

Field Summary

protected RidcMxBeanManager	m_beanManager
protected String	m_connectionName
protected IdcClient	m_idcClient
protected IdcClientManager	m_idcClientManager
protected RidcConnection	m_ridcConnection

Constructor Summary

AdfConnectionFacade(String connectionName)

Method Summary

protected void	fetchConnection() fetches information from connections.xml using the ADFContext
Map<String,String>	getCredentialsFields(String credentialsLabel) Gets a map of the fields for the credentials label
Set<String>	getCredentialsLabels() Get all the credentials labels available
CredentialsType	getCredentialsType(String credentialsLabel) Gets the first credentials type that matches the credentials label.
IdcClient	getIdcClient() Return an IdcClient object from the ADF context.
RidcConnection	getRidcConnection()
Credentials	getUserCredentials(String credentialsLabel) Return a Credentials object from the ADF context's connections information
void	registerConnectionMBean() Registers connection mbean in the em console, if not already there
AdfConnectionFacade.ResultTestConnection	testConnection(String credentialsLabel) Test a credentials label for connectivity to content server
void	unregisterConnectionMBean() un-registers connection mbean in the em console

Methods inherited from class java.lang.Object

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

Field Detail

m_beanManager

protected RidcMxBeanManager m_beanManager

m_connectionName

protected String m_connectionName

m_idcClientManager

protected IdcClientManager m_idcClientManager

m_ridcConnection

protected RidcConnection m_ridcConnection

m_idcClient

protected IdcClient m_idcClient

Constructor Detail

AdfConnectionFacade

public AdfConnectionFacade(String connectionName)

Method Detail

getIdcClient

public IdcClient getIdcClient()
                       throws IdcClientException

Return an IdcClient object from the ADF context. This method will throw a ClassNotFoundException if you call it from an environment that doesn't have the ADF class stack.

Returns:

IdcClient

Throws:

Exception

IdcClientException

getUserCredentials

public Credentials getUserCredentials(String credentialsLabel)
                               throws IdcClientException

Return a Credentials object from the ADF context's connections information

Parameters:

credentialsLabel - Label of credentials in connections.xml "label.type.fieldname = fieldvalue"

Returns:

Throws:

IdcClientException

testConnection

public AdfConnectionFacade.ResultTestConnection testConnection(String credentialsLabel)

Test a credentials label for connectivity to content server

Parameters:

credentialsLabel - credentials label in connections.xml "label.type.fieldname = fieldvalue"

Returns:

getCredentialsLabels

public Set<String> getCredentialsLabels()
                                 throws IdcClientException

Get all the credentials labels available

Returns:

Set of credentials labels in connections.xml "label.type.fieldname = fieldvalue"

Throws:

IdcClientException

getRidcConnection

public RidcConnection getRidcConnection()
                                 throws IdcClientException

Returns:

RidcConnection object

Throws:

IdcClientException

fetchConnection

protected void fetchConnection()
                        throws IdcClientException

fetches information from connections.xml using the ADFContext

Throws:

IdcClientException

getCredentialsType

public CredentialsType getCredentialsType(String credentialsLabel)
                                   throws IdcClientException

Gets the first credentials type that matches the credentials label. Since the contents of connection.xml may not be returned in the same order each time, it is NOT recommended nor supported to have more than one type per label.

Parameters:

credentialsLabel - credentials label in connections.xml "label.type.fieldname = fieldvalue"

Returns:

credentials type or null

Throws:

IdcClientException

getCredentialsFields

public Map<String,String> getCredentialsFields(String credentialsLabel)
                                        throws IdcClientException

Gets a map of the fields for the credentials label

Parameters:

credentialsLabel - credentials label in connections.xml "label.type.fieldname = fieldvalue"

Returns:

Map of rows matching input parameters

Throws:

IdcClientException

registerConnectionMBean

public void registerConnectionMBean()
                             throws IdcClientException

Registers connection mbean in the em console, if not already there

Throws:

IdcClientException

unregisterConnectionMBean

public void unregisterConnectionMBean()
                               throws IdcClientException

un-registers connection mbean in the em console

Throws:

IdcClientException

Skip navigation links