com.sapportals.connector.connection
Interface IConnectionProperty

public interface IConnectionProperty

IConnectionProperty provides an interface for defining certain connection properties for the connectionSpec. It is very important that every connector implements this interface for the following properties (required for the connector gateway service):

1. UserName ConnectionProperty - for defining user property.
2. Password ConnectionProperty - for defining password property.
3. Language ConnectionProperty - for defining language property.

Version:

1.0

See Also:

IConnectionSpecMetaData

Field Summary

static java.lang.String	CONNECTION_PROPERTY_TYPE_CONNECTION Group name for connection properties that are connection dependent.
static java.lang.String	CONNECTION_PROPERTY_TYPE_SYSTEM Group name for connection properties that are system dependent.
static java.lang.String	CONNECTION_PROPERTY_TYPE_USER Group name for connection properties that are user dependent.

Method Summary

java.util.Set	getComposingConnectionPropertyGroups() Returns the composed Connection Property groups
java.lang.Object	getDefaultValue() Returns the default value for this connection property.
boolean	getIsMandatory() Returns whether this property is mandatory
IPrimitive	getMetadata() Returns the primitive metadata type of the property.
java.lang.String	getType() Returns whether the property is a system connection property or user connection property
java.util.Set	getValidValues() Returns a Set of valid values for this connection property.

Field Detail

CONNECTION_PROPERTY_TYPE_SYSTEM

public static final java.lang.String CONNECTION_PROPERTY_TYPE_SYSTEM

Group name for connection properties that are system dependent.

CONNECTION_PROPERTY_TYPE_USER

public static final java.lang.String CONNECTION_PROPERTY_TYPE_USER

Group name for connection properties that are user dependent.

CONNECTION_PROPERTY_TYPE_CONNECTION

public static final java.lang.String CONNECTION_PROPERTY_TYPE_CONNECTION

Group name for connection properties that are connection dependent.

Method Detail

getIsMandatory

public boolean getIsMandatory()

Returns whether this property is mandatory

Returns:

boolean whether this property is mandatory

getMetadata

public IPrimitive getMetadata()

Returns the primitive metadata type of the property.

Returns:

IPrimitive

See Also:

IPrimitive

getType

public java.lang.String getType()

Returns whether the property is a system connection property or user connection property

Returns:

String

getValidValues

public java.util.Set getValidValues()

Returns a Set of valid values for this connection property. The set returned is of objects whose structure is described in getMetaData()

Returns:

Set - the Set of valid values for this connection property.

getDefaultValue

public java.lang.Object getDefaultValue()

Returns the default value for this connection property.

Returns:

String The value for this connection property.

getComposingConnectionPropertyGroups

public java.util.Set getComposingConnectionPropertyGroups()

Returns the composed Connection Property groups

Returns:

Set containing all connection property groups this connection property is part of