All Classes and Interfaces
Class
Description
Convenient base-class for Configuration objects to extend.
Base class to make it easier to implement Search.
AlreadyExistsException is thrown to indicate if
CreateApiOp attempts
to create an object that exists prior to the method execution or
UpdateApiOp attempts
to rename an object to that exists prior to the method execution.Interface to show the configuration properties from both the SPI/API based on
the
Connector makeup.Base interface for all API operations.
Represents a named collection of values within a target object, although the
simplest case is a name-value pair (e.g., email, employeeID).
Simplifies constructing instances of
Attribute.AttributeInfo is meta data responsible for describing an
Attribute.Enum of modifier flags to use for attributes.
Simplifies the process of building 'AttributeInfo' objects.
Utility methods to retrieve values from instances of
AttributeInfo.Interface to be implemented by connectors that need to normalize certain
attributes.
Attributes Accessor convenience methods for accessing attributes.
Utility methods to retrieve values from instances of
Attribute.Authenticate an object based on their unique identifier and password.
Utility package for base64 encoding and decoding.
Execute a series of
APIOperation.Builds a list of BatchTask objects.
Object to return in a batch result list when there is no data as a result of the operation, e.g.
Execute a batched list of operations.
Encapsulate the parameters for an API operation to be executed later.
A visitor for executing batch tasks.
Encapsulates zero or more tokens resulting from submission of a set of batched operations to an external resource
via a connector.
Interface for reading objects from a stream.
Interface for writing objects to a stream.
Utility package for byte manipulation.
Filter for an attribute value that is comparable.
Useful for the AND, OR, XOR, etc..
Encapsulates the configuration of a connector.
The
Configuration interface is traversed through reflection.Thrown to indicate there was some configuration problem with one of the
bundles.
Encapsulates the
Configuration at the SPI layer and
uses reflection to identify the individual properties that are available for
an application to manipulate.Represents at the API level a property of a Connector's
Configuration at
the SPI layer.The
Configuration interface is traversed through reflection.A ConfigurationPropertyChangeListener receives the change of
ConfigurationProperty.
ConnectionBrokenException is thrown when a connection to a target resource
instance fails during an operation.
ConnectionFailedException is thrown when a Connector cannot reach the target
resource instance.
This is the main interface to declare a connector.
This annotation must be present on each connector class.
A ConnectorEventHandler receives notification when a connector bundle is
registered or unregistered.
The ConnectorEventPublisher is used by Connector Info Manager to publish
events to the Framework.
A ConnectorEventSubscriptionOp.
Base exception for the Connector framework.
Main interface through which an application invokes Connector operations.
Allows an application to obtain a
connector instance.The connector meta-data for a given connector.
Maintains a list of
ConnectorInfo instances, each of which
describes a connector that is available.An application's primary entry point into connectors.
Base exception for all Input-Output (I/O-related) exceptions, including
instance connection failure, socket error and so forth.
Uniquely identifies a connector within an installation.
A ConnectorKeyRange identifies a range of ConnectorKeys.
Message catalog for a given connector.
A ConnectorObject represents an object (e.g., an Account or a Group) on the
target resource.
Builder class to create a
ConnectorObject.Base exception for all security-related exceptions.
The
Connector developer is responsible for taking the attributes
given (which always includes the ObjectClass) and create an object
and its Uid.Thread local variable that impacts localization of all messages in the
connector framework.
Operation interface to delete objects from the target resource.
Responsible for encrypting/decrypting bytes.
Builder to simplify implementing the
Object.equals(Object) and
Object.hashCode() methods.Basic interface to match a
ConnectorObject.A FilteredResultsHandlerVisitor can accept the
ConnectorObject.A visitor of
Filters, in the style of the visitor design pattern.Get a particular
ConnectorObject based on the Uid.Secure byte array implementation that solves the problems associated with
keeping confidential data as
byte[].Callback interface for those times that it is necessary to access the
clear text of the guarded bytes.
Secure string implementation that solves the problems associated with keeping
passwords as
java.lang.String.Callback interface for those times that it is necessary to access the
clear text of the secure string.
Create a globally unique identifier.
InvalidAttributeValueException is thrown when an attempt is made to add to an
attribute a value that conflicts with the attribute's schema definition.
InvalidCredentialException signals that user authentication failed.
Thrown when a password credential is invalid.
IO Utilities.
Yet another logging abstraction.
Basic logging levels.
Logging 'Service Provider Interface'.
A single-valued attribute that represents the user-friendly identifier
of an object on a target resource.
Proxy the filter to return the negative of the value.
An instance of
ObjectClass specifies a category or type
of ConnectorObject.Extension of Attribute to distinguish it from a regular attribute.
Simplifies the construction of
ObjectClassInfo instances.Utility methods to for
ObjectClass.Configuration for pooling objects.
Serializer factory for serializing connector objects.
Provides a mechanism for receiving push-based notifications.
AttributeInfo for each operational attribute.Operational attributes have special meaning and cannot be represented by pure
operations.
Arbitrary options to be passed into various operations.
Builder for
OperationOptions.Thrown when an
operation times out.An arbitrary pair of objects.
PasswordExpiredException signals that a user password has expired.
Thrown when the target resource will not allow a
Connector to perform
a particular operation.To be implemented by connectors that wish to be pooled.
PreconditionFailedException is thrown to indicate that a resource's current
version does not match the version provided.
PreconditionRequiredException is thrown to indicate that a resource requires
a version, but no version was supplied in the request.
Defines standard syntax and semantics for common attributes that are not
operational in nature.
A PresenceFilter determines if the attribute provided is present in the
ConnectorObjectA fully-qualified uid.
RemoteConnectorServerUnavailableException is thrown when a remote connector server is not available.
Encapsulates all the connection information used to connect to a remote
instance of the connector framework.
Resolve an object to its
Uid based on its username.Callback interface for operations that are returning one or more results.
SPI search operation has a default
ResultsHandler-chain
as:
NormalizingResultsHandler
FilteredResultsHandler
AttributesToGetSearchResultsHandler
This configuration allow to overconfigure the chain.RetryableException indicates that a failure may be temporary, and that
retrying the same request may be able to succeed in the future.
SanitizedLogger implements LogSpi.Determines the objects supported by a
Connector.Get the schema from the
Connector.Simple builder class to help facilitate creating a
Schema object.Implement this interface to allow the Connector to describe which types of
objects the Connector manages on the target resource (and which operations
and which options the Connector supports for each type of object).
Represents a script in a scripting language.
Builder for
Script.Encapsulates a script and all of its parameters.
Builds an
ScriptContext.Represents a (possibly compiled) script.
Abstraction for finding script executors to allow us to invoke scripts from
java.
Runs a script in the same JVM or .Net Runtime as the
Connector.Operation that runs a script in the environment of the connector.
Runs a script on the target resource that a connector manages.
Operation that runs a script directly on a target resource.
Implement this interface to allow the Connector to search for resource
objects.
The final result of a query request returned after all connector objects
matching the request have been returned.
An enum of count policy types.
A SearchResultsHandler is a completion handler for consuming the results of a
search request.
Bag of utilities for serialization.
Encapsulates a Session identifier.
Get a single value out of the attribute to test w/.
A sort key which can be used to specify the order in which connector objects
should be included in the results of a search request.
Tagging interface for the
Connector SPI.A Stateful Configuration interface extends the default
Configuration
and makes the framework keep the same instance.Filter based on strings.
Simple extension of PrintWriter so you don't have to create a StringWriter to
pass to it, when you want the functionality of PrintWriter but you want it in
a buffer.
String Utilities.
A SubscriptionHandler represents a subscription to an asynchronous event
channel.
Poll for synchronization events--i.e., native changes to target objects.
Represents a change to an object in a resource.
Builder for
SyncDelta.The type of change.
ASyncEventSubscriptionOp.
Poll for synchronization events--i.e., native changes to target objects.
Callback interface that an application implements in order to handle results
from
SyncApiOp in a stream-processing fashion.Abstract "place-holder" for synchronization.
A SyncTokenResultsHandler is a Callback interface that an application
implements in order to handle results from
SyncApiOp in a
stream-processing fashion.Tests the
configuration with the connector.Tests the connector
Configuration.A single-valued attribute that represents the unique identifier of an
object within the name-space of the target resource.
Thrown when a
Uid that is specified as input to a connector operation
identifies no object on the target resource.Updates a
ConnectorObject.More advanced implementation of
UpdateOp to be implemented by
connectors that wish to offer better performance and atomicity semantics for
the methods
UpdateApiOp.addAttributeValues(ObjectClass, Uid, Set, OperationOptions)
and
UpdateApiOp.removeAttributeValues(ObjectClass, Uid, Set, OperationOptions)
.The developer of a Connector should implement either this interface or the
UpdateAttributeValuesOp interface if the Connector will allow an
authorized caller to update (i.e., modify or replace) objects on the target
resource.Validates the
configuration.Encapsulates a version number.
A version range is an interval describing a set of
versions.Callback interface to receive xml objects from a stream of objects.
Interface for writing objects to a stream.