com.sapportals.portal.ivs.cg
Interface IConnectorInvestigatorService

All Superinterfaces:
com.sapportals.portal.prt.service.IService

public interface IConnectorInvestigatorService
extends com.sapportals.portal.prt.service.IService

This interface allows to investigate the connectors and exposes connector's APIs.


Method Summary
 javax.naming.NamingEnumeration getConnectionFactories()
          Searches for deployed connectors.
 com.sapportals.connector.connection.IConnectionFactory getConnectionFactory(java.lang.String connectionFactoryName)
          Get the connection factory according to the connector name
 com.sapportals.connector.connection.IConnectionSpec getConnectionSpec(com.sapportals.connector.connection.IConnectionFactory connectionFactory)
          Retrieves the connection spec which describes the attributes needed by the connector in order to connect to the back end system.
 com.sapportals.connector.metadata.IConnectorMetaData getMetaDataEx(java.lang.String connectionFactoryName)
          Exposes IConnectionFactory.getMetaDataEx()
 
Methods inherited from interface com.sapportals.portal.prt.service.IService
afterInit, configure, destroy, getContext, getKey, init, release
 

Method Detail

getConnectionSpec

public com.sapportals.connector.connection.IConnectionSpec getConnectionSpec(com.sapportals.connector.connection.IConnectionFactory connectionFactory)
                                                                      throws com.sapportals.connector.ConnectorException
Retrieves the connection spec which describes the attributes needed by the connector in order to connect to the back end system.
Parameters:
connectionFactoryName - The id/name of the connector
connectionFactory - The factory of the connector which can be obtained from
public IConnectionFactory getConnectionFactory (String connectionFactoryName) throws Exception
Returns:
com.sapportals.connector.connection.IConnectionSpec
Since:
6.0

getConnectionFactories

public javax.naming.NamingEnumeration getConnectionFactories()
                                                      throws javax.naming.NamingException
Searches for deployed connectors.
Returns:
NamingEnumeration of NameClassPair objects.
Throws:
NamingException - if a naming exception is encountered.
Since:
6.0

getMetaDataEx

public com.sapportals.connector.metadata.IConnectorMetaData getMetaDataEx(java.lang.String connectionFactoryName)
                                                                   throws java.lang.Exception
Exposes IConnectionFactory.getMetaDataEx()
Returns:
IConnectorMetaData
Throws:
Exception - if an exception is encountered.
Since:
6.0

getConnectionFactory

public com.sapportals.connector.connection.IConnectionFactory getConnectionFactory(java.lang.String connectionFactoryName)
                                                                            throws com.sap.security.api.umap.NoLogonDataAvailableException
Get the connection factory according to the connector name
Returns:
The IConnectionFactory of the connector factory.
Throws:
Exception - if an exception is encountered.
Since:
6.0