Package org.openiam.srvc.idm

Interface ConnectorService

public interface ConnectorService

Provides a consolidated interface that is to be used by all connectors..

Author:

suneet

Method Summary

Modifier and Type	Method	Description
ObjectResponse	add(CrudRequest<? extends ExtensibleObject> reqType)	The add operation enables a requestor to create a new object on a target Attributes used by the operation are: PSOId: Unique identifier for the new object containerId: Object where this new object should be created in.
ObjectResponse	delete(CrudRequest<? extends ExtensibleObject> reqType)
ResponseType	expirePassword(PasswordRequest request)	The expirePassword operation marks as invalid the current password for an object
SearchResponse	lookup(LookupRequest<? extends ExtensibleObject> request)
LookupAttributeResponse	lookupAttributeNames(LookupRequest<? extends ExtensibleObject> reqType)
ObjectResponse	modify(CrudRequest<? extends ExtensibleObject> reqType)
ResponseType	reconcileResource(ReconciliationConfig config)
ResponseType	resetPassword(PasswordRequest request)	The resetPassword operation enables a requestor to change (to an unspecified value) the password for an object and to obtain that newly generated password value.
ResponseType	resume(SuspendResumeRequest request)	Restores a user that was previously disabled.
SearchResponse	search(SearchRequest<? extends ExtensibleObject> searchRequest)
ResponseType	setPassword(PasswordRequest request)	Deprecated. Please use "resetPassword" mthod instead The setPassword operation enables a requestor to specify a new password for an object
ResponseType	suspend(SuspendResumeRequest request)	Suspend / disables a user
ResponseType	testConnection(RequestType<? extends ExtensibleObject> reqType)
ResponseType	validatePassword(PasswordRequest request)	The validatePassword operation enables a requestor to determine whether a specified value would be valid as the password for a specified object.

Method Detail

reconcileResource

ResponseType reconcileResource(ReconciliationConfig config)

add

ObjectResponse add(CrudRequest<? extends ExtensibleObject> reqType)

The add operation enables a requestor to create a new object on a target Attributes used by the operation are:

PSOId: Unique identifier for the new object containerId: Object where this new object should be created in. In a directory, it can be a base DN such as: ou=eng, dc=openiam, dc=org data: Collection of data attributes that are to be stored in the target system targetId: An id that is unique for the provider and is the system where this new object is to be created. returnData:

Parameters:

reqType -

Returns:

modify

ObjectResponse modify(CrudRequest<? extends ExtensibleObject> reqType)

testConnection

ResponseType testConnection(RequestType<? extends ExtensibleObject> reqType)

delete

ObjectResponse delete(CrudRequest<? extends ExtensibleObject> reqType)

lookup

SearchResponse lookup(LookupRequest<? extends ExtensibleObject> request)

lookupAttributeNames

LookupAttributeResponse lookupAttributeNames(LookupRequest<? extends ExtensibleObject> reqType)

search

SearchResponse search(SearchRequest<? extends ExtensibleObject> searchRequest)

setPassword

@Deprecated
ResponseType setPassword(PasswordRequest request)

Deprecated.

Please use "resetPassword" mthod instead The setPassword operation enables a requestor to specify a new password for an object

Parameters:

request -

Returns:

expirePassword

ResponseType expirePassword(PasswordRequest request)

The expirePassword operation marks as invalid the current password for an object

Parameters:

request -

Returns:

resetPassword

ResponseType resetPassword(PasswordRequest request)

The resetPassword operation enables a requestor to change (to an unspecified value) the password for an object and to obtain that newly generated password value.

Parameters:

request -

Returns:

validatePassword

ResponseType validatePassword(PasswordRequest request)

The validatePassword operation enables a requestor to determine whether a specified value would be valid as the password for a specified object.

Parameters:

request -

Returns:

suspend

ResponseType suspend(SuspendResumeRequest request)

Suspend / disables a user

Parameters:

request -

Returns:

resume

ResponseType resume(SuspendResumeRequest request)

Restores a user that was previously disabled.

Parameters:

request -

Returns: