Interface ComponentLifecycle

    • Method Summary

      All Methods Instance Methods Default Methods 
      Modifier and Type Method Description
      default void close()
      Closes the component.
      default void init()
      Initialises the component.
      default void start()
      Starts the component.
      default void stop()
      Stop the component
    • Method Detail

      • init

        default void init()
                   throws CoreException
        Initialises the component.

        Component initialisation includes config verification, creation of connections etc.

        Throws:
        CoreException - wrapping any underlying Exceptions
        Implementation Note:
        The default implementation is no-op
      • start

        default void start()
                    throws CoreException
        Starts the component.

        Once a component is started it should be ready to process messages. In the case of AdaptrisMessageConsumer, calling start will begin message delivery.

        Throws:
        CoreException - wrapping any underlying Exceptions
        Implementation Note:
        The default implementation is no-op
      • stop

        default void stop()
        Stop the component

        A stopped component is not expected to be ready to process messages. In the case of AdaptrisMessageConsumer, calling stop will pause message delivery. Throwing a RuntimeException may cause unintended consequences

        Implementation Note:
        The default implementation is no-op
      • close

        default void close()
        Closes the component.

        A closed component should release any connections it uses, etc. and clean up completely. Throwing a RuntimeException may cause unintended consequences

        Implementation Note:
        The default implementation is no-op