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.

See Also:
IConnectionSpecMetaData

Field Summary
static String CONNECTION_PROPERTY_TYPE_CONNECTION
          Group name for connection properties that are connection dependent.
static String CONNECTION_PROPERTY_TYPE_SYSTEM
          Group name for connection properties that are system dependent.
static String CONNECTION_PROPERTY_TYPE_USER
          Group name for connection properties that are user dependent.
 
Method Summary
 Set<IConnectionPropertyGroup> getComposingConnectionPropertyGroups()
          Returns the composed Connection Property groups
 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.
 String getType()
          Returns whether the property is a system connection property or user connection property
 Set<Object> getValidValues()
          Returns a Set of valid values for this connection property.
 

Field Detail

CONNECTION_PROPERTY_TYPE_SYSTEM

static final String CONNECTION_PROPERTY_TYPE_SYSTEM
Group name for connection properties that are system dependent.

See Also:
Constant Field Values

CONNECTION_PROPERTY_TYPE_USER

static final String CONNECTION_PROPERTY_TYPE_USER
Group name for connection properties that are user dependent.

See Also:
Constant Field Values

CONNECTION_PROPERTY_TYPE_CONNECTION

static final String CONNECTION_PROPERTY_TYPE_CONNECTION
Group name for connection properties that are connection dependent.

See Also:
Constant Field Values
Method Detail

getIsMandatory

boolean getIsMandatory()
Returns whether this property is mandatory

Returns:
boolean whether this property is mandatory

getMetadata

IPrimitive getMetadata()
Returns the primitive metadata type of the property.

Returns:
IPrimitive
See Also:
IPrimitive

getType

String getType()
Returns whether the property is a system connection property or user connection property

Returns:
String

getValidValues

Set<Object> 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

Object getDefaultValue()
Returns the default value for this connection property.

Returns:
String the value for this connection property.

getComposingConnectionPropertyGroups

Set<IConnectionPropertyGroup> getComposingConnectionPropertyGroups()
Returns the composed Connection Property groups

Returns:
Set containing all connection property groups this connection property is part of
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] FRAMEWORK-EXT [sap.com] tc/conn/connectorframeworkdeprecated default EP-CON-CF
[sap.com] EP-BASIS-API [sap.com] tc/epbc/connectivityfw/api api EP-PIN
[sap.com] FRAMEWORK-EXT [sap.com] tc/conn/connectorframeworkdeprecated - EP-CON-CF


Copyright 2013 SAP AG Complete Copyright Notice