org.cid.distribution.base
Class DistributionComponentBase

java.lang.Object
  org.cid.distribution.base.DistributionComponentBase

All Implemented Interfaces:

DistributionContextAware, DistributionComponent

Direct Known Subclasses:

ConnectionComponent, DataMemberManagerComponent, DBMemberManagerComponent, GeneralInfoLogComponent, QueryDataComponent, StaticMemberManagerComponent

public abstract class DistributionComponentBase
extends java.lang.Object
implements DistributionComponent, DistributionContextAware

A helper base class for DistributionComponent classes contained in a DistributionProcess.

Version:

$Revision: 129 $

Constructor Summary

DistributionComponentBase()
Class constructor.

Method Summary

static void	addRules(org.apache.commons.digester.Digester d, java.lang.String patternPrefix) Configures additional rules for the commons-digester library.
void	destroy() The distribution container calls this method on all components before finishing the distribution process, allowing them to clean up resources.
java.lang.String	getId() Returns the Id of this component.
void	init() The distribution container calls this method on all components before starting the distribution process.
void	setDistributionContext(DistributionContext context) Sets the DistributionContext reference of this object.
void	setId(java.lang.String id)

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributionComponentBase

public DistributionComponentBase()

Class constructor.

Method Detail

getId

public java.lang.String getId()

Description copied from interface: DistributionComponent

Returns the Id of this component.

Specified by:

getId in interface DistributionComponent

Returns:

Returns the id.

setId

public void setId(java.lang.String id)

Parameters:

id - The id to set.

init

public void init()
          throws DistributionProcessingException,
                 DistributionConfigurationException

Description copied from interface: DistributionComponent

The distribution container calls this method on all components before starting the distribution process.

Specified by:

init in interface DistributionComponent

Throws:

DistributionProcessingException

DistributionConfigurationException

destroy

public void destroy()
             throws DistributionProcessingException,
                    DistributionConfigurationException

Description copied from interface: DistributionComponent

The distribution container calls this method on all components before finishing the distribution process, allowing them to clean up resources.

Specified by:

destroy in interface DistributionComponent

Throws:

DistributionProcessingException

DistributionConfigurationException

setDistributionContext

public void setDistributionContext(DistributionContext context)

Sets the DistributionContext reference of this object.

Specified by:

setDistributionContext in interface DistributionContextAware

addRules

public static void addRules(org.apache.commons.digester.Digester d,
                            java.lang.String patternPrefix)

Configures additional rules for the commons-digester library.