com.sap.portal.services.api.connectorgateway
Interface IConnectorGatewayService

All Known Subinterfaces:

IConnectorGatewayService

public interface IConnectorGatewayService

Interface for the Portal service 'Connector Service' (com.sap.portal.ivs.connectorservice). The interface reside inside a J2EE library (and not inside the portal application) in order to enable a J2EE Service (as well as all other J2EE components) to reference and use it

The Connector service provides 2 kinds of connections:

1. A Connector Framework connection IConnection (extension of JCA) which enable to execute query and function (interaction)
2. A JDBC connection java.sql.Connection to execute query using JDBC API over distributed backends

Version:

7.00

Field Summary

static java.lang.String	CONNECTORS_FOLDER Connectors JNDI root folder
static java.lang.String	CONNECTORS_SUB_FOLDER Connectors JNDI sub folder
static java.lang.String	KEY Constant for service KEY (portal application name + service name in portalapp.xml)
static java.lang.String	SERVICE_JNDI_NAME JNDI lookup string for this service

Method Summary

com.sapportals.connector.connection.IConnection	getConnection(java.lang.String systemAlias, ConnectionProperties connectionProperties) Returns a Connector Framework connection for given system alias
javax.naming.NamingEnumeration	getConnectionFactories() Gets all deployed connectors factory names
com.sapportals.connector.connection.IConnectionFactory	getConnectionFactory(java.lang.String facotryName) Get the Connector Framework connection factory by connector factory 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.
java.sql.Connection	getDistributedConnection(java.lang.String[] systemAliases, ConnectionProperties connectionProperties) Returns a JDBC connection for distributed backends

Field Detail

KEY

public static final java.lang.String KEY

Constant for service KEY (portal application name + service name in portalapp.xml)

SERVICE_JNDI_NAME

public static final java.lang.String SERVICE_JNDI_NAME

JNDI lookup string for this service

CONNECTORS_FOLDER

public static final java.lang.String CONNECTORS_FOLDER

Connectors JNDI root folder

CONNECTORS_SUB_FOLDER

public static final java.lang.String CONNECTORS_SUB_FOLDER

Connectors JNDI sub folder

Method Detail

getConnection

public com.sapportals.connector.connection.IConnection getConnection(java.lang.String systemAlias,
                                                                     ConnectionProperties connectionProperties)
                                                              throws com.sapportals.connector.ConnectorException,
                                                                     com.sap.security.api.umap.NoLogonDataAvailableException

Returns a Connector Framework connection for given system alias

Parameters:

systemAlias - The portal system alias of the backend

connectionProperties - properties object from which user & locale are read

Returns:

a Connector Framework connection (JCA connection)

Throws:

ConnectorException -

com.sap.security.api.umap.NoLogonDataAvailableException -

getDistributedConnection

public java.sql.Connection getDistributedConnection(java.lang.String[] systemAliases,
                                                    ConnectionProperties connectionProperties)
                                             throws java.sql.SQLException,
                                                    java.lang.ClassNotFoundException,
                                                    javax.naming.NamingException,
                                                    com.sap.security.api.umap.NoLogonDataAvailableException

Returns a JDBC connection for distributed backends

Parameters:

systemAliases - Array of system aliases

connectionProperties - properties object from which user & locale are read

Returns:

Connection A java.sql.Connection object

Throws:

java.sql.SQLException -

java.lang.ClassNotFoundException -

javax.naming.NamingException -

com.sap.security.api.umap.NoLogonDataAvailableException -

getConnectionFactory

public com.sapportals.connector.connection.IConnectionFactory getConnectionFactory(java.lang.String facotryName)
                                                                            throws com.sap.security.api.umap.NoLogonDataAvailableException

Get the Connector Framework connection factory by connector factory name

Parameters:

facotryName - The connector factory name as the connector registered in JNDI

Returns:

Connector Framework IConnectionFactory

Throws:

com.sap.security.api.umap.NoLogonDataAvailableException -

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:

connectionFactory - IConnectionFactory of the system

Returns:

Connector Framework IConnectionSpec

Throws:

ConnectorException -

getConnectionFactories

public javax.naming.NamingEnumeration getConnectionFactories()
                                                      throws javax.naming.NamingException

Gets all deployed connectors factory names

Returns:

NamingEnumeration of deployed connectors factory names

Throws:

javax.naming.NamingException -