| Package | Description |
|---|---|
| org.identityconnectors.framework.api.operations | |
| org.identityconnectors.framework.common.exceptions | |
| org.identityconnectors.framework.common.objects | |
| org.identityconnectors.framework.spi |
This is the "Service Provider Interface" package.
|
| org.identityconnectors.framework.spi.operations |
| Modifier and Type | Method and Description |
|---|---|
Uid |
UpdateApiOp.addAttributeValues(ObjectClass objclass,
Uid uid,
Set<Attribute> valuesToAdd,
OperationOptions options)
Update the object specified by the
ObjectClass and Uid,
adding to the current values of each attribute the values provided. |
Uid |
AuthenticationApiOp.authenticate(ObjectClass objectClass,
String username,
GuardedString password,
OperationOptions options)
Most basic authentication available.
|
Uid |
CreateApiOp.create(ObjectClass objectClass,
Set<Attribute> createAttributes,
OperationOptions options)
Create a target object based on the specified attributes.
|
void |
DeleteApiOp.delete(ObjectClass objectClass,
Uid uid,
OperationOptions options)
Delete the object that the specified Uid identifies (if any).
|
SyncToken |
SyncApiOp.getLatestSyncToken(ObjectClass objectClass)
Returns the token corresponding to the most recent synchronization event
for any instance of the specified object class.
|
ConnectorObject |
GetApiOp.getObject(ObjectClass objectClass,
Uid uid,
OperationOptions options)
Get a particular
ConnectorObject based on the Uid. |
Uid |
UpdateApiOp.removeAttributeValues(ObjectClass objclass,
Uid uid,
Set<Attribute> valuesToRemove,
OperationOptions options)
Update the object specified by the
ObjectClass and Uid,
removing from the current values of each attribute the values provided. |
Uid |
ResolveUsernameApiOp.resolveUsername(ObjectClass objectClass,
String username,
OperationOptions options)
Resolve the given
authentication username to
the corresponding Uid. |
SearchResult |
SearchApiOp.search(ObjectClass objectClass,
Filter filter,
ResultsHandler handler,
OperationOptions options)
Search the resource for all objects that match the object class and
filter.
|
SyncToken |
SyncApiOp.sync(ObjectClass objectClass,
SyncToken token,
SyncResultsHandler handler,
OperationOptions options)
Request synchronization events--i.e., native changes to target objects.
|
Uid |
UpdateApiOp.update(ObjectClass objectClass,
Uid uid,
Set<Attribute> replaceAttributes,
OperationOptions options)
Update the object specified by the
ObjectClass and Uid,
replacing the current values of each attribute with the values provided. |
Set<AttributeDelta> |
UpdateDeltaApiOp.updateDelta(ObjectClass objclass,
Uid uid,
Set<AttributeDelta> modifications,
OperationOptions options) |
| Constructor and Description |
|---|
UnknownUidException(Uid uid,
ObjectClass objclass) |
| Modifier and Type | Field and Description |
|---|---|
static ObjectClass |
ObjectClass.ACCOUNT
Represents a human being in the context of a specific system or
application.
|
static ObjectClass |
ObjectClass.ALL
Represents all collections that contains any object.
|
static ObjectClass |
ObjectClass.GROUP
Represents a collection that contains an object (such as an account).
|
| Modifier and Type | Method and Description |
|---|---|
ObjectClass |
SyncDeltaBuilder.getObjectClass()
Gets the ObjectClass of the object that deleted.
|
ObjectClass |
QualifiedUid.getObjectClass()
Returns the object class.
|
ObjectClass |
ConnectorObject.getObjectClass()
Gets the
ObjectClass for this object. |
ObjectClass |
SyncDelta.getObjectClass()
If the change described by this
SyncDelta.DELETE and the
deleted object value is null, this method returns the
ObjectClass of the deleted object. |
| Modifier and Type | Method and Description |
|---|---|
static boolean |
ObjectClassUtil.isSpecial(ObjectClass objectClass)
Determines whether the specified object class is a special object class.
|
ConnectorObjectBuilder |
ConnectorObjectBuilder.setObjectClass(ObjectClass oclass) |
SyncDeltaBuilder |
SyncDeltaBuilder.setObjectClass(ObjectClass objectClass)
Sets the ObjectClass of the object that deleted.
|
| Constructor and Description |
|---|
ConnectorObject(ObjectClass objectClass,
Set<? extends Attribute> attributes)
Public only for serialization; please use
ConnectorObjectBuilder. |
QualifiedUid(ObjectClass objectClass,
Uid uid)
Create a QualifiedUid.
|
| Modifier and Type | Method and Description |
|---|---|
Attribute |
AttributeNormalizer.normalizeAttribute(ObjectClass objectClass,
Attribute attribute) |
| Modifier and Type | Method and Description |
|---|---|
Uid |
UpdateAttributeValuesOp.addAttributeValues(ObjectClass objclass,
Uid uid,
Set<Attribute> valuesToAdd,
OperationOptions options)
Update the object specified by the
ObjectClass and Uid,
adding to the current values of each attribute the values provided. |
Uid |
AuthenticateOp.authenticate(ObjectClass objectClass,
String username,
GuardedString password,
OperationOptions options)
Simple authentication with two parameters presumed to be user name and
password.
|
Uid |
CreateOp.create(ObjectClass objectClass,
Set<Attribute> createAttributes,
OperationOptions options)
The
Connector developer is responsible for taking the attributes
given (which always includes the ObjectClass) and create an
object and its Uid. |
FilterTranslator<T> |
SearchOp.createFilterTranslator(ObjectClass objectClass,
OperationOptions options)
Creates a filter translator that will translate a specified
Filter into one or more native queries. |
void |
DeleteOp.delete(ObjectClass objectClass,
Uid uid,
OperationOptions options)
The
Connector developer is responsible for calling the native
delete methods to remove the object specified by its unique id. |
void |
SearchOp.executeQuery(ObjectClass objectClass,
T query,
ResultsHandler handler,
OperationOptions options)
ConnectorFacade calls this method once for each native query that the
SearchOp.createFilterTranslator(ObjectClass, OperationOptions) produces in response to the
Filter passed into SearchApiOp.search(org.identityconnectors.framework.common.objects.ObjectClass, org.identityconnectors.framework.common.objects.filter.Filter, org.identityconnectors.framework.common.objects.ResultsHandler, org.identityconnectors.framework.common.objects.OperationOptions). |
SyncToken |
SyncOp.getLatestSyncToken(ObjectClass objectClass)
Returns the token corresponding to the most recent synchronization event.
|
Uid |
UpdateAttributeValuesOp.removeAttributeValues(ObjectClass objclass,
Uid uid,
Set<Attribute> valuesToRemove,
OperationOptions options)
Update the object specified by the
ObjectClass and Uid,
removing from the current values of each attribute the values provided. |
Uid |
ResolveUsernameOp.resolveUsername(ObjectClass objectClass,
String username,
OperationOptions options)
Resolve an object to its
Uid based on its username. |
void |
SyncOp.sync(ObjectClass objectClass,
SyncToken token,
SyncResultsHandler handler,
OperationOptions options)
Request synchronization events--i.e., native changes to target objects.
|
Uid |
UpdateOp.update(ObjectClass objectClass,
Uid uid,
Set<Attribute> replaceAttributes,
OperationOptions options)
Update the object specified by the
ObjectClass and Uid,
replacing the current values of each attribute with the values provided. |
Set<AttributeDelta> |
UpdateDeltaOp.updateDelta(ObjectClass objclass,
Uid uid,
Set<AttributeDelta> modifications,
OperationOptions options)
Update the object specified by the
ObjectClass and Uid,
modifying the values according to the attribute deltas. |
Copyright © 2018. All rights reserved.