com.sapportals.connector.connection
Interface IConnectionSpecMetaData

public interface IConnectionSpecMetaData

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

Version:

1.0

Field Summary

static java.lang.String	CONNECTION_PROPERTY_DEFAULT_GROUP Default group for connection spec (most of non-SAP EISs use only the default group).
static java.lang.String	CONNECTION_PROPERTY_GROUP Group property.
static java.lang.String	CONNECTION_PROPERTY_LANGUAGE User Language.
static java.lang.String	CONNECTION_PROPERTY_PASSWORD Password for the user establishing a connection (Standard JCA)
static java.lang.String	CONNECTION_PROPERTY_SSOTICKET Single Sign On ticket for SAP systems
static java.lang.String	CONNECTION_PROPERTY_TIMEOUT Connection Timeout in milliseconds
static java.lang.String	CONNECTION_PROPERTY_USER Deprecated. use CONNECTION_PROPERTY_USERNAME instead.
static java.lang.String	CONNECTION_PROPERTY_USERNAME Name of the user establishing a connection to an EIS instance (Standard JCA)
static java.lang.String	CONNECTION_PROPERTY_VALIDATE_ALIVE Flag indicating whether to validate physical connection on matchManagedConnections()

Method Summary

java.util.Set	getAllConnectionProperties() Deprecated. First get the IConnectionPropertyGroup (getAllConnectionPropertyGroups(), getConnectionPropertyGroup(String) or getDefaultConnectionPropertyGroup()) and then use IConnectionPropertyGroup.getAllConnectionProperties()
java.util.Set	getAllConnectionPropertyGroups() Returns a set of pairs (entries) of names and values of IConnectionPropertyGroup objects
IConnectionProperty	getConnectionProperty(java.lang.String propertyName) Deprecated. First get the IConnectionPropertyGroup (getAllConnectionPropertyGroups(), getConnectionPropertyGroup(String) or getDefaultConnectionPropertyGroup()) and then use IConnectionPropertyGroup.getConnectionProperty(String)
IConnectionPropertyGroup	getConnectionPropertyGroup(java.lang.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
java.util.Set	retrieveAllConnectionPropertiesNames() Deprecated. First get the IConnectionPropertyGroup (getAllConnectionPropertyGroups(), getConnectionPropertyGroup(String) or getDefaultConnectionPropertyGroup()) and then use IConnectionPropertyGroup.retrieveAllConnectionPropertiesNames()
java.util.Set	retrieveAllConnectionPropertyGroupsNames() Returns a set of all connection property group names

Field Detail

CONNECTION_PROPERTY_USER

public static final java.lang.String CONNECTION_PROPERTY_USER

Deprecated. use CONNECTION_PROPERTY_USERNAME instead.

CONNECTION_PROPERTY_USERNAME

public static final java.lang.String CONNECTION_PROPERTY_USERNAME

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

CONNECTION_PROPERTY_PASSWORD

public static final java.lang.String CONNECTION_PROPERTY_PASSWORD

Password for the user establishing a connection (Standard JCA)

CONNECTION_PROPERTY_LANGUAGE

public static final java.lang.String CONNECTION_PROPERTY_LANGUAGE

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

CONNECTION_PROPERTY_SSOTICKET

public static final java.lang.String CONNECTION_PROPERTY_SSOTICKET

Single Sign On ticket for SAP systems

CONNECTION_PROPERTY_TIMEOUT

public static final java.lang.String CONNECTION_PROPERTY_TIMEOUT

Connection Timeout in milliseconds

CONNECTION_PROPERTY_GROUP

public static final java.lang.String CONNECTION_PROPERTY_GROUP

Group property. SAP system have several Connection Spec

CONNECTION_PROPERTY_DEFAULT_GROUP

public static final java.lang.String CONNECTION_PROPERTY_DEFAULT_GROUP

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

CONNECTION_PROPERTY_VALIDATE_ALIVE

public static final java.lang.String CONNECTION_PROPERTY_VALIDATE_ALIVE

Flag indicating whether to validate physical connection on matchManagedConnections()

Method Detail

retrieveAllConnectionPropertiesNames

public java.util.Set 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

public java.util.Set 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

public IConnectionProperty getConnectionProperty(java.lang.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

public java.util.Set retrieveAllConnectionPropertyGroupsNames()

Returns a set of all connection property group names

Returns:

Set containing names of all connection property groups

getAllConnectionPropertyGroups

public java.util.Set getAllConnectionPropertyGroups()

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

Returns:

Set containing all connection property groups

getConnectionPropertyGroup

public IConnectionPropertyGroup getConnectionPropertyGroup(java.lang.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

public IConnectionPropertyGroup getDefaultConnectionPropertyGroup()

Returns the default connection property group for this connector

See Also:

IConnectionPropertyGroup