com.sapportals.portal.ivs.cg
Interface IConnectorGatewayService

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

public interface IConnectorGatewayService
extends com.sapportals.portal.prt.service.IService, IConnectorGatewayService

SAP portal service to establish connection to backends. Most of the service API reside in a J2EE library com.sap.portal.services.api.connectorgateway.IConnectorGatewayService to enable access to this service to J2EE services as well

Usage example in a Portal Component:

IConnectorGatewayService cgService =
    (IConnectorGatewayService)PortalRuntime.getRuntimeResources().
    getService(IConnectorGatewayService.KEY);

ConnectionProperties cp = new ConnectionProperties(request.getLocale(),
    (IPrincipal) request.getUser());

// For a Connector Framework connection:
com.sapportals.connector.connection.IConnection con =
    cgService.getConnection("sapSystem1", cp);

// For a JDBC connection:
java.sql.Connection conn = cgService.getDistributedConnection(new String[]
    {"sapSystem1","jdbcSystem2"}, cp );

Version:
6.11

Fields inherited from interface com.sap.portal.services.api.connectorgateway.IConnectorGatewayService
CONNECTORS_FOLDER, CONNECTORS_SUB_FOLDER, KEY, SERVICE_JNDI_NAME
 
Method Summary
 com.sapportals.connector.connection.IConnection getConnection(java.lang.String systemAlias, com.sapportals.portal.prt.component.IPortalComponentRequest request)
          Deprecated. use super interface getConnection(String,ConnectionProperties)
 java.sql.Connection getDistributedConnection(java.lang.String[] systemsAliases, com.sapportals.portal.prt.component.IPortalComponentRequest request)
          Deprecated. use super interface getDistributedConnection(String[],ConnectionProperties)
 
Methods inherited from interface com.sapportals.portal.prt.service.IService
afterInit, configure, destroy, getContext, getKey, init, release
 
Methods inherited from interface com.sap.portal.services.api.connectorgateway.IConnectorGatewayService
getConnection, getConnectionFactories, getConnectionFactory, getConnectionSpec, getDistributedConnection
 

Method Detail

getConnection

public com.sapportals.connector.connection.IConnection getConnection(java.lang.String systemAlias,
                                                                     com.sapportals.portal.prt.component.IPortalComponentRequest request)
Deprecated. use super interface getConnection(String,ConnectionProperties)

Returns a connection to a connector Supports request related and user mapping related properties
Parameters:
systemAlias -  
request - IPortalComponentRequest from which user context & locale are retrieved
Returns:
Initialized handler to Connector Framework connection

getDistributedConnection

public java.sql.Connection getDistributedConnection(java.lang.String[] systemsAliases,
                                                    com.sapportals.portal.prt.component.IPortalComponentRequest request)
                                             throws java.sql.SQLException,
                                                    java.lang.ClassNotFoundException,
                                                    javax.naming.NamingException,
                                                    com.sap.security.api.umap.NoLogonDataAvailableException
Deprecated. use super interface getDistributedConnection(String[],ConnectionProperties)

Returns a DQE JDBC connection to all specified distributed backends
Parameters:
systemsAliases - Array of system aliases
request - IPortalComponentRequest from which user context & locale are retrieved
Returns:
java.sql.Connection to all specified backends
Throws:
java.sql.SQLException -  
java.lang.ClassNotFoundException -  
javax.naming.NamingException -  
com.sap.security.api.umap.NoLogonDataAvailableException -