Package com.ca.jcs

Contains all classes making up the implementation of CA Java Connector Server ("Java CS" or "JCS"), which supports connectors which take LDAP traffic in at the top level and convert it into the native language of the managed system with which they communicate.

See:
Description

Interface Summary

Activatable	Basic life-cycle methods used, for example, by processors and connectors.
AttributesProxy	Implemented by classes allowing attribute values to be looked up for requested attribute ids.
ConnectionManager	Simple interface implemented by connectors to provide active connections to their endpoint systems, which is generally expected to be a facade on top of a configurable underlying connection pool.
Connector	Root interface for connectors.
ConnectorFactory	Factory responsible for creating ConnectorTypes and Connectors based on DNs and attributes passed in at the ConnectorType (aka Endpoint Type) and Connector levels of the DIT.
ConnectorManager	Manager for ConnectorTypes (aka Endpoint Types) and Connectors which handles their entire life-cycle and processing needs.
ConnectorPersisterObserver	Interface for an observer of connector persistence changes.
PartitionOps	Subset of methods in Partition which need to be implemented JCS ConnectorTypes and Connectors.
PasswordChangeObserver	Interface for an observer of JCS admin password changes.
TransactionManager	Allows a connector to expose a transaction service to any interested parties, in the same way that ConnectionManager exposes a connection service.

Class Summary

AddOpContext	Context information made available to power-usage plug-ins (validators / converters) triggered by LDAP ADD requests.
AppendingNamingEnumeration	Deprecated. Moved to com.ca.jcs.enumeration.AppendingNamingEnumeration
BaseConnector	Represents an LDAP view onto an external remote managed endpoint system, whilst acting as an ApacheDS partition to which LDAP operations can be routed.
ConnectorPersister	Abstract class containing common functionality for persisting ConnectorTypes and Connectors configuration to persistent storage, so that the configuration can be loaded after JCS restart.
ConnectorPersister.State	Class representing the State of a ConnectorPersister.StateType.
ConnectorType	A ConnectorType (aka Endpoint Type) configured by metadata, which acts as parent in the DIT for its contained Connector instances.
DefaultConnectorManager	Default manager that persists metadata to the local file system, caches dependencies between ConnectorTypes and Connectors in memory and handles lazy activation of the ApachedDS partitions associated with each connector.
DNDetails	Holder struct so that DN are characterised efficiently.
ImplBundle	Information for each connector implementation bundle, telling the JCS framework everything it needs to know to create a new active connector instance.
InverseReplaceOIDsProxyHandler	ApacheDS JdbmPartition requires DNs in non-human friendly OID (Object IDentifier) based representation, so this proxy takes care of converting them to/from their human friendly equivalents (in DNs and filters).
JCSInfo	Helper class that prints out JCS system version number and contains some subsystem wide constants.
LdapUtil	Deprecated. Moved to com.ca.jcs.util.LdapUtil
ObjectClassMapping	Provides all the information required by type-driven connectors to efficiently access the required to/from LDAP attribute mappings, for a particular LDAP object class facing the client (the mapped-to side can be any type-driven connector technology, eg JDBC).
ObjectClassMapping.AmbiguousClassInfo	Information stored for each class with ambiguous connector mappings.
ObjectClassMapping.AmbiguousPropInfo	Information stored for each property with ambiguous connector mappings.
ObjectClassMapping.AssocIsIndirectPred	Predicate for testing if an association is indirect
ObjectClassMapping.IsStructuralObjectClassPred	Predicate for testing if a given object class doesn't correspond to a structural class
ObjectClassMapping.StringEqFn	Predicate suitable for string equality operations
ObjectInfo	This class contains all the information important to the JCS framework for a target object, derived from its Distinguished Name (DN).
PartitionLoaderService	A service that handles automatically lazy-loading/registering partitions based on sniffing DNs and delegating where necessary to the configured ConnectorManager.
PluginCoreContext	Common context information which can be made available to power validator / converter plug-ins.
ReplaceOIDsProxyHandler	ApacheDS converts DNs to non-human friendly OID (Object IDentifier) based representation, so this proxy takes care of converting them to their human friendly equivalents (in DNs and filters) for easier use in developing connectors and debugging.
VirtualContainer	Implements a "virtual container" which doesn't actually exist on the flat (non-hierarchical) remote system being managed by a connector, but is implemented by the framework as a way of categorizing objects of the same object class under a common logical container.
VirtualContainerConfig	Represents a logical container which may hold instances of one or more classes.

Enum Summary

ConnectorPersister.StateType	An enum represeting the different types of state stored.
ObjectClassMapping.SpecialRole

Exception Summary

LdapCommunicationException	Assigns resultCode to ResultCodeEnum.UNWILLING_TO_PERFORM by default.
LdapOperationNotSupportedException	Assigns resultCode to ResultCodeEnum.UNWILLING_TO_PERFORM by default.
LdapPartialResultException	Assigns resultCode to ResultCodeEnum.UNWILLING_TO_PERFORM by default.
PluginNotRequiredException	Deprecated. Extend Vetoable interface and use return value from Vetoable.isVetoed() instead.

Package com.ca.jcs Description

Contains all classes making up the implementation of CA Java Connector Server ("Java CS" or "JCS"), which supports connectors which take LDAP traffic in at the top level and convert it into the native language of the managed system with which they communicate.

$Id: package.html 47098 2010-01-22 01:36:37Z khaam03 $