All Classes and Interfaces
Class
Description
Convenient base-class for Configuration objects to extend.
Implements all the methods of the facade.
Common base class shared between local and remote implementations
Base class to make it easier to implement Search.
Sample Class Doc
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.
Base class for API operation runners.
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.
Specifies a modification of a single
Attribute.Utility methods to retrieve values from instances of
AttributeDelta.AttributeInfo is meta data responsible for describing an
Attribute.Enum of modifier flags to use for attributes.
The role of an object in the relationship (provided by specific reference attribute).
Enumeration of pre-defined attribute subtypes.
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.
Simple class for common results handler components that involve
OperationOptions.OP_ATTRIBUTES_TO_GET.
Test that attributes satisfy contract.
Utility methods to retrieve values from instances of
Attribute.Authenticate an object based on their unique identifier and password.
Contract test of
AuthenticationApiOp.Helps implementing
ConnectorObject and ConnectorObjectIdentification.Interface for reading objects from a stream.
Interface for writing objects to a stream.
Utility package for byte manipulation.
A thread that logs errors when its context class loader becomes null.
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.Tests for
Configuration of the Connector Under TestConnectionBrokenException 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.
Subclass of APIOperationRunner for operations that require a connector.
Proxy for APIOperationRunner that takes care of setting up underlying
connector and creating the implementation of APIOperationRunner.
Model for the ConnectorBundleManifest.
This annotation must be present on each connector class.
NOTICE: This package is an early specification of the Events API for 1.2.x.x
version.
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.
Base exception for the Connector framework.
Main interface through which an application invokes Connector operations.
Allows an application to obtain a
connector instance.Class holding various helper methods used by contract test suite
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.
Utility methods regarding connector lifecycle (creation, disposal).
The ConnectorManifestScanner ...
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.Represents an identification of a object (e.g., an Account or a Group) on the target resource.
Reference to a connector object.
Simple structure to pass more variables through the constructor of
APIOperationRunner.Base exception for all security-related exceptions.
Connector server interface.
Generic Contract Tests exception.
Base class of all contract tests.
Contract test of
CreateApiOp operation.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.
The DatabaseConnection wraps the JDBC connection.
DatabaseFilterTranslator abstract class translate filters to database WHERE clause
The resource specific getAttributeName must be provided in real translator
The Database Query builder creates the database query.
The Required order by data subclass
DataProvider is a facility used for getting (reading/generating) data for
Contract test suite.
Delegating timeout proxy that selects the appropriate timeout handler
depending on the method.
Contract test of
DeleteApiOpOperation interface to delete objects from the target resource.
API operation interface for configuration discovery, check and recommendation.
Contract test of
DiscoverConfigurationApiOp.Handles both version of update this include simple replace and the advance update.
Operation interface for configuration discovery, check and recommendation.
For test purposes only
Responsible for encrypting/decrypting bytes.
Builder to simplify implementing the
Object.equals(Object) and
Object.hashCode() methods.For test purposes only
This is a Test helper class for testing expected method calls and return values of interfaces
Externally chained filters e.g. the filter implementing case insensitive searches.
Basic interface to match a
ConnectorObject.Use a pass through filter to use if a null filter is provided.
A visitor of
Filters, in the style of the visitor design pattern.The Filter Where builder is component intended to be used within subclass of *
AbstractFilterTranslator to help create the database WHERE query clause.
Lazily get a property
Get a particular
ConnectorObject based on the Uid.Contract test of
GetApiOp.
Default implementation of
DataProvider.Creates a new ScriptExecutorFactory for executing Groovy scripts.
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.
Sent the first time we connect to a given server.
Sent in response to a
HelloRequest.The update set builder create the database update statement.
Optional interface that can be implemented by connectors that want to know their own name.
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.
Class for translating from a Java class to ConfigurationProperties and from
ConfigurationProperties to a java class.
Provider to integrate with the JDK logger.
Common utility methods regarding JNDI.
Support for lazy evaluation.
Poll for synchronization events--i.e., native changes to target objects.
Represents a change to an object in a resource.
Builder for
LiveSyncDelta.Simple handler to reduce the attributes to only the set of attribute to get.
Poll for synchronization events--i.e., native changes to target objects.
Callback interface that an application implements in order to handle results from
LiveSyncApiOp in a
stream-processing fashion.Implements all the methods of the facade.
Localized asserts is a set of localized asserts utility method that throws localized
exception when assert is not true.
Yet another logging abstraction.
Basic logging levels.
Proxy responsible for logging operations from the API.
Logging 'Service Provider Interface'.
Marker interface for all messages.
General-purpose timeout proxy for providing timeouts on all methods on the
underlying object.
Tests which use many APIOperations to do the test scenario
A single-valued attribute that represents the user-friendly identifier
of an object on a target resource.
No operation logger.
Proxy the filter to filter based on object normalized version.
Proxy the filter to return the negative of the value.
An instance of
ObjectClass specifies a category or type
of ConnectorObject.Definition of an object class.
Simplifies the construction of
ObjectClassInfo instances.Simple base class that will run through all the
ObjectClasss.Utility methods to for
ObjectClass.Interface to abstract away the difference between deserializing
xml and binary
Interface to abstract away the difference between serializing
xml and binary
Exception thrown when the value for a key cannot be resolved.
Statistics bean
Configuration for pooling objects.
An ObjectPoolEntry is a borrowed object from pool.
Interface to be implemented to handle the serialization/
deserialization of an object.
Serializer factory for serializing connector objects.
Interface to be implemented to handle the serialization/deserialization of an object.
AttributeInfo for each operational attribute.Operational attributes have special meaning and cannot be represented by pure
operations.
OperationalContext - base class for operations that do not require a
connector instance.
Arbitrary options to be passed into various operations.
Builder for
OperationOptions.Sent to request an operation.
Sent by the client to request more data.
Sent by the client to request stop sending data
Special marker class to mark the end of a response.
Represents one part of a response.
Special marker class to ask if the client wants more data.
Thrown when an
operation times out.The OSGi ConnectorInfoManager Implementation.
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.
Resolver of properties in UNIX/ant style.
Encapsulates a read-only bag of properties, which can be accessed in a
type-safe manner.
A fully-qualified uid.
Generate random strings based on given pattern
Random generator uses a pattern to generate a random
sequence based on given pattern.
Implements all the methods of the facade
Encapsulates all the connection information used to connect to a remote
instance of the connector framework.
Invocation handler for all of our operations.
RemoteWrappedException wraps every exception which are received from Remote
Connector Server.
tests for
ResolveUsernameApiOp.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.
Determines the objects supported by a
Connector.Get the schema from the
Connector.Contract test of
SchemaApiOp operation.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.Contract test of
ScriptOnConnectorApiOp operation.Operation that runs a script in the environment of the connector.
Runs a script on the target resource that a connector manages.
Contract test of
ScriptOnResourceApiOp operation.Operation that runs a script directly on a target resource.
Contract test of
SearchApiOp.Simple results handler that can reduce attributes to only the set of attribute to get.
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.
A SearchResultsHandler is a completion handler for consuming the results of a
search request.
Bag of utilities for serialization.
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.The SQL parameter / util class
The SQL helper/util class.
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.
List of suggested values, with openness specification.
Builder for instances of
SuggestedValues.Poll for synchronization events--i.e., native changes to target objects.
Contract test of
SyncApiOp.Represents a change to an object in a resource.
Builder for
SyncDelta.The type of change.
Simple handler to reduce the attributes to only the set of attribute to get.
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.Contract test of
TestApiOp.Bag of utility methods useful to connector tests.
Private use only, do not implement!
Provides a method for the API to call the SPI's test method on the connector.
Tests the connector
Configuration.Provides a for managing the thread-local class loader
Proxy that handles setting up the thread-local classloader as well as restoring it for any callback arguments.
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.Contract test of
UpdateApiOp.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)
.Contract test of
UpdateDeltaApiOp.Handles both version of update this include simple replace and the advance update.
Proper implementation of
UpdateOp and UpdateAttributeValuesOp.Handles both version of update this include simple replace and the advance update.
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.The update set builder create the database update statement.
Validates the
configuration.Contract test of
ValidateApiOp operation.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.