public interface Connector
Modifier and Type | Method and Description |
---|---|
Uid |
authenticate(String username,
String password,
OperationOptions options)
Authenticate user on a connector instance.
|
Uid |
create(ObjectClass objectClass,
Set<Attribute> attrs,
OperationOptions options,
AtomicReference<Boolean> propagationAttempted)
Create user / group on a connector instance.
|
void |
delete(ObjectClass objectClass,
Uid uid,
OperationOptions options,
AtomicReference<Boolean> propagationAttempted)
Delete user / group on a connector instance.
|
void |
dispose()
Dispose of any resources associated with connector instance.
|
default void |
filteredReconciliation(ObjectClass objectClass,
ReconFilterBuilder filterBuilder,
SyncResultsHandler handler,
OperationOptions options)
Fetches remote objects (for use during filtered reconciliation).
|
default void |
fullReconciliation(ObjectClass objectClass,
SyncResultsHandler handler,
OperationOptions options)
Fetches all remote objects (for use during full reconciliation).
|
ConnInstance |
getConnInstance()
Getter for active connector instance.
|
SyncToken |
getLatestSyncToken(ObjectClass objectClass)
Read latest sync token from a connector instance.
|
ConnectorObject |
getObject(ObjectClass objectClass,
Attribute connObjectKey,
boolean ignoreCaseMatch,
OperationOptions options)
Get remote object.
|
Set<ObjectClassInfo> |
getObjectClassInfo()
Builds metadata description of ConnId
ObjectClass . |
default SearchResult |
search(ObjectClass objectClass,
Filter filter,
SearchResultsHandler handler,
int pageSize,
String pagedResultsCookie,
List<OrderByClause> orderBy,
OperationOptions options)
Search for remote objects.
|
SearchResult |
search(ObjectClass objectClass,
Filter filter,
SearchResultsHandler handler,
OperationOptions options)
Search for remote objects.
|
void |
sync(ObjectClass objectClass,
SyncToken token,
SyncResultsHandler handler,
OperationOptions options)
Sync remote objects from a connector instance.
|
void |
test()
Check connection.
|
Uid |
update(ObjectClass objectClass,
Uid uid,
Set<Attribute> attrs,
OperationOptions options,
AtomicReference<Boolean> propagationAttempted)
Update user / group on a connector instance.
|
void |
validate()
Validate connector instance.
|
Uid authenticate(String username, String password, OperationOptions options)
username
- the name based credential for authenticationpassword
- the password based credential for authenticationoptions
- ConnId's OperationOptionsUid create(ObjectClass objectClass, Set<Attribute> attrs, OperationOptions options, AtomicReference<Boolean> propagationAttempted)
objectClass
- ConnId's object classattrs
- attributes for creationoptions
- ConnId's OperationOptionspropagationAttempted
- if creation is actually performed (based on connector instance's capabilities)Uid update(ObjectClass objectClass, Uid uid, Set<Attribute> attrs, OperationOptions options, AtomicReference<Boolean> propagationAttempted)
objectClass
- ConnId's object classuid
- user to be updatedattrs
- attributes for updateoptions
- ConnId's OperationOptionspropagationAttempted
- if creation is actually performed (based on connector instance's capabilities)void delete(ObjectClass objectClass, Uid uid, OperationOptions options, AtomicReference<Boolean> propagationAttempted)
objectClass
- ConnId's object classuid
- user to be deletedoptions
- ConnId's OperationOptionspropagationAttempted
- if deletion is actually performed (based on connector instance's capabilities)default void fullReconciliation(ObjectClass objectClass, SyncResultsHandler handler, OperationOptions options)
objectClass
- ConnId's object class.handler
- to be used to handle deltas.options
- ConnId's OperationOptions.default void filteredReconciliation(ObjectClass objectClass, ReconFilterBuilder filterBuilder, SyncResultsHandler handler, OperationOptions options)
objectClass
- ConnId's object class.filterBuilder
- reconciliation filter builderhandler
- to be used to handle deltas.options
- ConnId's OperationOptions.void sync(ObjectClass objectClass, SyncToken token, SyncResultsHandler handler, OperationOptions options)
objectClass
- ConnId's object classtoken
- to be passed to the underlying connectorhandler
- to be used to handle deltasoptions
- ConnId's OperationOptionsSyncToken getLatestSyncToken(ObjectClass objectClass)
objectClass
- ConnId's object class.ConnectorObject getObject(ObjectClass objectClass, Attribute connObjectKey, boolean ignoreCaseMatch, OperationOptions options)
objectClass
- ConnId's object classconnObjectKey
- ConnId's key attributeignoreCaseMatch
- whether match should be performed regardless of the value caseoptions
- ConnId's OperationOptionsSearchResult search(ObjectClass objectClass, Filter filter, SearchResultsHandler handler, OperationOptions options)
objectClass
- ConnId's object classfilter
- search filterhandler
- class responsible for working with the objects returned from the search; may be null.options
- ConnId's OperationOptionsdefault SearchResult search(ObjectClass objectClass, Filter filter, SearchResultsHandler handler, int pageSize, String pagedResultsCookie, List<OrderByClause> orderBy, OperationOptions options)
objectClass
- ConnId's object classfilter
- search filterhandler
- class responsible for working with the objects returned from the search; may be null.pageSize
- requested page results page sizepagedResultsCookie
- an opaque cookie which is used by the connector to track its position in the set of
query resultsorderBy
- the sort keys which should be used for ordering the ConnectorObject
returned by
search requestoptions
- ConnId's OperationOptionsSet<ObjectClassInfo> getObjectClassInfo()
ObjectClass
.void validate()
void test()
void dispose()
ConnInstance getConnInstance()
Copyright © 2010–2023 The Apache Software Foundation. All rights reserved.