com.sapportals.connector.connection
Interface IConnectionSpec

All Superinterfaces:

javax.resource.cci.ConnectionSpec

public interface IConnectionSpec

extends javax.resource.cci.ConnectionSpec

IConnectionSpec is used by an application component to pass connection request-specific properties to the IConnectionFactory.getConnectionEx method. It is recommended that the IConnectionSpec interface be implemented as a JavaBean. The properties on the ConnectionSpec implementation class must be defined through the getter and setter methods pattern. The implementation of the IConnectionSpec must include a Map of IConnectionProperty properties. That includes the following ConnectionProperties: UserName, Password and Language (Using these specific names). The Language connection property holds 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.

Version:

1.0

See Also:

ConnectionSpec

Method Summary

java.util.Set	getAllConnectionProperties() Returns a set of pairs (entries) of names and values of IConnectionProperty objects For example ["User","name of a user"],["Password,"password value"]...
java.lang.Object	getPropertyValue(java.lang.String propertyName) Get the value of one property
IConnectionSpecMetaData	retrieveConnectionSpecMetaData() The interface IConnectionSpecMetaData defines the metadata of the properties that compose the ConnectionSpec
void	setPropertyValue(java.lang.String propertyName, java.lang.Object propertyValue) Set the value of one property

Method Detail

setPropertyValue

public void setPropertyValue(java.lang.String propertyName,
                             java.lang.Object propertyValue)

Set the value of one property

Parameters:

propertyName - The name of the property to set value for

propertyValue - The new property value

getPropertyValue

public java.lang.Object getPropertyValue(java.lang.String propertyName)

Get the value of one property

Parameters:

propertyName - The name of the property to set value for

Returns:

propertyValue

retrieveConnectionSpecMetaData

public IConnectionSpecMetaData retrieveConnectionSpecMetaData()

The interface IConnectionSpecMetaData defines the metadata of the properties that compose the ConnectionSpec

Returns:

IConnectionSpecMetaData MetaData for connectionSpec

getAllConnectionProperties

public java.util.Set getAllConnectionProperties()

Returns a set of pairs (entries) of names and values of IConnectionProperty objects For example ["User","name of a user"],["Password,"password value"]... The set should be a set of java.util.Map.Entry objects

Returns:

Set containing all connection properties