com.sap.security.core.server.destinations.api

Interface DestinationService


public interface DestinationService

J2EE service for obtaining connections to backend systems. To use, add a classloader reference from you application to
tc/sec/destinations/service and tc/sec/destinations/interface

Code example for obtaining a HTTP destination

Context ctx = new InitialContext();
DestinationService dstService = (DestinationService) ctx.lookup(DestinationService.JNDI_KEY);
Destination destination = dstService.getDestination(type, name);
HTTPDestination myDestination = (HTTPDestination ) dst.getDestination("HTTP","dst-1");
HttpURLConnection connection = myDestination.getURLConnection();


Field Summary
static String JNDI_KEY
          JNDI name under which the service is registered.
 
Method Summary
 Destination createDestination(String type)
          Create a destination of a given destination type.
 Destination createDestination(String type, Object data)
          Return an instance of a defined destination by passing over the configuration data
 Destination getDestination(String type, String name)
          Return an instance of a defined destination
 List getDestinationNames(String destinationType)
          Return an Iterator with known destination names for a destination type.
 List getDestinationTypes()
          Return an Iterator with known destination types.
 Hashtable getKeystoreViews()
          Reads the list of keystore views and client certificates from the keystore service The name of the views are taken as the keys for the hashtable, with the name of the aliases in the keystore stored as List Used internally
 Object getUIMetaData(String type, Object data)
          Used internally for obtaining UI information
 PingResult ping(String destinationType, String destinationName)
          Execute ping on a destination
 void removeDestination(String type, String name)
          Remove an destination from the destination store
 void storeDestination(String type, Destination destination)
          Add a destination of a given destination type The destination may not yet exist.
 void updateDestination(String type, Destination destination)
          Update a destination of a given destination type.
 

Field Detail

JNDI_KEY

public static final String JNDI_KEY
JNDI name under which the service is registered. This constant can be used for JNDI lookup.

See Also:
Constant Field Values
Method Detail

getDestination

public Destination getDestination(String type,
                                  String name)
                           throws DestinationException,
                                  RemoteException
Return an instance of a defined destination

Throws:
DestinationException
RemoteException

createDestination

public Destination createDestination(String type,
                                     Object data)
                              throws DestinationException,
                                     RemoteException
Return an instance of a defined destination by passing over the configuration data

Throws:
DestinationException
RemoteException

getDestinationTypes

public List getDestinationTypes()
Return an Iterator with known destination types. The entries are of type String.


getDestinationNames

public List getDestinationNames(String destinationType)
                         throws DestinationException,
                                RemoteException
Return an Iterator with known destination names for a destination type. The entries are of type String.

Throws:
DestinationException
RemoteException

createDestination

public Destination createDestination(String type)
                              throws DestinationException,
                                     RemoteException
Create a destination of a given destination type. It does not store the destination.

Throws:
DestinationException
RemoteException

updateDestination

public void updateDestination(String type,
                              Destination destination)
                       throws DestinationException,
                              RemoteException
Update a destination of a given destination type. The destination must exists before.

Throws:
DestinationException
RemoteException

storeDestination

public void storeDestination(String type,
                             Destination destination)
                      throws DestinationException,
                             RemoteException
Add a destination of a given destination type The destination may not yet exist.

Throws:
DestinationException
RemoteException

removeDestination

public void removeDestination(String type,
                              String name)
                       throws DestinationException,
                              RemoteException
Remove an destination from the destination store

Throws:
DestinationException
RemoteException

getKeystoreViews

public Hashtable getKeystoreViews()
                           throws DestinationException,
                                  RemoteException
Reads the list of keystore views and client certificates from the keystore service The name of the views are taken as the keys for the hashtable, with the name of the aliases in the keystore stored as List Used internally

Throws:
DestinationException
RemoteException

getUIMetaData

public Object getUIMetaData(String type,
                            Object data)
                     throws DestinationException,
                            RemoteException
Used internally for obtaining UI information

Parameters:
type -
data -
Returns:
Throws:
DestinationException
RemoteException

ping

public PingResult ping(String destinationType,
                       String destinationName)
                throws DestinationException,
                       RemoteException
Execute ping on a destination

Parameters:
destinationType -
destinationName -
Returns:
Throws:
RemoteException
DestinationException


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.