openconnector

Class ConnectorConfig

java.lang.Object

openconnector.ConnectorConfig

public class ConnectorConfig
extends java.lang.Object

A ConnectorConfig contains information about how a connector should connect to a resource, how the connector should behave, and how objects will look on a resource.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_DELTA_AGGREGATION A Reseerved ConnectorConfig parameter name that is passed in to indicate that delta aggregation is to be performed.
static java.lang.String	CONFIG_DELTA_AGGREGATION_STATE A Reseerved ConnectorConfig parameter name that is used to save state related to delta aggregation.

Constructor Summary

Constructors

Constructor and Description
ConnectorConfig() Create an empty configuration.

Method Summary

Modifier and Type	Method and Description
void	addSchema(Schema schema) Add one schema.
java.lang.Object	getAttribute(java.lang.String name)
boolean	getBoolean(java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>	getConfig()
Schema	getSchema(java.lang.String objectType) Find a schema by object type.
java.util.List<Schema>	getSchemas()
java.lang.String	getString(java.lang.String name)
java.lang.String	getTypedAttribute(java.lang.String attributeName, java.lang.String objectType)
void	setAttribute(java.lang.String attributeName, java.lang.Object value) Set an attribute value in the configuration.
void	setConfig(java.util.Map<java.lang.String,java.lang.Object> config) Set the map of configuration parameters.
void	setSchemas(java.util.List<Schema> schemas) Set the list of schemas supported by this connector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_DELTA_AGGREGATION

public static final java.lang.String CONFIG_DELTA_AGGREGATION

A Reseerved ConnectorConfig parameter name that is passed in to indicate that delta aggregation is to be performed.

On the IIQ side, this is passed in the options Map to the iterate() method, here since we merge the Application config attributes and the options into a single ConnectorConfig we have to be careful about name collisions. On the IIQ side this name is also used for delta agg state.

See Also:

Constant Field Values

CONFIG_DELTA_AGGREGATION_STATE

public static final java.lang.String CONFIG_DELTA_AGGREGATION_STATE

A Reseerved ConnectorConfig parameter name that is used to save state related to delta aggregation. The value must be a Map<String,Object> and the Connector may store any XML serializable objects in this map. The Map may be updated either during iteration or when Connector.close is called. The contents of this Map will be persisted by the host, and passed in the ConnectorConfig on the next call to this Connector.

This is functionally equivalent to the IIQ side attribute Application.ATTR_DELTA_AGGREGATION but we have to use a different name since configuration attributes and options are merged here and "deltaAggregation" is used to indiciate the desire for delta agg.

See Also:

Constant Field Values

Constructor Detail

ConnectorConfig

public ConnectorConfig()

Create an empty configuration.

Method Detail

getConfig

public java.util.Map<java.lang.String,java.lang.Object> getConfig()

Returns:

a map with the configuration parameters.

setConfig

public void setConfig(java.util.Map<java.lang.String,java.lang.Object> config)

Set the map of configuration parameters.

getSchemas

public java.util.List<Schema> getSchemas()

Returns:

the list of schemas supported by this connector. This can be null if the schema is implicit.

setSchemas

public void setSchemas(java.util.List<Schema> schemas)

Set the list of schemas supported by this connector.

addSchema

public void addSchema(Schema schema)

Add one schema.

getSchema

public Schema getSchema(java.lang.String objectType)

Find a schema by object type.

setAttribute

public void setAttribute(java.lang.String attributeName,
                         java.lang.Object value)

Set an attribute value in the configuration.

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

getTypedAttribute

public java.lang.String getTypedAttribute(java.lang.String attributeName,
                                          java.lang.String objectType)

Returns:

the string value of an attribute from the config for the given object type (if specified). This first looks for an attribute with "objectType.attributeName" as the key. If no value is found, this looks for an attribute with "attributeName" as the key.

getString

public java.lang.String getString(java.lang.String name)

Returns:

the string value of an attribute from the config.

getBoolean

public boolean getBoolean(java.lang.String name)