com.ca.jcs.processor
Interface AttributeStyleOpProcessor

All Superinterfaces:
Activatable, OpProcessor
All Known Subinterfaces:
AssocAttributeOpProcessor, AssocDirectAttributeOpProcessor, AssocIndirectAttributeOpProcessor
All Known Implementing Classes:
AbstractAttributeStyleOpProcessor, AbstractAttributeStyleOpProcessorAssocDirect, AbstractAttributeStyleOpProcessorAssocIndirect, DefaultAssocAttributeOpProcessor, DefaultAssocDirectAttributeOpProcessor, JDBCAttributeStyleOpProcessor, JNDIAttributeStyleOpProcessor, NestedAssocDirectAttributeOpProcessor, ORAAttributeStyleOpProcessor, SDKAttributeStyleOpProcessor, SDKWSAttributeStyleOpProcessor, StubAttributeStyleOpProcessor, StubDirectAssocAttributeStyleOpProcessor

public interface AttributeStyleOpProcessor
extends OpProcessor, Activatable

This style of op processor is the most commonly used one, and relies on metadata to define the datamodel and mappings for all objects to be handled for the parent connector. All connectors must have this style of processor, even if it is a stub which does nothing other then provide trigger points for method/sscript style op processors.

Note that activate() is called when processors for all styles have been assigned to the parent connector (which has been fully initialised and is ready to receive requests).

Refer to the cacom module's datamodel.xsd, and the example document used to drive the SDK sample: sdk_metadata.xml.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.ca.jcs.processor.OpProcessor
OpProcessor.MethodName
 
Method Summary
 void activate()
          This method is called when the target object has been fully initialised, and is ready to receive requests.
 void deactivate()
          This method is called when the target object is no longer needed and should tidy-up any connections / resources it holds.
 Attribute doLookupExpensiveStub(ObjectInfo objInfo, String attrId)
          Special single attribute version of OpProcessor.doLookUp(com.ca.jcs.ObjectInfo, String[]) that can increase the efficiency of validator checks against expensive attributes by just return stubs for them (ie only the number of values is returned rather then content).
 DataModel getMetaData()
           
 void setMetaData(DataModel dataModel)
          Called when datamodel metadata used to configure this connector is changed.
 
Methods inherited from interface com.ca.jcs.processor.OpProcessor
doAdd, doDelete, doLookUp, doModify, doModifyRn, doMove, doSearch
 

Method Detail

activate

@OpBindingMethod(operation=ACTIVATE)
void activate()
              throws NamingException
Description copied from interface: Activatable
This method is called when the target object has been fully initialised, and is ready to receive requests.

Specified by:
activate in interface Activatable
Throws:
NamingException

deactivate

@OpBindingMethod(operation=DEACTIVATE)
void deactivate()
                throws NamingException
Description copied from interface: Activatable
This method is called when the target object is no longer needed and should tidy-up any connections / resources it holds.

Specified by:
deactivate in interface Activatable
Throws:
NamingException

getMetaData

DataModel getMetaData()
Returns:
Metadata used to configure this processor.

setMetaData

void setMetaData(DataModel dataModel)
Called when datamodel metadata used to configure this connector is changed.

Parameters:
dataModel - New metadata to be internalised.

doLookupExpensiveStub

Attribute doLookupExpensiveStub(ObjectInfo objInfo,
                                String attrId)
                                throws NamingException
Special single attribute version of OpProcessor.doLookUp(com.ca.jcs.ObjectInfo, String[]) that can increase the efficiency of validator checks against expensive attributes by just return stubs for them (ie only the number of values is returned rather then content). For instance this would help enormously in the case where we are checking a photo field (potentially megabytes) is single-valued.

Throws:
NamingException
See Also:
ValidationLazyAttributesProxy


Created 2011-07-14 13:27 EST