com.ca.jcs.stub
Class StubAttributeStyleOpProcessor

java.lang.Object
  com.ca.jcs.processor.AbstractBaseProcessor
      com.ca.jcs.processor.AbstractAttributeStyleOpProcessor
          com.ca.jcs.stub.StubAttributeStyleOpProcessor

All Implemented Interfaces:

Activatable, AttributeStyleOpProcessor, OpProcessor, PostQueryAttributesProcessor

public class StubAttributeStyleOpProcessor
extends AbstractAttributeStyleOpProcessor
implements AttributeStyleOpProcessor

This stub attribute-style processor comes in useful when writing 100% method-style or scripting-style connectors, as opbindings can only be triggered by interposing them in front of an AttributeStyleOpProcessor.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ca.jcs.processor.OpProcessor

OpProcessor.MethodName

Field Summary

Fields inherited from class com.ca.jcs.processor.AbstractAttributeStyleOpProcessor

proxiedSelf

Fields inherited from class com.ca.jcs.processor.AbstractBaseProcessor

ldapExceptionPrefix, log

Constructor Summary

StubAttributeStyleOpProcessor(BaseConnector connector)

Method Summary

void	activate() Sets proxiedSelf to OpBindings-aware proxy if any OpBindings are configured, otherwise left assigned to "this".
void	deactivate() We also define this for symmetry as activate() is defined.
void	doAdd(ObjectInfo objInfo, Attributes attrs) Create a new object on the managed system with the provided attributes stored for it.
void	doDelete(ObjectInfo objInfo) Delete the object referenced by objInfo from a managed system.
Attributes	doLookUp(ObjectInfo objInfo, String[] attrIds) Look up the provided attribute names on the managed object referenced by objInfo, attribute ids not mapped to connector-speak will either be discarded or cause an error depending on the level of strictness configured for the parent connector.
Attribute	doLookupExpensiveStub(ObjectInfo objInfo, String attrId) Default implementation is to simply do a lookup for attrId, but derived classes may be able to more efficiently find out if the attribute is set or not.
void	doModify(ObjectInfo objInfo, ModificationItem[] modItems) Apply the provided items to the object on the managed system referenced by objInfo.
void	doModifyRn(ObjectInfo objInfo, Rdn newRdn) Rename the managed object referenced by objInfo so that it has the new Relative Distinguished Name (RDN) provided (an example newRdn might be nameAttrId=MyNewName).
void	doMove(ObjectInfo objInfo, Name newParentName, Rdn newRdn) Move the managed object referenced by objInfo to a new parent whilst also changing its RDN (of form "attr=value").
NamingEnumeration<SearchResult>	doSearch(ObjectInfo baseObjInfo, FilterInfo filterInfo, Map<String,String> environment, SearchControls searchControls) Perform search under specified baseName on managed system, using the standard JNDI interfaces and semantics.
DataModel	getMetaData()
void	setMetaData(DataModel dataModel) Called when datamodel metadata used to configure this connector is changed.

Methods inherited from class com.ca.jcs.processor.AbstractAttributeStyleOpProcessor

isPostQueryPocessingActive, processPostQueryAttributes, processPostQuerySearchResult, setPostQueryPocessingActive

Methods inherited from class com.ca.jcs.processor.AbstractBaseProcessor

getBaseConnector, makeNamingException

Methods inherited from class java.lang.Object

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

Constructor Detail

StubAttributeStyleOpProcessor

public StubAttributeStyleOpProcessor(BaseConnector connector)

Method Detail

getMetaData

public DataModel getMetaData()

Specified by:

getMetaData in interface AttributeStyleOpProcessor

Returns:

Metadata used to configure this processor.

setMetaData

public void setMetaData(DataModel dataModel)

Description copied from interface: AttributeStyleOpProcessor

Called when datamodel metadata used to configure this connector is changed.

Specified by:

setMetaData in interface AttributeStyleOpProcessor

Parameters:

dataModel - New metadata to be internalised.

activate

public void activate()
              throws NamingException

Description copied from class: AbstractAttributeStyleOpProcessor

Sets proxiedSelf to OpBindings-aware proxy if any OpBindings are configured, otherwise left assigned to "this".

Specified by:

activate in interface Activatable

Specified by:

activate in interface AttributeStyleOpProcessor

Overrides:

activate in class AbstractAttributeStyleOpProcessor

Throws:

NamingException

deactivate

public void deactivate()
                throws NamingException

Description copied from class: AbstractAttributeStyleOpProcessor

We also define this for symmetry as activate() is defined.

Specified by:

deactivate in interface Activatable

Specified by:

deactivate in interface AttributeStyleOpProcessor

Overrides:

deactivate in class AbstractAttributeStyleOpProcessor

Throws:

NamingException

doDelete

public void doDelete(ObjectInfo objInfo)
              throws NamingException

Description copied from interface: OpProcessor

Delete the object referenced by objInfo from a managed system. Called by Partition.delete(org.apache.directory.shared.ldap.name.LdapDN) after mapping/validation/type conversion has been performed.

Specified by:

doDelete in interface OpProcessor

Parameters:

objInfo - References managed object to be deleted.

Throws:

LdapNameNotFoundException - (or NameNotFoundException) when target object doesn't exist.

NamingException - (usually exception should implement LdapException or arrangements to map it into such an exception should be in place). Pay attention to retriable exceptions as documented in RetryOpProcessorProxy.

doAdd

public void doAdd(ObjectInfo objInfo,
                  Attributes attrs)
           throws NamingException

Description copied from interface: OpProcessor

Create a new object on the managed system with the provided attributes stored for it. Called by Partition.add(org.apache.directory.shared.ldap.name.LdapDN, javax.naming.directory.Attributes) after mapping has been performed.

Specified by:

doAdd in interface OpProcessor

Parameters:

objInfo - Contains information for the managed object which is to be created, where its connector-speak distinguished Name (DN) is dictated by objInfo.getConnectorDn() and its objectClass= is dictated by objInfo.getobjectClassMapping().

attrs - Attributes to be stored on the managed object.

Throws:

LdapNameAlreadyBoundException - Should be thrown if an object with the specified name already exists, other NamingExceptions (preferably implementing LdapException) may also be thrown. Pay attention to retriable exceptions as documented in RetryOpProcessorProxy.

NamingException - (usually exception should implement LdapException or arrangements to map it into such an exception should be in place). Pay attention to retriable exceptions as documented in RetryOpProcessorProxy.

doModify

public void doModify(ObjectInfo objInfo,
                     ModificationItem[] modItems)
              throws NamingException

Description copied from interface: OpProcessor

Apply the provided items to the object on the managed system referenced by objInfo. Called by Partition.modify(org.apache.directory.shared.ldap.name.LdapDN, int, javax.naming.directory.Attributes) after mapping has been performed.

Specified by:

doModify in interface OpProcessor

Parameters:

objInfo - References managed object which is to be modified.

modItems - Items to be modified.

Throws:

LdapNameNotFoundException - (or NameNotFoundException) when target object doesn't exist.

NamingException - (usually exception should implement LdapException or arrangements to map it into such an exception should be in place). Pay attention to retriable exceptions as documented in RetryOpProcessorProxy.

doSearch

public NamingEnumeration<SearchResult> doSearch(ObjectInfo baseObjInfo,
                                                FilterInfo filterInfo,
                                                Map<String,String> environment,
                                                SearchControls searchControls)
                                         throws NamingException

Description copied from interface: OpProcessor

Perform search under specified baseName on managed system, using the standard JNDI interfaces and semantics. All values (DN/filter/return attribute ids) have been mapped into connector-speak by the time this method is called. Called by Partition.search(org.apache.directory.shared.ldap.name.LdapDN, java.util.Map, org.apache.directory.shared.ldap.filter.ExprNode, javax.naming.directory.SearchControls) with mapping performed on the result entries to map/convert them from connector-speak to LDAP.

Specified by:

doSearch in interface OpProcessor

Parameters:

baseObjInfo - Specifies base object for the search, scope in searchControls is relative to this object.

filterInfo - Information regarding the filter to be used for the search, including referenced objectClass= values. Note that attribute names have been converted to connector-speak and any required validators/converters have been run by the framework prior to this method being invoked. The filter's text can be retrieved via ExprNode.printToBuffer(StringBuffer) on contained mappedFilter. If required this mappedFilter can be converted to a different syntax, refer to SimpleFilterVisitor / FilterVisitor and related classes.

environment - Defines any values effecting how the search is performed (eg whether to follow referrals etc). Can usually be ignored.

searchControls - Defines important information about the search itself, for instance what scope the search should have under baseName and which attributes should be returned for each object matching the provided filter. Note that specifying a null String[] for the returned attributes will cause all non-expensive attributes to be returned for each matching objects, whereas specifying String[0] will cause not attributes to be returned except for the DNs of matching objects.

Returns:

Enumeration of SearchResult objects, one per object falling within the specified scope under baseName which matches the provided filter. Results can be handled in two different manners depending on the connector's requirement (indeed, an advanced connector can implement both and choose the best one based on heuristics and a threshold):

1. Pass back results "all at once" (faster, but impractical for very large numbers of matching objects) or
2. "stream" results back one at a time by wrapping in a NamingEnumeration that actually extracts results after this doSearch() call has returned.

Throws:

LdapNameNotFoundException - (or NameNotFoundException) when target object doesn't exist.

NamingException - (usually exception should implement LdapException or arrangements to map it into such an exception should be in place). Pay attention to retriable exceptions as documented in RetryOpProcessorProxy.

doLookUp

public Attributes doLookUp(ObjectInfo objInfo,
                           String[] attrIds)
                    throws NamingException

Description copied from interface: OpProcessor

Look up the provided attribute names on the managed object referenced by objInfo, attribute ids not mapped to connector-speak will either be discarded or cause an error depending on the level of strictness configured for the parent connector. Extra attributes may also be returned. Called by Partition.lookup(org.apache.directory.shared.ldap.name.LdapDN) after mapping has been performed.

Specified by:

doLookUp in interface OpProcessor

Parameters:

objInfo - Managed object for which attributes are to be looked up.

attrIds - Connector-speak identifiers of attributes which are to be returned, null means return all attributes and a zero length array means return no attributes (just a way to check an object's existance).

Returns:

Attributes values on specified managed object, where connector-speak mappings exist for specified attrIds, can be null when the target object exists but has none of the requested

Throws:

LdapNameNotFoundException - (or NameNotFoundException) when target object doesn't exist.

NamingException - (usually exception should implement LdapException or arrangements to map it into such an exception should be in place). Pay attention to retriable exceptions as documented in RetryOpProcessorProxy.

doLookupExpensiveStub

public Attribute doLookupExpensiveStub(ObjectInfo objInfo,
                                       String attrId)
                                throws NamingException

Description copied from class: AbstractAttributeStyleOpProcessor

Default implementation is to simply do a lookup for attrId, but derived classes may be able to more efficiently find out if the attribute is set or not.

Specified by:

doLookupExpensiveStub in interface AttributeStyleOpProcessor

Overrides:

doLookupExpensiveStub in class AbstractAttributeStyleOpProcessor

Parameters:

objInfo - Object for which attribute should be looked up.

attrId - Id for expensive attribute.

Returns:

Possibly less expensive placeholder for expensive attribute, if its possible to avoid looking it up fully.

Throws:

NamingException

See Also:

ValidationLazyAttributesProxy

doModifyRn

public void doModifyRn(ObjectInfo objInfo,
                       Rdn newRdn)
                throws NamingException

Description copied from interface: OpProcessor

Rename the managed object referenced by objInfo so that it has the new Relative Distinguished Name (RDN) provided (an example newRdn might be nameAttrId=MyNewName). Called by Partition.modifyRn(org.apache.directory.shared.ldap.name.LdapDN, java.lang.String, boolean) after mapping has been performed.

Specified by:

doModifyRn in interface OpProcessor

Parameters:

objInfo - References managed object.

newRdn - New terminal name (having form "attr=val") for managed object.

Throws:

LdapNameNotFoundException - (or NameNotFoundException) when target object doesn't exist.

NamingException - (usually exception should implement LdapException or arrangements to map it into such an exception should be in place). Pay attention to retriable exceptions as documented in RetryOpProcessorProxy.

doMove

public void doMove(ObjectInfo objInfo,
                   Name newParentName,
                   Rdn newRdn)
            throws NamingException

Description copied from interface: OpProcessor

Move the managed object referenced by objInfo to a new parent whilst also changing its RDN (of form "attr=value"). Called by Partition.move(org.apache.directory.shared.ldap.name.LdapDN, org.apache.directory.shared.ldap.name.LdapDN, String, boolean) after mapping has been performed.

Specified by:

doMove in interface OpProcessor

Parameters:

objInfo - References managed object to be moved.

newParentName - New parent for managed object.

newRdn - New relative distinguished name (RDN) for managed object, will be either be null (just a move) or different from the object's current RDN (move and rename).

Throws:

LdapNameNotFoundException - (or NameNotFoundException) when target object doesn't exist.

NamingException - (usually exception should implement LdapException or arrangements to map it into such an exception should be in place). Pay attention to retriable exceptions as documented in RetryOpProcessorProxy.