com.ca.jcs.sdkws
Class SDKWSMetaConnector

java.lang.Object
  org.apache.directory.server.core.partition.AbstractPartition
      com.ca.jcs.BaseConnector
          com.ca.jcs.meta.MetaConnector
              com.ca.jcs.sdkws.SDKWSMetaConnector

All Implemented Interfaces:

Activatable, CachingConnector, Connector, PartitionOps, OpProcessorStyleFactory, QuoteStringHandler, Partition

public class SDKWSMetaConnector
extends MetaConnector

The connector implementation for creating a Web Services connector.

Author:

erstr01

Nested Class Summary

Nested classes/interfaces inherited from class com.ca.jcs.meta.MetaConnector

MetaConnector.FilterAware, MetaConnector.SearchFinishedException

Field Summary

static String	ATTR_WS_URL The attribute for the web service URL
static String	ATTR_WSS_PASSWORD The attribute for the web service security token password
static String	ATTR_WSS_USERNAME The attribute for the web service security token username

Fields inherited from class com.ca.jcs.meta.MetaConnector

ALIAS_ACCOUNT_OBJECT, ALIAS_GROUP_OBJECT, CONN_BASE_DN_ATTR, CONN_DESCRIPTION_ATTR, CONN_HOST_ATTR, CONN_LOG_SEVERITY_ATTR, CONN_NAME_ATTR, CONN_PASSWORD_ATTR, CONN_PORT_ATTR, CONN_REMOTE_VERSION_ATTR, CONN_SECURE_ATTR, CONN_URL_ATTR, CONN_USERNAME_ATTR, dailyLog, DYNAMIC_ATTR_INFO_ATTR, logConnAttrs, READ_ONLY_VALIDATOR, virtualContainers

Fields inherited from class com.ca.jcs.BaseConnector

acceptedUnknownAttrIds, attributeStyleOpProcessor, CONN_ACTIVATION_TIMEOUT, CONN_DN, CONN_NAME, CONN_NAME_ID, CONN_PASS_THROUGH_SUFFIX, CONN_PASS_THROUGH_SUFFIX_LEN, CONN_ROLLBACK_CONNECTION_ATTRS, CONN_SKIP_PERSISTER_DELETE_ATTR, CONN_SPEC, CONN_SPEC_INTERNAL, CONNECTOR_ATTR_INDEX, connectorBaseDn, EMPTY_DN, LDAP_ATTR_INDEX, LDAP_CONN_DN, ldapExceptionPrefix, log, SEARCH_RESULTS_STREAMING

Fields inherited from interface com.ca.jcs.Connector

STATE_DELETING

Fields inherited from interface org.apache.directory.server.core.partition.Partition

ALIAS_ATTRIBUTE, ALIAS_OBJECT

Constructor Summary

SDKWSMetaConnector(ConnectorType type, String name, Logger log, ConnectorConfig config)
The default constructor for MetaConnector instances.

Method Summary

void	activate() Activate the Connector instance.
AttributeStyleOpProcessor	createAttributeStyleOpProcessor() Return an AttributeStyleOpProcessor to handle the actual LDAP operations.
ConnectionManager	createConnectionManager() Return a ConnectionManager to manage connection sessions.
void	deactivate() Deactivate the Connector instance.
protected SDKWSHelper	getHelper(String connectorClassName) Returns a new helper instance for the given connector class name.
boolean	isAutoDirectAssocRequired() Return true to indicate that auto direct association will be used.
boolean	isBehaviourSearchObjAsLookup() Return true to indicate that lookup method will be called, for the search behaviour of a single object.
boolean	isBehaviourSearchSingleClass() Return true, so that the OpProcessor.doSearch(com.ca.jcs.ObjectInfo, com.ca.jcs.filter.FilterInfo, java.util.Map, javax.naming.directory.SearchControls) method is only called for a single object class at a time.

Methods inherited from class com.ca.jcs.meta.MetaConnector

add, convertAttributes, convertAttributesFromConnector, convertDNFromConnector, convertDNToConnector, convertDNToConnector, convertModificationItems, convertToException, convertToException, delete, getAssocReverseConnectorAttrId, getAttributeStyleOpProcessorChain, getCacheableStatus, getClassMappingFromConnectorAttrs, getClassMappingFromConnectorObjectClass, getClassMappings, getConnectorAttributesProcessor, getConnectorClassMap, getConnectorObjectClass, getConnectorObjectClasses, getDefaultConnectorSearchAttrIds, getDefaultSearchLdapAttrIds, getDNAttrIds, getEhCacheManager, getErrClassId, getFilterAwareness, getFilterInfo, getFilterInfo, getFilterInfo, getFilterInfo, getFilterInfo, getFilterInfo, getFilterInfo, getFilterObjClass, getIncludedDnLdapAttrId, getMetaConnectorConfig, getMetaConnectorType, getModifyMonitorCache, getObjectClassFromAmbiguousConnAttr, getObjectClassFromConnAttr, getObjectInfo, getObjectInfo, getObjectInfo, getObjectInfo, getObjectInfo, getOpProcessor, getOpProcessorForSearch, getPostQueryAttributesProcessor, getRequestedConnAttrIds, getRootObjectInfo, getSearchBaseObjectInfo, getSearchBaseObjectInfo, getVirtualContainers, hasMetaOpBindingsProxy, isAcceptedUnknownAttrId, isAmibguousLdapDn, isFilterSingleClassMatching, isLockedModify, isLockedModify, isRootDN, isRootDN, isSearchAsLookup, isSearchOutsideClassContainer, isValidContainmentSearchResult, lookup, mapAttributeIdsToConnector, mapAttributeIdsToConnector, mapAttributeIdToConnector, mapAttributeIdToLdap, mapAttributesIdsToConnector, mapAttributesIdsToLdap, mapModificationItems, mapObjectClassAttributeIdsToConnector, matchDNToClassMap, modify, modifyRn, move, move, normalizeConnDn, normalizeConnDnAttr, normalizeConnectorDn, normalizeConnectorDnAttrs, notifyMetaData, performLockedOperation, resolveObjectClass, search, search, searchImpl, searchObjectScopeAsLookup, searchOneClass, searchVirtualContainers, setAttributeStyleOpProcessor, setClassMappings, setConnectorAttributesProcessor, setMethodStyleOpProcessor, setScriptStyleOpProcessor, validateAttributes, validateAttributes, validateDNForSearchContainer

Methods inherited from class com.ca.jcs.BaseConnector

addConnectorBaseDN, appQuoted, appQuoted, bind, convertConnectorDNFromNativeName, convertConnectorDNToNativeName, createConnectorDn, createConnectorDn, createMethodStyleOpProcessor, createObjectInfo, createScriptStyleOpProcessor, createTransactionManager, doInit, formatConnectorPassThroughAttrId, formatConnectorPassThroughValue, getAcceptedUnknownAttrIds, getAttributes, getAttributeStyleOpProcessor, getAttributeTypeRegistry, getAutoDirectAssocExlusions, getCacheManager, getConnectionManager, getConnectorBaseDn, getConnectorConfig, getConnectorDnRdn, getConnectorPassThroughValue, getLdapExceptionPrefix, getLdapNamingAttr, getLdapObjectClass, getLogger, getMethodStyleOpProcessor, getName, getPartition, getPassThroughAttrIdToConnector, getScriptStyleOpProcessor, getStateFlags, getStoredSuffix, getTransactionManager, getType, getUpSuffix, isActivated, isBehaviourCachingRequired, isBehaviourStrictConnectorDns, isCachingActive, isCachingPossible, isCachingRequired, isCheckObjectExistenceForDeletion, isConnectorPassThrough, isHiddenLdapBaseDn, isIndirectAssociations, isObjectClassRequired, isSuffix, list, mapAttributeIdsToConnector, modifyAttributes, noQuote, passThroughAttrIdToConnector, postProcessLdapSearchResult, removeConnectorBaseDN, setAcceptedUnknownAttrIds, setActivated, setAttributes, setCacheManager, setCachingRequired, setConnectionManager, setConnectorBaseDn, setConnectorConfig, setLdapNamingAttr, setLdapObjectClass, setLogger, setName, setQuoteString, setStateFlags, setStoredSuffix, setTransactionManager, setType, splitConnectorPassThroughAttrId, toString, unbind, upName

Methods inherited from class org.apache.directory.server.core.partition.AbstractPartition

destroy, doDestroy, getConfiguration, getFactoryConfiguration, getSuffix, hasEntry, init, isInitialized, lookup, modify, sync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ca.jcs.PartitionOps

lookup, modify, sync

Methods inherited from interface org.apache.directory.server.core.partition.Partition

destroy, getSuffix, hasEntry, init, isInitialized, lookup, modify, sync

Field Detail

ATTR_WS_URL

public static final String ATTR_WS_URL

The attribute for the web service URL

See Also:

Constant Field Values

ATTR_WSS_USERNAME

public static final String ATTR_WSS_USERNAME

The attribute for the web service security token username

See Also:

Constant Field Values

ATTR_WSS_PASSWORD

public static final String ATTR_WSS_PASSWORD

The attribute for the web service security token password

See Also:

Constant Field Values

Constructor Detail

SDKWSMetaConnector

public SDKWSMetaConnector(ConnectorType type,
                          String name,
                          Logger log,
                          ConnectorConfig config)

The default constructor for MetaConnector instances.

Parameters:

type - the ConnectorType parent of this Connector.

name - the name of the Connector.

log - the logger.

config - the connector configuration.

Method Detail

activate

public void activate()
              throws NamingException

Activate the Connector instance.

Specified by:

activate in interface Activatable

Specified by:

activate in interface Connector

Overrides:

activate in class MetaConnector

Throws:

NamingException - errors completing the activation.

deactivate

public void deactivate()
                throws NamingException

Deactivate the Connector instance.

Specified by:

deactivate in interface Activatable

Specified by:

deactivate in interface Connector

Overrides:

deactivate in class MetaConnector

Throws:

NamingException - errors completing the deactivation.

createConnectionManager

public ConnectionManager createConnectionManager()
                                          throws NamingException

Return a ConnectionManager to manage connection sessions.

Specified by:

createConnectionManager in interface Connector

Overrides:

createConnectionManager in class BaseConnector

Returns:

a ConnectionManager to manage connection sessions

Throws:

NamingException - no exceptions are currently thrown, matching method override signature.

createAttributeStyleOpProcessor

public AttributeStyleOpProcessor createAttributeStyleOpProcessor()

Return an AttributeStyleOpProcessor to handle the actual LDAP operations.

Returns:

an AttributeStyleOpProcessor to handle the actual LDAP operations.

isBehaviourSearchObjAsLookup

public boolean isBehaviourSearchObjAsLookup()

Return true to indicate that lookup method will be called, for the search behaviour of a single object.

Overrides:

isBehaviourSearchObjAsLookup in class BaseConnector

Returns:

true to indicate that lookup method will be called, for the search behaviour of a single object.

isAutoDirectAssocRequired

public boolean isAutoDirectAssocRequired()

Return true to indicate that auto direct association will be used.
Except for excluded methods. See BaseConnector.getAutoDirectAssocExlusions().

Overrides:

isAutoDirectAssocRequired in class BaseConnector

Returns:

true to indicate that auto direct association will be used.

See Also:

BaseConnector.getAutoDirectAssocExlusions()

isBehaviourSearchSingleClass

public boolean isBehaviourSearchSingleClass()

Return true, so that the OpProcessor.doSearch(com.ca.jcs.ObjectInfo, com.ca.jcs.filter.FilterInfo, java.util.Map, javax.naming.directory.SearchControls) method is only called for a single object class at a time.
Returning true will cause the framework to decompose a subtree search with a filter like <code>(objectclass=*)</code> into a separate <code>doSearch()</code> call for each defined objectclass.

Overrides:

isBehaviourSearchSingleClass in class BaseConnector

Returns:

true, so that the doSearch method is only called for a single object class at a time.

getHelper

protected SDKWSHelper getHelper(String connectorClassName)
                         throws NamingException

Returns a new helper instance for the given connector class name.

Parameters:

connectorClassName - the connector class name to find the appropriate helper for.

Returns:

the helper instance for this connector class name.

Throws:

NamingException - if there are any problems getting the helper instance.