com.ibm.commerce.server

Interface ComponentConfiguration

All Known Implementing Classes:

com.ibm.commerce.event.impl.AbstractECEventListener, AnalyticsComponentConfiguration, CacheInvalOnAttachmentListener, CacheInvalOnCollateralListener, CampaignLoggingECEventListenerImpl, CampaignsCachingComponent, com.ibm.commerce.command.event.CommandExecutionEventListener, ContentCacheInvalComponent, CpgnLogRecommendationEventListener, CpgnStatsRecommendationEventListener, DOMOrderCancellationEventListenerImpl, ECEventEnableComponent, com.ibm.commerce.event.EventComponentConfiguration, ExperimentEvaluationECEventListenerImpl, ExperimentLoggingECEventListenerImpl, GuestUserOrderResetEventListener, MessageMapperGroup, OrderCostCalculationECEventListenerImpl, OrderHistoryECEventListenerImpl, OrdersMgpPersistEventListener, OrderSubmitEventListenerImpl, PAStatsInvocationEventListener, PaymentEventListenerImpl, PCStatsInvocationEventListener, PEStatsInvocationEventListener, PostPublishECEventListenerImpl, RLPromotionComponentConfiguration, SAStatsInvocationEventListener, SearchIndexingCompleteEventListener, SensorEventListener, com.ibm.commerce.event.usertraffic.UserTrafficEventListener, WalletGuestUserMigrationEventListener

public interface ComponentConfiguration

This interface has to be implemented by all components. During the initialization of the request servlet, the init() method of each component defined in the configuration file will be called. During the destruction of the request servlet, the destroy() method of the component will be called.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Method Summary

Modifier and Type	Method and Description
void	destroy() This method will be called when the request servlet is stopped or destroyed.
void	enable(boolean val) This method dynamically enables or disables a component.
void	init(org.w3c.dom.Element node) This method initializes the component.

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Method Detail

destroy

void destroy()

This method will be called when the request servlet is stopped or destroyed.

enable

void enable(boolean val)
     throws java.lang.Exception

This method dynamically enables or disables a component.

Parameters:

val - A boolean value; true if the component is to be enabled and false if is to be disabled.

Throws:

java.lang.Exception

init

void init(org.w3c.dom.Element node)
   throws java.lang.Exception

This method initializes the component. This method will be called during initialization of the request servlet.

Parameters:

node - A dom.Element node with the parameters for the component. It is null if no property is present.

Throws:

java.lang.Exception