org.identityconnectors.framework.impl.api

Class APIConfigurationImpl

java.lang.Object

org.identityconnectors.framework.impl.api.APIConfigurationImpl

All Implemented Interfaces:

APIConfiguration

public class APIConfigurationImpl
extends Object
implements APIConfiguration

Constructor Summary

Constructors

Constructor and Description
APIConfigurationImpl()
APIConfigurationImpl(APIConfigurationImpl other)

Method Summary

Modifier and Type	Method and Description
ConfigurationPropertiesImpl	getConfigurationProperties() Gets instance of the configuration properties.
AbstractConnectorInfo	getConnectorInfo()
ObjectPoolConfiguration	getConnectorPoolConfiguration() Gets the connector pooling configuration.
String	getInstanceName()
int	getProducerBufferSize() Get the size of the buffer.
ResultsHandlerConfiguration	getResultsHandlerConfiguration() Get the configuration of the ResultsHandler chain of the Search operation.
Set<Class<? extends APIOperation>>	getSupportedOperations() Get the set of operations that this ConnectorFacade will support.
int	getTimeout(Class<? extends APIOperation> operation) Gets the timeout in milliseconds based on the operation provided.
Map<Class<? extends APIOperation>,Integer>	getTimeoutMap()
boolean	isConnectorPoolingSupported() Determines if this Connector uses the framework's connector pooling.
boolean	isSupportedOperation(Class<? extends APIOperation> api)
void	setConfigurationProperties(ConfigurationPropertiesImpl properties)
void	setConnectorInfo(AbstractConnectorInfo connectorInfo)
void	setConnectorPoolConfiguration(ObjectPoolConfiguration config)
void	setConnectorPoolingSupported(boolean supported)
void	setInstanceName(String instanceName) Set name of the instance that this facade represents.
void	setProducerBufferSize(int size) Sets the size of the buffer for Connector the support SearchOp and what the results of the producer buffered.
void	setResultsHandlerConfiguration(ResultsHandlerConfiguration config)
void	setSupportedOperations(Set<Class<? extends APIOperation>> op)
void	setTimeout(Class<? extends APIOperation> operation, int timeout) Sets the timeout value for the operation provided.
void	setTimeoutMap(Map<Class<? extends APIOperation>,Integer> map)

Methods inherited from class java.lang.Object

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

Constructor Detail

APIConfigurationImpl

public APIConfigurationImpl()

APIConfigurationImpl

public APIConfigurationImpl(APIConfigurationImpl other)

Method Detail

getConnectorInfo

public AbstractConnectorInfo getConnectorInfo()

setConnectorInfo

public void setConnectorInfo(AbstractConnectorInfo connectorInfo)

setConnectorPoolingSupported

public void setConnectorPoolingSupported(boolean supported)

setConnectorPoolConfiguration

public void setConnectorPoolConfiguration(ObjectPoolConfiguration config)

setConfigurationProperties

public void setConfigurationProperties(ConfigurationPropertiesImpl properties)

getTimeoutMap

public Map<Class<? extends APIOperation>,Integer> getTimeoutMap()

setTimeoutMap

public void setTimeoutMap(Map<Class<? extends APIOperation>,Integer> map)

setSupportedOperations

public void setSupportedOperations(Set<Class<? extends APIOperation>> op)

isSupportedOperation

public boolean isSupportedOperation(Class<? extends APIOperation> api)

isConnectorPoolingSupported

public boolean isConnectorPoolingSupported()

Determines if this Connector uses the framework's connector pooling.

Specified by:

isConnectorPoolingSupported in interface APIConfiguration

Returns:

true if the Connector uses the framework's connector pooling feature.

getConnectorPoolConfiguration

public ObjectPoolConfiguration getConnectorPoolConfiguration()

Gets the connector pooling configuration. This is initialized to the default values. Caller can then modify the properties as needed.

Specified by:

getConnectorPoolConfiguration in interface APIConfiguration

getConfigurationProperties

public ConfigurationPropertiesImpl getConfigurationProperties()

Gets instance of the configuration properties. These are initialized to their default values based on meta information. Caller can then modify the properties as needed.

Specified by:

getConfigurationProperties in interface APIConfiguration

getTimeout

public int getTimeout(Class<? extends APIOperation> operation)

Gets the timeout in milliseconds based on the operation provided.

Specified by:

getTimeout in interface APIConfiguration

Parameters:

operation - particular operation to get a timeout for.

Returns:

milliseconds to wait for an operation to complete before throwing an error.

getSupportedOperations

public Set<Class<? extends APIOperation>> getSupportedOperations()

Get the set of operations that this ConnectorFacade will support.

Specified by:

getSupportedOperations in interface APIConfiguration

setTimeout

public void setTimeout(Class<? extends APIOperation> operation,
                       int timeout)

Sets the timeout value for the operation provided.

Specified by:

setTimeout in interface APIConfiguration

Parameters:

operation - particular operation that requires a timeout.

timeout - milliseconds that the operation will wait in order to complete. Values less than or equal to zero are considered to disable the timeout property.

setProducerBufferSize

public void setProducerBufferSize(int size)

Sets the size of the buffer for Connector the support SearchOp and what the results of the producer buffered.

Specified by:

setProducerBufferSize in interface APIConfiguration

Parameters:

size - default is 100, if size is set to zero or less will disable buffering.

getProducerBufferSize

public int getProducerBufferSize()

Get the size of the buffer.

Specified by:

getProducerBufferSize in interface APIConfiguration

getResultsHandlerConfiguration

public ResultsHandlerConfiguration getResultsHandlerConfiguration()

Get the configuration of the ResultsHandler chain of the Search operation.

Specified by:

getResultsHandlerConfiguration in interface APIConfiguration

setResultsHandlerConfiguration

public void setResultsHandlerConfiguration(ResultsHandlerConfiguration config)

setInstanceName

public void setInstanceName(String instanceName)

Set name of the instance that this facade represents. The name should represent the system that the connector connects to. This is also known as "resource" name, "connector instance" name, "target system" name, etc. The name will be used mostly for diagnostic purposes, e.g. it will may be included in log messages to distinguish individual instances of the same connector.

Specified by:

setInstanceName in interface APIConfiguration

Parameters:

instanceName - Name of the instance that this facade represents.

getInstanceName

public String getInstanceName()