All Classes and Interfaces
Class
Description
Convenient base-class for Configuration objects to extend.
Base class to make it easier to implement Search.
Thrown if
CreateApiOp attempts to create an object 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.
Log in to a target system or application (using a specified username and password).
Utility package for base64 encoding and decoding.
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.
Thrown to indicate there was some configuration problem with one of the
bundles.
ConfigurationFilter offers easy way to filter the
ConfigurationProperty by the following;
object class names(see ObjectClass)
operations (see APIOperation)
attribute names
Builder for
ConfigurationFilter objects.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.Thrown when a connection to a target resource instance
fails during an operation.
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.
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.
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.
Add a new ConnectorObject to the target system or application.
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.
Remove a ConnectorObject (specified by Uid) from the target system or application.
Operation interface to delete objects from the target resource.
An
EmbeddedObject represents an object (e.g., an Account's Address) on the
target resource that is embedded in another object.Builder class to create a
EmbeddedObject.Applies a filter to each of the
EmbeddedObjects that constitute
the values of an attribute.Responsible for encrypting/decrypting bytes.
Builder to simplify implementing the
Object.equals(Object) and
Object.hashCode() methods.Basic interface to match a
ConnectorObject or an EmbeddedObject.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.
Thrown when at least one credential (e.g., password, username or certificate)
passed into an operation is invalid.
Thrown when a password credential is invalid.
IO Utilities
An immutable reference to a
Locale instance.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.
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.
Thrown when a password credential is invalid.
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.
Defines standard syntax and semantics for common attributes
that are not operational in nature.
Encapsulates a read-only bag of properties, which can be accessed
in a type-safe manner.
A fully-qualified uid.
Encapsulates all the connection information used to connect to
a remote instance of the connector framework.
Get the Uid of any ConnectorObject (i.e., account) associated with a specific username.
Resolve an object to its
Uid based on its username.Callback interface for operations that are returning one or
more results.
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.
Retrieve ConnectorObjects that match a speciifed filter (i.e., set of query conditions).
Implement this interface to allow the Connector to search for resource
objects.
Bag of utilities for serialization
Get a single value out of the attribute to test w/.
Tagging interface for the
Connector SPI.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.
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.
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.
Tests the
configuration with the connector.Bag of utility methods useful to connector tests.
Private use only, do not implement! Use the methods in
TestHelpers instead.Tests the connector
Configuration.A
ResultsHandler which stores all connector objects into
a list retrievable with ToListResultsHandler.getObjects().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.
Callback interface to receive xml objects from a stream of objects.
Interface for writing objects to a stream.