com.sapportals.connector.connection

Interface IConnectionSpecMetaData

public interface IConnectionSpecMetaData

The interface IConnectionSpecMetaData describes the metadata of the connection properties that compose the connectionSpec.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION_PROPERTY_DEFAULT_GROUP Default group for connection spec (most of non-SAP EISs use only the default group).
static String	CONNECTION_PROPERTY_GROUP Group property.
static String	CONNECTION_PROPERTY_LANGUAGE User Language.
static String	CONNECTION_PROPERTY_LOGON_METHOD_VALUE_NONE Logon property value NONE for systems that don't require authentication in the connection spec
static String	CONNECTION_PROPERTY_PASSWORD Password for the user establishing a connection (Standard JCA)
static String	CONNECTION_PROPERTY_SSOTICKET Single Sign On ticket for SAP systems
static String	CONNECTION_PROPERTY_TIMEOUT Connection Timeout in milliseconds
static String	CONNECTION_PROPERTY_USER Deprecated. use CONNECTION_PROPERTY_USERNAME instead.
static String	CONNECTION_PROPERTY_USERNAME Name of the user establishing a connection to an EIS instance (Standard JCA)
static String	CONNECTION_PROPERTY_VALIDATE_ALIVE Flag indicating whether to validate physical connection on matchManagedConnections()

Method Summary

Modifier and Type	Method and Description
Set<Map.Entry<String,IConnectionProperty>>	getAllConnectionProperties() Deprecated. First get the IConnectionPropertyGroup (getAllConnectionPropertyGroups(), getConnectionPropertyGroup(String) or getDefaultConnectionPropertyGroup()) and then use IConnectionPropertyGroup.getAllConnectionProperties()
Set	getAllConnectionPropertyGroups() Returns a set of pairs (entries) of names and values of IConnectionPropertyGroup objects
IConnectionProperty	getConnectionProperty(String propertyName) Deprecated. First get the IConnectionPropertyGroup (getAllConnectionPropertyGroups(), getConnectionPropertyGroup(String) or getDefaultConnectionPropertyGroup()) and then use IConnectionPropertyGroup.getConnectionProperty(String)
IConnectionPropertyGroup	getConnectionPropertyGroup(String propertyGroupName) Returns the connection property group for the given connection property group name.
IConnectionPropertyGroup	getDefaultConnectionPropertyGroup() Returns the default connection property group for this connector
Set<String>	retrieveAllConnectionPropertiesNames() Deprecated. First get the IConnectionPropertyGroup (getAllConnectionPropertyGroups(), getConnectionPropertyGroup(String) or getDefaultConnectionPropertyGroup()) and then use IConnectionPropertyGroup.retrieveAllConnectionPropertiesNames()
Set	retrieveAllConnectionPropertyGroupsNames() Returns a set of all connection property group names

Field Detail

CONNECTION_PROPERTY_USER

static final String CONNECTION_PROPERTY_USER

Deprecated. use CONNECTION_PROPERTY_USERNAME instead.

See Also:

Constant Field Values

CONNECTION_PROPERTY_USERNAME

static final String CONNECTION_PROPERTY_USERNAME

Name of the user establishing a connection to an EIS instance (Standard JCA)

See Also:

Constant Field Values

CONNECTION_PROPERTY_PASSWORD

static final String CONNECTION_PROPERTY_PASSWORD

Password for the user establishing a connection (Standard JCA)

See Also:

Constant Field Values

CONNECTION_PROPERTY_LANGUAGE

static final String CONNECTION_PROPERTY_LANGUAGE

User Language. The standard language string as defined in java.util.Locale and NOT the back-end application (EIS) language string. The connector's developer has to translate these strings.

See Also:

Constant Field Values

CONNECTION_PROPERTY_SSOTICKET

static final String CONNECTION_PROPERTY_SSOTICKET

Single Sign On ticket for SAP systems

See Also:

Constant Field Values

CONNECTION_PROPERTY_TIMEOUT

static final String CONNECTION_PROPERTY_TIMEOUT

Connection Timeout in milliseconds

See Also:

Constant Field Values

CONNECTION_PROPERTY_GROUP

static final String CONNECTION_PROPERTY_GROUP

Group property. SAP system have several Connection Spec

See Also:

Constant Field Values

CONNECTION_PROPERTY_DEFAULT_GROUP

static final String CONNECTION_PROPERTY_DEFAULT_GROUP

Default group for connection spec (most of non-SAP EISs use only the default group).

See Also:

Constant Field Values

CONNECTION_PROPERTY_VALIDATE_ALIVE

static final String CONNECTION_PROPERTY_VALIDATE_ALIVE

Flag indicating whether to validate physical connection on matchManagedConnections()

See Also:

Constant Field Values

CONNECTION_PROPERTY_LOGON_METHOD_VALUE_NONE

static final String CONNECTION_PROPERTY_LOGON_METHOD_VALUE_NONE

Logon property value NONE for systems that don't require authentication in the connection spec

See Also:

ICapabilities.CONNECTION_METADATA_CREDENTIALS_NOT_MANDATORY, Constant Field Values

Method Detail

retrieveAllConnectionPropertiesNames

Set<String> retrieveAllConnectionPropertiesNames()

Deprecated. First get the IConnectionPropertyGroup (getAllConnectionPropertyGroups(), getConnectionPropertyGroup(String) or getDefaultConnectionPropertyGroup()) and then use IConnectionPropertyGroup.retrieveAllConnectionPropertiesNames()

Returns a set of all possible connection properties names

Returns:

set containing names of all connection properties

getAllConnectionProperties

Set<Map.Entry<String,IConnectionProperty>> getAllConnectionProperties()

Deprecated. First get the IConnectionPropertyGroup (getAllConnectionPropertyGroups(), getConnectionPropertyGroup(String) or getDefaultConnectionPropertyGroup()) and then use IConnectionPropertyGroup.getAllConnectionProperties()

Returns a set of pairs (entries) of names and values of IConnectionProperty objects

Returns:

Set containing all connection properties

getConnectionProperty

IConnectionProperty getConnectionProperty(String propertyName)

Deprecated. First get the IConnectionPropertyGroup (getAllConnectionPropertyGroups(), getConnectionPropertyGroup(String) or getDefaultConnectionPropertyGroup()) and then use IConnectionPropertyGroup.getConnectionProperty(String)

Returns the connection property for the given connection property name.

Parameters:

propertyName - the name of the property

Returns:

propertyType the type of the property

See Also:

IConnectionProperty

retrieveAllConnectionPropertyGroupsNames

Set retrieveAllConnectionPropertyGroupsNames()

Returns a set of all connection property group names

Returns:

set containing names of all connection property groups

getAllConnectionPropertyGroups

Set getAllConnectionPropertyGroups()

Returns a set of pairs (entries) of names and values of IConnectionPropertyGroup objects

Returns:

set containing all connection property groups

getConnectionPropertyGroup

IConnectionPropertyGroup getConnectionPropertyGroup(String propertyGroupName)

Returns the connection property group for the given connection property group name.

Parameters:

propertyGroupName - the name of the property

Returns:

IConnectionPropertyGroup

See Also:

IConnectionPropertyGroup

getDefaultConnectionPropertyGroup

IConnectionPropertyGroup getDefaultConnectionPropertyGroup()

Returns the default connection property group for this connector

Returns:

IConnectionPropertyGroup interface

See Also:

IConnectionPropertyGroup