com.ca.jcs.sdkws
Class SDKWSAttributeStyleOpProcessor

java.lang.Object
  com.ca.jcs.processor.AbstractBaseProcessor
      com.ca.jcs.processor.AbstractAttributeStyleOpProcessor
          com.ca.jcs.processor.AbstractAttributeStyleOpProcessorAssocDirect
              com.ca.jcs.assoc.DefaultAssocDirectAttributeOpProcessor
                  com.ca.jcs.sdkws.SDKWSAttributeStyleOpProcessor

All Implemented Interfaces:

Activatable, AssocAttributeOpProcessor, AssocDirectAttributeOpProcessor, AttributeStyleOpProcessor, OpProcessor, PostQueryAttributesProcessor

public class SDKWSAttributeStyleOpProcessor
extends DefaultAssocDirectAttributeOpProcessor

SDK Web service connector.

Author:

Trudi.

Nested Class Summary

Nested classes/interfaces inherited from class com.ca.jcs.assoc.DefaultAssocDirectAttributeOpProcessor

DefaultAssocDirectAttributeOpProcessor.AssocAttrValue, DefaultAssocDirectAttributeOpProcessor.AssociationStyle

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

OpProcessor.MethodName

Field Summary

Fields inherited from class com.ca.jcs.assoc.DefaultAssocDirectAttributeOpProcessor

metaConnector

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

proxiedAssocSelf

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

proxiedSelf

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

ldapExceptionPrefix

Constructor Summary

SDKWSAttributeStyleOpProcessor(SDKWSMetaConnector connector)
Create connector.

Method Summary

void	doAdd(ObjectInfo objInfo, Attributes attrs) Create a ws object to be added to ws endpoint via ws operation.
void	doDelete(ObjectInfo objInfo) Delete a ws object from ws endpoint via ws operation.
Attributes	doLookUp(ObjectInfo objInfo, String[] attrIds) Handles base level searches.
void	doModify(ObjectInfo objInfo, ModificationItem[] modItems) Modify a ws object from ws endpoint via ws operation.
void	doModifyRn(ObjectInfo objInfo, Rdn newRdn) See the super class OpProcessor Java Doc for detials.
void	doMove(ObjectInfo objInfo, Name newParentName) See the super class OpProcessor Java Doc for detials.
void	doMove(ObjectInfo objInfo, Name newParentName, Rdn newRn) See the super class OpProcessor Java Doc for detials.
NamingEnumeration<SearchResult>	doSearch(ObjectInfo baseObjInfo, FilterInfo filterInfo, Map<String,String> environment, SearchControls searchControls) Handles all searches, or only onelevel and subtree searches.
DataModel	getMetaData() Return the metadata.
void	setMetaData(DataModel dataModel) Method to store meta data.

Methods inherited from class com.ca.jcs.assoc.DefaultAssocDirectAttributeOpProcessor

addAttrAssocs, doAssocSearchForReferencesTo, doAssocUpdateReferencesTo, doDeleteAssocs, doLookupAssocs, doLookupExpensiveStub, doModifyAssocs, doModifyRnAssocs, doMoveAssocs, doSearchAssocs, expandTemplateValues, getAssocClassMap, getAssocConnAttrId, getAssocConnAttrIds, getAssocConnectorAttrIds, getAssocDataModelProp, getAssocLdapAttr, getAssocObjectClass, getAttrProc, getMetaConnector, removeAttrAssocs, updateAttrAssocs

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

activate, convertConnectorDNToKey, convertConnectorDNToKeys, convertKeyToConnectorDN

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

deactivate, 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

Methods inherited from interface com.ca.jcs.processor.AttributeStyleOpProcessor

deactivate

Constructor Detail

SDKWSAttributeStyleOpProcessor

public SDKWSAttributeStyleOpProcessor(SDKWSMetaConnector connector)

Create connector. Note that AbstractBaseProcessor.ldapExceptionPrefix should be prefixed onto any LdapNameingExceptions thrown so that clients can easily distinguish between exceptions raised (and hence understand the exception more clearly):

1. in the code for this connector
2. in the JCS framework code
3. in the ApacheDS code

Parameters:

connector - the ws connector

Method Detail

doAdd

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

Create a ws object to be added to ws endpoint via ws operation.

Parameters:

objInfo - contains the target object's class type information to add.

attrs - attributes to be persisted for the target endpoint.

Throws:

NamingException - when error occurs.

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.

doDelete

public void doDelete(ObjectInfo objInfo)
              throws NamingException

Delete a ws object from ws endpoint via ws operation.

Parameters:

objInfo - contains the target object's class type information to delete.

Throws:

NamingException - when error occurs.

doModify

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

Modify a ws object from ws endpoint via ws operation.

Parameters:

objInfo - contains the target object's class type information to modify.

modItems - contains the items to modify.

Throws:

NamingException - when error occurs.

doSearch

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

Handles all searches, or only onelevel and subtree searches. See the super class OpProcessor Java Doc for detials.

Parameters:

baseObjInfo - contains the base object's class type information to search.

filterInfo - contains the search filter.

environment - defines any values effecting how the search is performed.

searchControls - defines important information about the search itself.

Returns:

search results.

Throws:

NamingException - when error occurs.

doLookUp

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

Handles base level searches. See the super class OpProcessor Java Doc for detials.

Parameters:

objInfo - contains the target object's class type information to lookup.

attrIds - contains the target object's attribute ids to lookup.

Returns:

attributes correspond to attrIds.

Throws:

NamingException - when error occurs.

doModifyRn

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

See the super class OpProcessor Java Doc for detials.

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 newRn)
            throws NamingException

See the super class OpProcessor Java Doc for detials.

Parameters:

objInfo - References managed object to be moved.

newParentName - New parent for managed object.

newRn - 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.

doMove

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

See the super class OpProcessor Java Doc for detials.

Throws:

NamingException

getMetaData

public DataModel getMetaData()

Return the metadata.

Specified by:

getMetaData in interface AttributeStyleOpProcessor

Overrides:

getMetaData in class DefaultAssocDirectAttributeOpProcessor

Returns:

the metadata.

setMetaData

public void setMetaData(DataModel dataModel)

Method to store meta data.

Parameters:

dataModel - the metadata.