com.sap.portal.connectivity.destinations

Class AbstractDestinationsRetrieverSource

java.lang.Object
  com.sap.portal.connectivity.destinations.AbstractDestinationsRetrieverSource

public abstract class AbstractDestinationsRetrieverSource
extends Object

Abstract parent of all source retrieve sources. Implementations of this class can register themselves on the destination service to be looked for destinations

Constructor Summary

AbstractDestinationsRetrieverSource(int source, String key, String desc)

Method Summary

abstract IConnection	getConnection(com.sap.security.api.IUser user, String destinationName) Gets Connector Framework connection to the back-end to a given destination name
abstract IConnection	getConnection(com.sap.security.api.IUser user, String destinationName, DestinationFilter destinationFilter) Gets Connector Framework connection to the back-end to a given destination name matching the destination filter
abstract IConnection	getConnection(com.sap.security.api.IUser user, String destinationName, DestinationFilter destinationFilter, String forcedUserName, String forcedPassword) Gets Connector Framework connection to the back-end to a given destination name matching the destination filter.
abstract IConnection	getConnection(com.sap.security.api.IUser user, String destinationName, String forcedUserName, String forcedPassword) Gets Connector Framework connection to the back-end to a given destination name.
abstract IConnection	getConnectionWithOverridingProps(com.sap.security.api.IUser user, String destinationName, DestinationFilter destinationFilter, Map<String,Object> overridingConnectionSpecProps) Gets Connector Framework connection to the back-end to a given destination name matching the destination filter.
abstract IConnection	getConnectionWithOverridingProps(com.sap.security.api.IUser user, String destinationName, Map<String,Object> overridingConnectionSpecProps) Gets Connector Framework connection to the back-end to a given destination name matching the destination filter.
String	getDescription()
abstract Vector<String>	getDestinationsNames(com.sap.security.api.IUser user, int typeFilterMask) Returens list of destination names matching given type filter mask
abstract IDestinationWrapper	getDestinationWrapper(com.sap.security.api.IUser user, String destinationName) Gets a destination wrapper by the destination name
String	getKey() Returns the destination retriever source key
int	getSource()
abstract boolean	supportsType(int type) Indicates whether the destination retriever holds instnaces of a given back-end type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractDestinationsRetrieverSource

public AbstractDestinationsRetrieverSource(int source,
                                           String key,
                                           String desc)

Method Detail

getSource

public int getSource()

Returns:

the source as an constant int defined in IDestinationWrapper

getDescription

public String getDescription()

Returns:

the destination retriever description

getDestinationsNames

public abstract Vector<String> getDestinationsNames(com.sap.security.api.IUser user,
                                                    int typeFilterMask)

Returens list of destination names matching given type filter mask

Parameters:

user - User asking for destination names

typeFilterMask - type filter mask (client may filter by more than 1 value by using the | operator)

Returns:

list of destination names (String)

getConnection

public abstract IConnection getConnection(com.sap.security.api.IUser user,
                                          String destinationName)
                                   throws PortalDestinationsServiceException

Gets Connector Framework connection to the back-end to a given destination name

Parameters:

user - User to connect with

destinationName - the name of the destination to connect to

Returns:

IConnection to the back-end

Throws:

PortalDestinationsServiceException - when fail to get a connection (e.g. no such destination name in the source repository, rejection from the back-end etc

getConnection

public abstract IConnection getConnection(com.sap.security.api.IUser user,
                                          String destinationName,
                                          DestinationFilter destinationFilter)
                                   throws PortalDestinationsServiceException

Gets Connector Framework connection to the back-end to a given destination name matching the destination filter

Parameters:

user - User to connect with

destinationName - the name of the destination to connect to

destinationFilter - filter of the source, type and SAP type

Returns:

IConnection to the back-end

Throws:

PortalDestinationsServiceException - when fail to get a connection (e.g. no such destination name in the source repository, rejection from the back-end etc

getConnection

public abstract IConnection getConnection(com.sap.security.api.IUser user,
                                          String destinationName,
                                          String forcedUserName,
                                          String forcedPassword)
                                   throws PortalDestinationsServiceException

Gets Connector Framework connection to the back-end to a given destination name. The connection is established overriding the destination definition of credentials. e.g. destination is set to use SSO, or username/password are not defined in the destination, the method will use the given user name and password

Parameters:

user - logged-on user to connect with

destinationName - the name of the destination to connect to

forcedUserName - user name to connect with to the back-end

forcedPassword - password to connect with to the back-end

Returns:

IConnection to the back-end

Throws:

PortalDestinationsServiceException - when fail to get a connection (e.g. no such destination name in the source repository, rejection from the back-end etc

getConnection

public abstract IConnection getConnection(com.sap.security.api.IUser user,
                                          String destinationName,
                                          DestinationFilter destinationFilter,
                                          String forcedUserName,
                                          String forcedPassword)
                                   throws PortalDestinationsServiceException

Gets Connector Framework connection to the back-end to a given destination name matching the destination filter. The connection is established overriding the destination definition of credentials. e.g. destination is set to use SSO, or username/password are not defined in the destination, the method will use the given user name and password

Parameters:

user - logged-on user to connect with

destinationName - the name of the destination to connect to

destinationFilter - filter of the source, type and SAP type

forcedUserName - user name to connect with to the back-end

forcedPassword - password to connect with to the back-end

Returns:

IConnection to the back-end

Throws:

PortalDestinationsServiceException - when fail to get a connection (e.g. no such destination name in the source repository, rejection from the back-end etc

getConnectionWithOverridingProps

public abstract IConnection getConnectionWithOverridingProps(com.sap.security.api.IUser user,
                                                             String destinationName,
                                                             Map<String,Object> overridingConnectionSpecProps)
                                                      throws PortalDestinationsServiceException

Gets Connector Framework connection to the back-end to a given destination name matching the destination filter. The connection is established overriding the destination connection spec with all values of overridingConnectionSpecProps

Parameters:

user - logged-on user to connect with

destinationName - the name of the destination to connect to

overridingConnectionSpecProps - Map for key-value pairs to override the definition of as defined in the source

Returns:

IConnection to the back-end

Throws:

PortalDestinationsServiceException

getConnectionWithOverridingProps

public abstract IConnection getConnectionWithOverridingProps(com.sap.security.api.IUser user,
                                                             String destinationName,
                                                             DestinationFilter destinationFilter,
                                                             Map<String,Object> overridingConnectionSpecProps)
                                                      throws PortalDestinationsServiceException

Gets Connector Framework connection to the back-end to a given destination name matching the destination filter. The connection is established overriding the destination connection spec with all values of overridingConnectionSpecProps

Parameters:

user - logged-on user to connect with

destinationName - the name of the destination to connect to

destinationFilter - filter of the source, type and SAP type

overridingConnectionSpecProps - Map for key-value pairs to override the definition of as defined in the source

Returns:

IConnection to the back-end

Throws:

PortalDestinationsServiceException

getDestinationWrapper

public abstract IDestinationWrapper getDestinationWrapper(com.sap.security.api.IUser user,
                                                          String destinationName)

Gets a destination wrapper by the destination name

Parameters:

user - to get the destination name with

destinationName - destination name to get the destination wrapper for

Returns:

IDestinationWrapper for the destination name, null if no such destination name exists

supportsType

public abstract boolean supportsType(int type)

Indicates whether the destination retriever holds instnaces of a given back-end type

Parameters:

type - type of the destination

Returns:

true if the destination retriver supports the back-end type, otherwise false

getKey

public String getKey()

Returns the destination retriever source key

Returns:

the key

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-CONNECTIVITY	[sap.com] tc/pp/smntcs/int/portalservicesapilibdeprecated	api	EP-VC-CON
[sap.com] EP-CONNECTIVITY	[sap.com] tc/ep/connectivity/lib/api	api	EP-VC-CON
[sap.com] EP-CONNECTIVITY	[sap.com] tc/ep/connectivity/api	api	EP-VC-CON