com.sapportals.portal.ivs.cg

Interface IConnectorGatewayService

All Superinterfaces:
IConnectorGatewayService, IService

public interface IConnectorGatewayService
extends 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 );


Field Summary
 
Fields inherited from interface com.sap.portal.services.api.connectorgateway.IConnectorGatewayService
CONNECTORS_FOLDER, CONNECTORS_SUB_FOLDER, KEY, SERVICE_JNDI_NAME
 
Method Summary
 IConnection getConnection(String systemAlias, IPortalComponentRequest request)
          Deprecated. use super interface getConnection(String,ConnectionProperties)
 Connection getDistributedConnection(String[] systemsAliases, 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 IConnection getConnection(String systemAlias,
                                 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 Connection getDistributedConnection(String[] systemsAliases,
                                           IPortalComponentRequest request)
                                    throws SQLException,
                                           ClassNotFoundException,
                                           NamingException,
                                           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:
SQLException
ClassNotFoundException
NamingException
NoLogonDataAvailableException


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.