openconnector

Class AbstractConnector

java.lang.Object

openconnector.AbstractConnector

All Implemented Interfaces:

Connector

public abstract class AbstractConnector
extends java.lang.Object
implements Connector

An abstract implementation of the Connector interfaces that all connectors should extend. This provides basic configuration support and throws UnsupportedOperationExceptions for most methods.

Extending this class is not required to use the connector with IdentityIQ, but it is required if you want to test and maintain the connector using XModule.

Nested Class Summary

Nested classes/interfaces inherited from interface openconnector.Connector

Connector.Feature

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Object>	_state Stores connector state modifications in memory
protected ConnectorConfig	config An object containing configuration parameters such as the host, port, and credentials for communicating with the managed system.
static java.lang.String	CONFIG_RETRYABLE_ERRORS The name of the configuration attribute that is used when shouldRetry method is called by the connector implementation to Check if the error message is configured to be retried.
protected Log	log A log abstraction for sending diagnostic messages.
protected java.lang.String	objectType The currently configured object type.
protected Schema	schema The Schema that matches the object type, found within the ConnectorCnfig.
StatisticsCollector	statisticsCollector The StatisticsCollector object is require for passing statistics of connectors during Aggregation process.

Fields inherited from interface openconnector.Connector

ARG_CURRENT, ARG_EXPIRATION, ARG_PARTITION, ATT_DELETED, ATT_DISABLED, ATT_LOCKED, ATT_PASSWORD, ATT_PERMISSIONS, OBJECT_TYPE_ACCOUNT, OBJECT_TYPE_GROUP, OBJECT_TYPE_TICKET

Constructor Summary

Constructors

Constructor and Description
AbstractConnector() Default constructor - required for reflective instantiation.
AbstractConnector(ConnectorConfig config, Log log) Constructor for an account connector that uses the given config.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	authenticate(java.lang.String accountId, java.util.Map<java.lang.String,java.lang.Object> options) Perform pass-through authentication with additional options.
java.util.Map<java.lang.String,java.lang.Object>	authenticate(java.lang.String identity, java.lang.String password) Perform pass-through authentication.
java.util.Map<java.lang.String,java.lang.Object>	buildOptions(Request request) Build up the options that will be passed down to each of the operations that have options.
Result	checkStatus(java.lang.String id) Default implementation of check status that does nothing.
void	close() Release resource held by this connector.
void	configure(ConnectorConfig config, Log log) Save the configuration object and log interface in local fields for later use.
Result	create(java.lang.String id, java.util.List<Item> items) Create an object of the currently configured type on the resource.
Result	delete(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> options) Delete the object of the configured object type that has the given native identifier.
void	destroy(java.util.Map<java.lang.String,java.lang.Object> optionsMap) Called by aggregator at the end of aggregation
Result	disable(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> options) Disable the object of the configured object type that has the given native identifier.
Schema	discoverSchema() Discover the Schema for the currently configured object type.
java.util.Map	doHealthCheck(java.util.Map<java.lang.String,java.lang.Object> options) Light Weight Test Connection
protected Result	doSystemItems(Request req, java.util.List<Item> items, java.lang.String id) Helper for provision, process the list of system items.
Result	enable(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> options) Enable the object of the configured object type that has the given native identifier.
protected static java.util.List<java.lang.Object>	getAsList(java.lang.Object val)
protected static java.util.List<java.lang.String>	getAsStringList(java.lang.Object val)
protected boolean	getBoolean(java.lang.String attrName)
java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>	getChangeLogExtract(java.util.Map<java.lang.String,java.lang.Object> requestParams) Default implementation of the getChangeLogExtract method, which throws a UnsupportedOperationException exception.
ConnectorConfig	getConfig()
java.util.Map<java.lang.String,java.lang.Object>	getConfigOptions(java.lang.String configOptionsKey) Default implementation of getConfigOptions method that does nothing.
ConnectorServices	getConnectorServices()
java.util.Map<java.lang.String,java.lang.Object>	getDeltaAggregationState() Convenience method to get the delta aggregation state.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getExtractPartitions(java.util.Map<java.lang.String,java.lang.Object> requestParams, java.lang.String extractType) This method will be called to get extract Partition for ARM extract requests
java.lang.Boolean	getFeatureFlagValue(java.lang.String name, boolean defaultValue) This method will return value of featureFlag name provided.
protected java.lang.String	getIdentityAttribute() Convenience method to return the identityAttribute from the Schema for the currently configured object type.
protected int	getInt(java.lang.String attrName, int defaultValue)
java.util.List<Partition>	getIteratorPartitions(int suggestedPartitionCount, Filter filter, java.util.Map<java.lang.String,java.lang.Object> ops) Default implementation of the getIteratorPartitions method, which returns null by default.
Log	getLog()
protected java.lang.String	getNativeIdentifier(java.util.Map<java.lang.String,java.lang.Object> obj)
java.lang.String	getObjectType()
boolean	getProductFlagValue(java.lang.String name, boolean defaultValue) Returns requested Product Flag set by CCG, if not set then return default value.
protected java.lang.String	getRequiredString(java.lang.String attrName)
Schema	getSchema()
java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>	getSecurityExtract(java.util.Map<java.lang.String,java.lang.Object> requestParams) Default implementation of the getSecurityExtract method, which throws a UnsupportedOperationException exception.
protected java.lang.String	getString(java.lang.String attrName)
java.util.List<Connector.Feature>	getSupportedFeatures(java.lang.String objectType) The default is GET and ITERATE.
java.util.List<java.lang.String>	getSupportedObjectTypes() Return a list of the object types supported by this connector.
java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>	getUtilizationExtract(java.util.Map<java.lang.String,java.lang.Object> requestParams) Default implementation of the getUtilizationExtract method, which throws a UnsupportedOperationException exception.
boolean	isExceptionRetryable(java.lang.Exception e) Check weather the exception is eligible for retry.
protected java.util.Map<java.lang.String,java.lang.Object>	itemsToMap(java.util.List<Item> items) Given a list of Items, convert them into a Map.
java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>	iterate(Partition partition) Default implementation of the iterate(Partition) method, which throws UnsupportedOperationException by default.
void	notifyListeners() Notify listener when connector config changes
void	provision(Plan plan) Default implementation of the plan evaluation method that parses the plan and calls down to a simpler set of methods that can be implemented by the subclass.
void	registerListener(ConnectorStateChangeListener listener) Register listener interested in connector config changes
void	saveConnectorState() Finally save the new connector state values into the app config
void	setConnectorServices(ConnectorServices connServices) Sets the ConnectorServices object, provided by OpenConnectorAdapter.
void	setConnectorState(java.lang.String attribute, java.lang.Object val) Interface to set connector state values
void	setDeltaAggregationState(java.util.Map<java.lang.String,java.lang.Object> state) Convenience method to set the delta aggregation state.
void	setLog(Log log) Change the log used by this connector.
void	setObjectType(java.lang.String type) Set the target object type.
Result	setPassword(java.lang.String id, java.lang.String newPassword, java.lang.String currentPassword, java.util.Date expiration, java.util.Map<java.lang.String,java.lang.Object> options) Set the password for the given object to the newPassword.
void	setRetryStatus(Result result) Helper for setting retry status - Iterate through all the messages from the result and call shoudRetry for each one If it can be retried, check if the retry threshold is configured, set that in the result
void	setStatisticsCollector(StatisticsCollector statisticsCollector) Set the StatisticsCollector object require for underlying connector to push the aggreagtion statistics.
boolean	shouldRetry(java.lang.Exception e, java.lang.String error) Helper for checking if the provisioning error can be retried - 1.
boolean	supportsPartitionedDeltaAggregation() Gets if the connector supports partitioned delta aggregation
void	testConnection() Test the connection to the managed system.
protected void	throwUnsupported(java.lang.String method)
Result	unlock(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> options) Unlock the object of the configured object type that has the given native identifier.
Result	update(java.lang.String id, java.util.List<Item> items) Update the object of the given type using the given item list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface openconnector.Connector

iterate, read

Field Detail

config

protected ConnectorConfig config

An object containing configuration parameters such as the host, port, and credentials for communicating with the managed system.

log

protected Log log

A log abstraction for sending diagnostic messages.

objectType

protected java.lang.String objectType

The currently configured object type. This will effect the behavior of the read() and iterate() methods.

schema

protected Schema schema

The Schema that matches the object type, found within the ConnectorCnfig.

_state

protected java.util.Map<java.lang.String,java.lang.Object> _state

Stores connector state modifications in memory

CONFIG_RETRYABLE_ERRORS

public static final java.lang.String CONFIG_RETRYABLE_ERRORS

The name of the configuration attribute that is used when shouldRetry method is called by the connector implementation to Check if the error message is configured to be retried. This attribute will contain the list of the attributes that are configured to be able to be retried in the application attribute.

See Also:

Constant Field Values

statisticsCollector

public StatisticsCollector statisticsCollector

The StatisticsCollector object is require for passing statistics of connectors during Aggregation process. This is cross cutting concern of recording aggregation statistics which will be helpful for monitoring aggregation performance.

Constructor Detail

AbstractConnector

public AbstractConnector()

Default constructor - required for reflective instantiation.

AbstractConnector

public AbstractConnector(ConnectorConfig config,
                         Log log)

Constructor for an account connector that uses the given config.

Method Detail

configure

public void configure(ConnectorConfig config,
                      Log log)

Save the configuration object and log interface in local fields for later use. This must be called only once immediately after or during construction.

Specified by:

configure in interface Connector

Parameters:

config - The ConnectorConfig that specifies connection parameters and schemas.

log - An implementation of Log that the connector can use for logging.

See Also:

Connector.configure(ConnectorConfig, Log)

getConfig

public ConnectorConfig getConfig()

Specified by:

getConfig in interface Connector

Returns:

the configuration object.

See Also:

Connector.getConfig()

setDeltaAggregationState

public void setDeltaAggregationState(java.util.Map<java.lang.String,java.lang.Object> state)

Convenience method to set the delta aggregation state.

getDeltaAggregationState

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

Convenience method to get the delta aggregation state. Return value may be null.

setConnectorState

public void setConnectorState(java.lang.String attribute,
                              java.lang.Object val)

Interface to set connector state values

Specified by:

setConnectorState in interface Connector

Parameters:

attribute - The attribute that needs to be set a new value

val - The value to set against the attribute

saveConnectorState

public void saveConnectorState()

Finally save the new connector state values into the app config

Specified by:

saveConnectorState in interface Connector

getLog

public Log getLog()

Specified by:

getLog in interface Connector

Returns:

the log configured for this connector.

setLog

public void setLog(Log log)

Change the log used by this connector.

setObjectType

public void setObjectType(java.lang.String type)

Set the target object type. Besides saving the type in a field we will also search the ConectorConfig for a matching schema and cache that in a field.

Specified by:

setObjectType in interface Connector

Parameters:

type - The target object type for future method calls. This can be one of the OBJECT_TYPE_* constants or any supported object type.

getObjectType

public java.lang.String getObjectType()

Specified by:

getObjectType in interface Connector

Returns:

the currently configured object type.

getSchema

public Schema getSchema()

Returns:

the schema from the ConnectorConfig that matches the currently configured object type.

setConnectorServices

public void setConnectorServices(ConnectorServices connServices)

Sets the ConnectorServices object, provided by OpenConnectorAdapter.

Specified by:

setConnectorServices in interface Connector

getConnectorServices

public ConnectorServices getConnectorServices()

Specified by:

getConnectorServices in interface Connector

Returns:

the ConnectorServices object.

close

public void close()

Release resource held by this connector. Does nothing in the abstract implementation.

Specified by:

close in interface Connector

See Also:

Connector.close()

testConnection

public void testConnection()
                    throws ConnectorException

Test the connection to the managed system.

Specified by:

testConnection in interface Connector

Throws:

ConnectorException

See Also:

Connector.testConnection()

doHealthCheck

public java.util.Map doHealthCheck(java.util.Map<java.lang.String,java.lang.Object> options)
                            throws ConnectorException,
                                   java.lang.UnsupportedOperationException

Light Weight Test Connection

Specified by:

doHealthCheck in interface Connector

Parameters:

options - : kept null as of now as testConnection() is void Returning , can be used for future extension

Returns:

Map

Throws:

ConnectorException

java.lang.UnsupportedOperationException

getSupportedObjectTypes

public java.util.List<java.lang.String> getSupportedObjectTypes()

Description copied from interface: Connector

Return a list of the object types supported by this connector. This list can contain any of the OBJECT_TYPE_* constants or any arbitrary type that is supported by the connector.

Specified by:

getSupportedObjectTypes in interface Connector

Returns:

the supported object types. The default is only to support OBJECT_TYPE_ACCOUNT. Subclasses can override to add support for groups or other object types.

getSupportedFeatures

public java.util.List<Connector.Feature> getSupportedFeatures(java.lang.String objectType)

The default is GET and ITERATE.

Specified by:

getSupportedFeatures in interface Connector

Returns:

the list of supported features.

getFeatureFlagValue

public java.lang.Boolean getFeatureFlagValue(java.lang.String name,
                                             boolean defaultValue)

This method will return value of featureFlag name provided. There are three possibilities of value as true, false or null. null will be returned only if there is not implementation to fetch value.

Parameters:

name -

defaultValue -

Returns:

value for the given featureFlag.

getProductFlagValue

public boolean getProductFlagValue(java.lang.String name,
                                   boolean defaultValue)

Returns requested Product Flag set by CCG, if not set then return default value.

Parameters:

name -

defaultValue -

Returns:

value for the requested Product Flag.

authenticate

public java.util.Map<java.lang.String,java.lang.Object> authenticate(java.lang.String identity,
                                                                     java.lang.String password)
                                                              throws ConnectorException,
                                                                     AuthenticationFailedException,
                                                                     ExpiredPasswordException,
                                                                     ObjectNotFoundException,
                                                                     java.lang.UnsupportedOperationException

Perform pass-through authentication.

Specified by:

authenticate in interface Connector

Parameters:

identity - A value for an identifying attribute of the account to authenticate with.

password - The password to use to authenticate.

Returns:

The authenticated account if authentication was successful.

Throws:

ConnectorException - If the operation fails.

AuthenticationFailedException - If authentication failed.

ExpiredPasswordException - If authentication failed because of an expired password.

ObjectNotFoundException - If an object that matches the given identity could not be found.

java.lang.UnsupportedOperationException - If the AUTHENTICATE feature is not supported.

See Also:

AbstractConnector.authenticate(String, String)

authenticate

public java.util.Map<java.lang.String,java.lang.Object> authenticate(java.lang.String accountId,
                                                                     java.util.Map<java.lang.String,java.lang.Object> options)
                                                              throws ConnectorException,
                                                                     AuthenticationFailedException,
                                                                     ExpiredPasswordException,
                                                                     ObjectNotFoundException,
                                                                     java.lang.UnsupportedOperationException

Perform pass-through authentication with additional options.

Specified by:

authenticate in interface Connector

Parameters:

accountId - A value for an identifying attribute of the account to authenticate with.

options - Additional options to consider during authentication including the password.

Returns:

The authenticated account if authentication was successful.

Throws:

ConnectorException - If the operation fails.

AuthenticationFailedException - If authentication failed.

ExpiredPasswordException - If authentication failed because of an expired password.

ObjectNotFoundException - If an object that matches the given identity could not be found.

java.lang.UnsupportedOperationException - If the AUTHENTICATE feature is not supported.

See Also:

Connector.authenticate(String, Map)

discoverSchema

public Schema discoverSchema()
                      throws ConnectorException,
                             java.lang.UnsupportedOperationException

Description copied from interface: Connector

Discover the Schema for the currently configured object type.

Specified by:

discoverSchema in interface Connector

Throws:

ConnectorException - If the operation fails.

java.lang.UnsupportedOperationException - If the DISCOVER_SCHEMA feature is not supported.

throwUnsupported

protected void throwUnsupported(java.lang.String method)

getIdentityAttribute

protected java.lang.String getIdentityAttribute()

Convenience method to return the identityAttribute from the Schema for the currently configured object type.

getNativeIdentifier

protected java.lang.String getNativeIdentifier(java.util.Map<java.lang.String,java.lang.Object> obj)
                                        throws java.lang.IllegalArgumentException

Parameters:

obj - The object from which to retrieve the nativeIdentifier.

Returns:

the value for the identityAttribute from the given object.

Throws:

java.lang.IllegalArgumentException - If the given object does not have a value for the configured identity attribute.

getString

protected java.lang.String getString(java.lang.String attrName)

Parameters:

attrName - The name of the configuration attribute.

Returns:

the value for the requested configuration attribute.

getRequiredString

protected java.lang.String getRequiredString(java.lang.String attrName)

Parameters:

attrName - The name of the configuration attribute.

Returns:

the value for the requested configuration attribute, or throw an exception if it is not configured.

Throws:

ConnectorException

getInt

protected int getInt(java.lang.String attrName,
                     int defaultValue)

Parameters:

attrName - The name of the configuration attribute.

defaultValue - The value to return if not configured.

Returns:

the integer value for the requested configuration attribute, or the default value if not configured.

Throws:

ConnectorException - If the configured value is not an integer.

getBoolean

protected boolean getBoolean(java.lang.String attrName)

Parameters:

attrName - The name of the configuration attribute.

Returns:

the boolean value for the requested configuration attribute, or the false if not configured.

getAsList

protected static java.util.List<java.lang.Object> getAsList(java.lang.Object val)

Returns:

the given value as a List. If the value is already a List, it is just returned. If the value is null, an empty list is returned. If the value is non-null, a List with the value as the only element will be returned.

getAsStringList

protected static java.util.List<java.lang.String> getAsStringList(java.lang.Object val)

Returns:

the given value as a list of strings.

itemsToMap

protected java.util.Map<java.lang.String,java.lang.Object> itemsToMap(java.util.List<Item> items)

Given a list of Items, convert them into a Map. This is useful in the implementation of the the create() method since the Item operations can all be assumed to be Item.Operation.Set.

Note that this will lose any extended arguments that might be passed with each Item.

Parameters:

items - list of Items to convert

Returns:

map representation of the given list of Items

provision

public void provision(Plan plan)
               throws ConnectorException,
                      java.lang.UnsupportedOperationException

Default implementation of the plan evaluation method that parses the plan and calls down to a simpler set of methods that can be implemented by the subclass.

We will treat each Request in the plan as an independent transaction that will have its own Result.

Specified by:

provision in interface Connector

Parameters:

plan - The plan to evaluate.

Throws:

ConnectorException - If the operation fails.

ObjectAlreadyExistsException - If an object already exists on the resource.

java.lang.UnsupportedOperationException - If the an operation in the plan is not supported.

setRetryStatus

public void setRetryStatus(Result result)

Helper for setting retry status - Iterate through all the messages from the result and call shoudRetry for each one If it can be retried, check if the retry threshold is configured, set that in the result

shouldRetry

public boolean shouldRetry(java.lang.Exception e,
                           java.lang.String error)

Helper for checking if the provisioning error can be retried - 1. Check the type of the throwable, if its connection request should be retried 2. Process the list of error messages configured in application, if the error string passed contains any of those the request should be retried

Parameters:

e - The exception object to test

error - string of errors to compare

Returns:

true if the provisioning error is retryable

isExceptionRetryable

public boolean isExceptionRetryable(java.lang.Exception e)

Check weather the exception is eligible for retry.

Parameters:

e - The exception object.

doSystemItems

protected Result doSystemItems(Request req,
                               java.util.List<Item> items,
                               java.lang.String id)

Helper for provision, process the list of system items. Result handling is awkward because a Request can only have one Result, but here the Request is being split into several actions each having a potentially different Result.

The typical cases are handled adequately with these rules:

• if there were any non-system items with this request, then the result from the previous create or update call will not change status but might add messages
• if there were no non-system items with this request, then the first system item processed defines the Result status for the request

While it seems funny to not try to merge Results of multiple system items, in practice this doesn't happen.

buildOptions

public java.util.Map<java.lang.String,java.lang.Object> buildOptions(Request request)

Build up the options that will be passed down to each of the operations that have options. (enable, disable, unlock, changePassword.

In any given request there can arguments at the request level and/or item level. These arguments will be flattened into a single Map and given to each method in the options method parameter.

In some cases operation might require additional values sent over in the request in the form of other Items.

If there are additional items present in the Request they will also be merged into the options map by name of the item as the key and the value of the item as the value of the key in the options map.

The arguments from the request, the item, and then finally any additional included items are added.

There should not be any key conflict, but if they do occur the arguments and the item names the item will be skipped and an error will be sent to the log.

Parameters:

request -

Returns:

a Map of the request and item args and and any additional items name and values.

create

public Result create(java.lang.String id,
                     java.util.List<Item> items)
              throws ConnectorException,
                     ObjectAlreadyExistsException,
                     java.lang.UnsupportedOperationException

Create an object of the currently configured type on the resource.

Parameters:

id - The identifier of the object to create.

items - The initial account attributes.

Throws:

ConnectorException - If the operation fails.

ObjectAlreadyExistsException - If this object already exists on the resource.

java.lang.UnsupportedOperationException - If the CREATE feature is not supported. The Items in the list can all be assumed to use the operation Item.Operation.Set though the connector should tolerate Item.Operation.Add. It is easiest if the connector just ignores the operation and assumes it is Set.

update

public Result update(java.lang.String id,
                     java.util.List<Item> items)
              throws ConnectorException,
                     ObjectNotFoundException,
                     java.lang.IllegalArgumentException,
                     java.lang.UnsupportedOperationException

Update the object of the given type using the given item list.

Parameters:

id - The native identity of object to update

items - A list of items to update

Throws:

ConnectorException - If the operation fails.

ObjectNotFoundException - If the object to update cannot be found.

java.lang.UnsupportedOperationException - If the UPDATE feature is not supported or the options map contains operations that are not supported.

java.lang.IllegalArgumentException

delete

public Result delete(java.lang.String id,
                     java.util.Map<java.lang.String,java.lang.Object> options)
              throws ConnectorException,
                     ObjectNotFoundException,
                     java.lang.UnsupportedOperationException

Delete the object of the configured object type that has the given native identifier.

If there are additional Items present as part of the Request they will be merged into the options map by name of the item. The value stored for each name (key) is the value found on the Item.

Parameters:

id - The value for the identity attribute.

options - Options that may influence the deletion.

Throws:

ConnectorException - If the operation fails.

java.lang.UnsupportedOperationException - If the DELETE feature is not supported.

ObjectNotFoundException

enable

public Result enable(java.lang.String id,
                     java.util.Map<java.lang.String,java.lang.Object> options)
              throws ConnectorException,
                     ObjectNotFoundException,
                     java.lang.UnsupportedOperationException

Enable the object of the configured object type that has the given native identifier.

If there are additional Items present as part of the Request they will be merged into the options map by name of the item. The value stored for each name (key) is the value found on the Item.

Parameters:

id - The value for the identity attribute.

options - Options that may influence the enable.

Throws:

ConnectorException - If the operation fails.

ObjectNotFoundException - If the object to enable cannot be found.

java.lang.UnsupportedOperationException - If the ENABLE feature is not supported.

disable

public Result disable(java.lang.String id,
                      java.util.Map<java.lang.String,java.lang.Object> options)
               throws ConnectorException,
                      ObjectNotFoundException,
                      java.lang.UnsupportedOperationException

Disable the object of the configured object type that has the given native identifier.

If there are additional Items present as part of the Request they will be merged into the options map by name of the item. The value stored for each name (key) is the value found on the Item.

Parameters:

id - The value for the identity attribute.

options - Options that may influence the disable.

Throws:

ConnectorException - If the operation fails.

ObjectNotFoundException - If the object to disable cannot be found.

java.lang.UnsupportedOperationException - If the DISABLE feature is not supported.

unlock

public Result unlock(java.lang.String id,
                     java.util.Map<java.lang.String,java.lang.Object> options)
              throws ConnectorException,
                     ObjectNotFoundException,
                     java.lang.UnsupportedOperationException

Unlock the object of the configured object type that has the given native identifier. An account is typically locked due to excessive invalid login attempts, whereas a disable is usually performed on accounts that are no longer in use.

If there are additional Items present as part of the Request they will be merged into the options map by name of the item. The value stored for each name (key) is the value found on the Item.

Parameters:

id - The value for the identity attribute.

options - Options that may influence the unlock.

Throws:

ConnectorException - If the operation fails.

ObjectNotFoundException - If the object to unlock cannot be found.

java.lang.UnsupportedOperationException - If the UNLOCK feature is not supported.

setPassword

public Result setPassword(java.lang.String id,
                          java.lang.String newPassword,
                          java.lang.String currentPassword,
                          java.util.Date expiration,
                          java.util.Map<java.lang.String,java.lang.Object> options)
                   throws ConnectorException,
                          ObjectNotFoundException,
                          java.lang.UnsupportedOperationException

Set the password for the given object to the newPassword. The current password may be passed in, but is not typically required. If available, the current password should be passed in, since some resources require this for full behavior around password policy checking, password history, etc...

If there are additional Items present as part of the Request they will be merged into the options map by name of the item. The value stored for each name (key) is the value found on the Item.

Parameters:

id - The value for the identity attribute.

newPassword - The password to set for the account.

currentPassword - The current password of the account. This should be provided if available, but is not always required.

expiration - The expiration date for the password.

options - An optional map of options that can provide additional information about the password change.

Throws:

ConnectorException - If the operation fails.

ObjectNotFoundException - If the object to set the password on cannot be found.

java.lang.UnsupportedOperationException - If the SET_PASSWORD feature is not supported.

checkStatus

public Result checkStatus(java.lang.String id)
                   throws ConnectorException,
                          java.lang.UnsupportedOperationException

Default implementation of check status that does nothing. This method is used to poll the system for status when things in any of the results are marked Queued and have a requestToken.

See Connector.checkStatus(String) for further details

Specified by:

checkStatus in interface Connector

Parameters:

id - The value that was returned as a resultToken in the result by the provision method.

Returns:

Result

Throws:

java.lang.UnsupportedOperationException - If the check status is not implemented by a subclass.

ConnectorException

getConfigOptions

public java.util.Map<java.lang.String,java.lang.Object> getConfigOptions(java.lang.String configOptionsKey)
                                                                  throws ConnectorException,
                                                                         java.lang.UnsupportedOperationException

Default implementation of getConfigOptions method that does nothing.

See Connector.getConfigOptions(String) for further details

Specified by:

getConfigOptions in interface Connector

Parameters:

configOptionsKey -

Returns:

Return a map for config options

Throws:

java.lang.UnsupportedOperationException - If the check status is not implemented by a subclass.

ConnectorException

ObjectNotFoundException

getIteratorPartitions

public java.util.List<Partition> getIteratorPartitions(int suggestedPartitionCount,
                                                       Filter filter,
                                                       java.util.Map<java.lang.String,java.lang.Object> ops)
                                                throws ConnectorException

Default implementation of the getIteratorPartitions method, which returns null by default. Subclasses that wish to support partitions must override this method.

Specified by:

getIteratorPartitions in interface Connector

Parameters:

suggestedPartitionCount - The caller will calculate the optimal number of partitions and pass it into the connector.

filter - The possibly null filter to help constrain which options are returned.

ops - The possibly null map will provides additional options for future expansion.

Returns:

List of Objects used to configure each partition, returning

Throws:

ConnectorException

See Also:

Partition

iterate

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> iterate(Partition partition)
                                                                             throws ConnectorException,
                                                                                    java.lang.UnsupportedOperationException

Default implementation of the iterate(Partition) method, which throws UnsupportedOperationException by default.

Specified by:

iterate in interface Connector

Parameters:

partition - One of the objects built in getIteratorPartitions that will drive which objects get returned by the iterator.

Returns:

Iterator over the object for a Partition

Throws:

ConnectorException

java.lang.UnsupportedOperationException

See Also:

Partition

registerListener

public void registerListener(ConnectorStateChangeListener listener)

Register listener interested in connector config changes

Specified by:

registerListener in interface Connector

Parameters:

listener - The listener that is interested in listening to connector config changes

notifyListeners

public void notifyListeners()

Notify listener when connector config changes

Specified by:

notifyListeners in interface Connector

supportsPartitionedDeltaAggregation

public boolean supportsPartitionedDeltaAggregation()

Gets if the connector supports partitioned delta aggregation

Specified by:

supportsPartitionedDeltaAggregation in interface Connector

Returns:

true, if connector supports partitioned delta aggregation

destroy

public void destroy(java.util.Map<java.lang.String,java.lang.Object> optionsMap)
             throws ConnectorException

Called by aggregator at the end of aggregation

Specified by:

destroy in interface Connector

Parameters:

optionsMap - Map of options sent by connector

Throws:

ConnectorException

setStatisticsCollector

public void setStatisticsCollector(StatisticsCollector statisticsCollector)

Set the StatisticsCollector object require for underlying connector to push the aggreagtion statistics. The Object resposible for pushing the aggreagtion statistical data. This is cross cutting concern of recording the statistics which will help in analysis of aggregation performance.

Specified by:

setStatisticsCollector in interface Connector

getUtilizationExtract

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getUtilizationExtract(java.util.Map<java.lang.String,java.lang.Object> requestParams)
                                                                                           throws ConnectorException,
                                                                                                  java.lang.UnsupportedOperationException

Default implementation of the getUtilizationExtract method, which throws a UnsupportedOperationException exception.

Specified by:

getUtilizationExtract in interface Connector

Parameters:

requestParams - params which will contain information to fetch data from ERP systems.

Returns:

Iterator> iterator which holds data

Throws:

sailpoint.connector.ConnectorException - instance of ConnectorException in case of failure

java.lang.UnsupportedOperationException - instance of UnsupportedOperationException in case method is not implemented by connectors.

ConnectorException - instance of ConnectorException in case of failure

getSecurityExtract

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getSecurityExtract(java.util.Map<java.lang.String,java.lang.Object> requestParams)
                                                                                        throws ConnectorException,
                                                                                               java.lang.UnsupportedOperationException

Default implementation of the getSecurityExtract method, which throws a UnsupportedOperationException exception.

Specified by:

getSecurityExtract in interface Connector

Parameters:

requestParams - params which will contain information to fetch data from ERP systems.

Returns:

Iterator> iterator which holds data

Throws:

sailpoint.connector.ConnectorException - instance of ConnectorException in case of failure

java.lang.UnsupportedOperationException - instance of UnsupportedOperationException in case method is not implemented by connectors.

ConnectorException

getChangeLogExtract

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getChangeLogExtract(java.util.Map<java.lang.String,java.lang.Object> requestParams)
                                                                                         throws ConnectorException,
                                                                                                java.lang.UnsupportedOperationException

Default implementation of the getChangeLogExtract method, which throws a UnsupportedOperationException exception.

Specified by:

getChangeLogExtract in interface Connector

Parameters:

requestParams - params which will contain information to fetch data from ERP systems.

Returns:

Iterator> iterator which holds data

Throws:

sailpoint.connector.ConnectorException - instance of ConnectorException in case of failure

java.lang.UnsupportedOperationException - instance of UnsupportedOperationException in case method is not implemented by connectors.

ConnectorException

getExtractPartitions

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getExtractPartitions(java.util.Map<java.lang.String,java.lang.Object> requestParams,
                                                                                             java.lang.String extractType)
                                                                                      throws ConnectorException,
                                                                                             java.lang.UnsupportedOperationException,
                                                                                             InsufficientPermissionException

This method will be called to get extract Partition for ARM extract requests

Specified by:

getExtractPartitions in interface Connector

Parameters:

requestParams - has required details to fetch extract Partition data

extractType - this contains extract type

Returns:

List

Throws:

ConnectorException - instance of ConnectorException in case of failure

java.lang.UnsupportedOperationException - instance of UnsupportedOperationException in case method is not implemented by connectors.

InsufficientPermissionException - instance of ConnectorException in case of insufficient permissions