com.sap.caf.eu.gp.connect.eptalias.api

Interface IGPEndpointAliasManager

public interface IGPEndpointAliasManager

Method Summary

void	checkEptAliasProperties(String typeName, Properties properties, IGPUserContext ctxt) Check if or not the properties for a connection are valid.
IGPEndpointAlias	createEndpointAlias(String name, String typeName, Properties properties, IGPUserContext ctxt) Creates an endpoint alias.
void	deleteEndpointAlias(String name, String typeName, IGPUserContext ctxt) Deletes an endpoint alias.
boolean	existEptAliases(String eptAliasTypeName, IGPUserContext ctxt) Checks if or not the given endpoint alias type already has got some endpoint aliases.
IGPConnectionDeliverTypeRegistry	getConnectionTypeRegistry() Returns the registry for serveral connection type.
Enumeration	getEndpointAliases(IGPUserContext ctxt) Returns all endpoint aliases.
IGPEptAliasTypeDefs	getEndpointAliasTypeDefs() Returns an endpoint alias type definitions, e.g.
Enumeration	getEptAliaseNames(String typeName) Returns all names of a given endpoint alias type.
IGPEndpointAlias	readEndpointAlias(String name, String typeName, IGPUserContext ctxt) Returns an endpoint alias.
Enumeration	searchEndpointAliases(String name, String typeName, IGPUserContext ctxt) Searchs for endpoint aliases.
void	writeEndpointAlias(String name, String typeName, Properties properties, IGPUserContext ctxt) Updates an endpoint alias.

Method Detail

createEndpointAlias

public IGPEndpointAlias createEndpointAlias(String name,
                                            String typeName,
                                            Properties properties,
                                            IGPUserContext ctxt)
                                     throws GPEngineException,
                                            GPInvocationException

Creates an endpoint alias.

The identifier of an endpoint alias is always the name and the type.

Parameters:

name - - the name of enpoint alias.Can not be null.

typeName - - the type of endpoint alias.Can not be null.

properties - - the properties of endpoint alias.Can not be null.

ctxt - - information about the user.
Can not be null.

Returns:

an endpoint alias.

Throws:

EngineException - - thrown if something went wrong during creating.

GPInvocationException - - thrown if the input parameters are not valid.

GPEngineException

getEndpointAliases

public Enumeration getEndpointAliases(IGPUserContext ctxt)
                               throws GPEngineException,
                                      GPInvocationException

Returns all endpoint aliases. The enumeration is never null.

Parameters:

ctxt - - information about the user.
Can not be null

Returns:

either all IWEndPointAlias or a empty enumeration.

Throws:

GPEngineException - - thrown if something went wrong during reading.

GPInvocationException - - thrown if the input parameters are not valid.

readEndpointAlias

public IGPEndpointAlias readEndpointAlias(String name,
                                          String typeName,
                                          IGPUserContext ctxt)
                                   throws GPEngineException,
                                          GPInvocationException

Returns an endpoint alias.

Parameters:

name - - the name of enpoint alias.Can not be null.

typeName - - the type of endpoint alias.Can not be null.

ctxt - - information about the user. Can not be null.

Returns:

an endpoint alias or null if the specified endpoint alias does not exist.

Throws:

GPEngineException - - thrown if something went wrong during reading.

GPInvocationException - - thrown if then input parameters are not valid.

deleteEndpointAlias

public void deleteEndpointAlias(String name,
                                String typeName,
                                IGPUserContext ctxt)
                         throws GPEngineException,
                                GPInvocationException

Deletes an endpoint alias.

Parameters:

name - - the name of endpoint alias.Can not be null.

typeName - - the type of endpoint alias. Can not be null.

ctxt - - information about the user.Can not be null.Can not be null.

Throws:

GPEngineException - - thrown if something went wrong during deleting.

GPInvocationException - - thrown if then input parameters are not valid.

writeEndpointAlias

public void writeEndpointAlias(String name,
                               String typeName,
                               Properties properties,
                               IGPUserContext ctxt)
                        throws GPEngineException,
                               GPInvocationException

Updates an endpoint alias.

Parameters:

name - - the name of endpoint alias.Can not be null.

typeName - - the type of endpoint alias.Can not be null.

properties - - the properties of endpoint alias.Can not be null.

ctxt - - information about the user. Can not be null.

Throws:

GPEngineException - - thrown if something went wrong during writing.

GPInvocationException - - thrown if then input parameters are not valid.

getEndpointAliasTypeDefs

public IGPEptAliasTypeDefs getEndpointAliasTypeDefs()
                                             throws GPEngineException

Returns an endpoint alias type definitions, e.g. Remote Function Call (RFC)

.

Throws:

GPEngineException - - thrown if something went wrong during writing.

searchEndpointAliases

public Enumeration searchEndpointAliases(String name,
                                         String typeName,
                                         IGPUserContext ctxt)
                                  throws GPEngineException,
                                         GPInvocationException

Searchs for endpoint aliases. The enumeration is never null.

Parameters:

name - - the name of endpoint alias.Can be null.

typeName - - the type of endpoint alias.Can not be null.

ctxt - - information about the user.

Returns:

either the endpoint aliases that were found or an empty enumeration.

Throws:

GPEngineException - - thrown if something went wrong during searching.

GPInvocationException - - thrown if then input parameters are not valid.

checkEptAliasProperties

public void checkEptAliasProperties(String typeName,
                                    Properties properties,
                                    IGPUserContext ctxt)
                             throws GPInvocationException,
                                    GPEngineException

Check if or not the properties for a connection are valid. A exception is thrown
if the properties could not use in order to for instance log on to a R/3 system.

Parameters:

typeName - - the type of endpoint alias. Can not be null.

properties - - the logon properties. Can not be null.
NOTE:

Those properties must contain the properties of endpoint.

ctxt - - information about a user.

Throws:

GPInvocationException - - thrown if the input parameters are invalid.

GPEngineException - - thrown if the properties are invalid.

existEptAliases

public boolean existEptAliases(String eptAliasTypeName,
                               IGPUserContext ctxt)
                        throws GPInvocationException,
                               GPEngineException

Checks if or not the given endpoint alias type already has got some endpoint aliases.

Parameters:

eptAliasTypeName - - the endpoint alias type (technical name). Use the
constants provided by the class: "IEndpointAlias".
Can not be null.

ctxt - - information about a user.

Returns:

true (if some exist) or false (if no exist).

Throws:

GPInvocationException - - if the input parameter is not valid.

GPEngineException - - if something went wrong during checking.

getEptAliaseNames

public Enumeration getEptAliaseNames(String typeName)
                              throws GPInvocationException,
                                     GPEngineException

Returns all names of a given endpoint alias type. The enumeration might be empty.
NOTE:
The endpoint alias types are defined within the interface: IEndpointAlias.
Can never be null.

Parameters:

typeName - - the endpoint alias type. Never null

Returns:

Returns all names of a given endpoint alias type.

Throws:

GPInvocationException - - thrown if the input value is invalid.

GPEngineException - - thrown if something went wrong during reading.

getConnectionTypeRegistry

public IGPConnectionDeliverTypeRegistry getConnectionTypeRegistry()
                                                           throws GPEngineException

Returns the registry for serveral connection type. With the help of this registry
it is possible to provide a functionality for testing the configuration a certain
endpoint alias

Returns:

the registry for serveral connection type.

Throws:

GPEngineException - - thrown if sonething went wrong during returning the registry.