Package com.helger.as2lib

Interface IDynamicComponent

All Known Subinterfaces:
IAliasedCertificateFactory, ICertificateFactory, IKeyStoreCertificateFactory, IMessageProcessor, IPartnershipFactory, IPartnershipFactoryWithPartners, IProcessorActiveModule, IProcessorModule, IProcessorReceiverModule, IProcessorResenderModule, IProcessorSenderModule, IProcessorStorageModule, IRefreshablePartnershipFactory, IStorableCertificateFactory
All Known Implementing Classes:
AbstractActiveModule, AbstractActiveNetModule, AbstractActivePollingModule, AbstractActiveReceiverModule, AbstractActiveResenderModule, AbstractCertificateFactory, AbstractDirectoryPollingModule, AbstractDynamicComponent, AbstractHttpSenderModule, AbstractMessageProcessor, AbstractPartnershipFactory, AbstractPartnershipFactoryWithPartners, AbstractProcessorModule, AbstractResenderModule, AbstractSenderModule, AbstractStorageModule, AS2DirectoryPollingModule, AS2MDNReceiverModule, AS2ReceiverModule, AS2SenderModule, AsynchMDNSenderModule, AsyncMessageProcessor, CertificateFactory, DefaultMessageProcessor, DirectoryResenderModule, ImmediateResenderModule, InMemoryResenderModule, MDNFileModule, MessageFileModule, PredefinedCertificateFactory, SelfFillingPartnershipFactory, SelfFillingXMLPartnershipFactory, XMLPartnershipFactory
public interface IDynamicComponent
The Component interface provides a standard way to dynamically create and initialize an object. Component-based objects also have access to a Session, which allow each component to access all components registered to it's Session. Parameters for a component are defined as static strings
Note: Any object that implements this interface must have a constructor with no parameters, as these parameters should be passed to the init method.
Author:
Aaron Silinskas
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    com.helger.commons.collection.attr.IStringMap
    attrs()
     
    String
    getName()
    Returns a name for the component.
    IAS2Session
    getSession()
    Returns the Session used to initialize this Component.
    void
    initDynamicComponent(IAS2Session aSession, com.helger.commons.collection.attr.IStringMap aParameters)
    After creating a Component object, this method should be called to set any parameters used by the component.

  • Method Details

    • attrs

      @Nonnull com.helger.commons.collection.attr.IStringMap attrs()
      Returns:
      The attributes of this component.

    • getName

      @Nullable String getName()
      Returns a name for the component. These names are not guaranteed to be unique, and are intended for display and logging. Generally this is the class name of the Component object, without package information.
      Returns:
      name of the component

    • getSession

      @Nonnull IAS2Session getSession()
      Returns the Session used to initialize this Component. The returned session is also used to locate other components if needed.
      Returns:
      this component's session. Never null.

    • initDynamicComponent

      void initDynamicComponent(@Nonnull IAS2Session aSession, @Nullable com.helger.commons.collection.attr.IStringMap aParameters) throws AS2Exception
      After creating a Component object, this method should be called to set any parameters used by the component. Component implementations typically have required parameter checking and code to start timers and threads within this method.
      Parameters:
      aSession - the component uses this object to access other components
      aParameters - configuration values for the component. All parameters will be stored as attributes of this component. All attributes existing before this method is called will be removed!
      Throws:
      AS2Exception - If an error occurs while initializing the component
      AS2InvalidParameterException - If a required parameter is null in the parameters Map
      See Also: