Uses of Class
org.identityconnectors.framework.common.objects.ObjectClass
Package
Description
This is the "Service Provider Interface" package.
-
Uses of ObjectClass in org.identityconnectors.framework.api.operations
Modifier and TypeMethodDescriptionUpdateApiOp.addAttributeValues
(ObjectClass objclass, Uid uid, Set<Attribute> valuesToAdd, OperationOptions options) Update the object specified by theObjectClass
andUid
, adding to the current values of each attribute the values provided.AuthenticationApiOp.authenticate
(ObjectClass objectClass, String username, GuardedString password, OperationOptions options) Most basic authentication available.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).SyncApiOp.getLatestSyncToken
(ObjectClass objectClass) Returns the token corresponding to the most recent synchronization event for any instance of the specified object class.GetApiOp.getObject
(ObjectClass objectClass, Uid uid, OperationOptions options) Get a particularConnectorObject
based on theUid
.UpdateApiOp.removeAttributeValues
(ObjectClass objclass, Uid uid, Set<Attribute> valuesToRemove, OperationOptions options) Update the object specified by theObjectClass
andUid
, removing from the current values of each attribute the values provided.ResolveUsernameApiOp.resolveUsername
(ObjectClass objectClass, String username, OperationOptions options) Resolve the givenauthentication
username to the correspondingUid
.SearchApiOp.search
(ObjectClass objectClass, Filter filter, ResultsHandler handler, OperationOptions options) Search the resource for all objects that match the object class and filter.ConnectorEventSubscriptionApiOp.subscribe
(ObjectClass objectClass, Filter eventFilter, Observer<ConnectorObject> handler, OperationOptions operationOptions) SyncEventSubscriptionApiOp.subscribe
(ObjectClass objectClass, SyncToken token, Observer<SyncDelta> handler, OperationOptions operationOptions) Create a subscription to a given sync topic.SyncApiOp.sync
(ObjectClass objectClass, SyncToken token, SyncResultsHandler handler, OperationOptions options) Request synchronization events--i.e., native changes to target objects.UpdateApiOp.update
(ObjectClass objectClass, Uid uid, Set<Attribute> replaceAttributes, OperationOptions options) Update the object specified by theObjectClass
andUid
, replacing the current values of each attribute with the values provided. -
Uses of ObjectClass in org.identityconnectors.framework.api.operations.batch
Modifier and TypeMethodDescriptionBatchTask.getObjectClass()
Return the ObjectClass used for this task.CreateBatchTask.getObjectClass()
Return the ObjectClass used for this task.DeleteBatchTask.getObjectClass()
Return the ObjectClass used for this task.UpdateBatchTask.getObjectClass()
Return the ObjectClass used for this task.Modifier and TypeMethodDescriptionvoid
BatchBuilder.addCreateOp
(ObjectClass objectClass, Set<Attribute> createAttributes, OperationOptions options) Add a Create operation to the batch.void
BatchBuilder.addDeleteOp
(ObjectClass objectClass, Uid uid, OperationOptions options) Add a Delete operation to the batch.void
BatchBuilder.addUpdateAddOp
(ObjectClass objectClass, Uid uid, Set<Attribute> attributes, OperationOptions options) Add an Update:Add operation to the batch.void
BatchBuilder.addUpdateRemoveOp
(ObjectClass objectClass, Uid uid, Set<Attribute> attributes, OperationOptions options) Add an Update:Remove operation to the batch.void
BatchBuilder.addUpdateReplaceOp
(ObjectClass objectClass, Uid uid, Set<Attribute> attributes, OperationOptions options) Add an Update:Replace operation to the batch.ModifierConstructorDescriptionCreateBatchTask
(ObjectClass objectClass, Set<Attribute> createAttributes, OperationOptions options) Create a target object based on the specified attributes.DeleteBatchTask
(ObjectClass objectClass, Uid uid, OperationOptions options) Delete the object that the specified Uid identifies (if any).UpdateBatchTask
(ObjectClass objectClass, Uid uid, Set<Attribute> replaceAttributes, OperationOptions options, UpdateType type) SeeUpdateApiOp
. -
Uses of ObjectClass in org.identityconnectors.framework.common.exceptions
-
Uses of ObjectClass in org.identityconnectors.framework.common.objects
Modifier and TypeFieldDescriptionstatic final ObjectClass
ObjectClass.ACCOUNT
Represents a human being in the context of a specific system or application.static final ObjectClass
ObjectClass.ALL
Represents all collections that contains any object.static final ObjectClass
ObjectClass.GROUP
Represents a collection that contains an object (such as an account).Modifier and TypeMethodDescriptionConnectorObject.getObjectClass()
Gets theObjectClass
for this object.QualifiedUid.getObjectClass()
Returns the object class.SyncDelta.getObjectClass()
If the change described by thisSyncDelta.DELETE
and the deleted object value isnull
, this method returns the ObjectClass of the deleted object.SyncDeltaBuilder.getObjectClass()
Gets the ObjectClass of the object that deleted.Modifier and TypeMethodDescriptionstatic boolean
ObjectClassUtil.isSpecial
(ObjectClass objectClass) Determines whether the specified object class is a special object class.ConnectorObjectBuilder.setObjectClass
(ObjectClass oclass) SyncDeltaBuilder.setObjectClass
(ObjectClass objectClass) Sets the ObjectClass of the object that deleted.ModifierConstructorDescriptionConnectorObject
(ObjectClass objectClass, Set<? extends Attribute> set) Public only for serialization; please useConnectorObjectBuilder
.QualifiedUid
(ObjectClass objectClass, Uid uid) Create a QualifiedUid. -
Uses of ObjectClass in org.identityconnectors.framework.spi
Modifier and TypeMethodDescriptionAttributeNormalizer.normalizeAttribute
(ObjectClass objectClass, Attribute attribute) -
Uses of ObjectClass in org.identityconnectors.framework.spi.operations
Modifier and TypeMethodDescriptionUpdateAttributeValuesOp.addAttributeValues
(ObjectClass objclass, Uid uid, Set<Attribute> valuesToAdd, OperationOptions options) Update the object specified by theObjectClass
andUid
, adding to the current values of each attribute the values provided.AuthenticateOp.authenticate
(ObjectClass objectClass, String username, GuardedString password, OperationOptions options) Simple authentication with two parameters presumed to be user name and password.CreateOp.create
(ObjectClass objectClass, Set<Attribute> createAttributes, OperationOptions options) TheConnector
developer is responsible for taking the attributes given (which always includes theObjectClass
) and create an object and itsUid
.SearchOp.createFilterTranslator
(ObjectClass objectClass, OperationOptions options) Creates a filter translator that will translate a specifiedfilter
into one or more native queries.void
DeleteOp.delete
(ObjectClass objectClass, Uid uid, OperationOptions options) TheConnector
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 FilterTranslator produces in response to theFilter
passed intoSearchApiOp
.SyncOp.getLatestSyncToken
(ObjectClass objectClass) Returns the token corresponding to the most recent synchronization event.UpdateAttributeValuesOp.removeAttributeValues
(ObjectClass objclass, Uid uid, Set<Attribute> valuesToRemove, OperationOptions options) Update the object specified by theObjectClass
andUid
, removing from the current values of each attribute the values provided.ResolveUsernameOp.resolveUsername
(ObjectClass objectClass, String username, OperationOptions options) Resolve an object to itsUid
based on its username.ConnectorEventSubscriptionOp.subscribe
(ObjectClass objectClass, Filter eventFilter, Observer<ConnectorObject> observer, OperationOptions operationOptions) SyncEventSubscriptionOp.subscribe
(ObjectClass objectClass, SyncToken token, Observer<SyncDelta> observer, OperationOptions operationOptions) void
SyncOp.sync
(ObjectClass objectClass, SyncToken token, SyncResultsHandler handler, OperationOptions options) Request synchronization events--i.e., native changes to target objects.UpdateOp.update
(ObjectClass objectClass, Uid uid, Set<Attribute> replaceAttributes, OperationOptions options) Update the object specified by theObjectClass
andUid
, replacing the current values of each attribute with the values provided.