Package com.adaptris.core.http.jetty

Class JettyNoBacklogInterceptor

  • All Implemented Interfaces:
    AdaptrisComponent, ComponentLifecycle, ComponentLifecycleExtension, StateManagedComponent, WorkflowInterceptor
    @ComponentProfile(summary="Interceptor that automatically returns a 503 if its parent workflow is busy.",
                  tag="interceptor,http,https",
                  since="3.7.3")
public class JettyNoBacklogInterceptor
extends WorkflowInterceptorImpl
    WorkflowInterceptor that automatically returns a 503 if it knows there is nothing available to handle the inbound message in the parent workflow.

    Note that this interceptor only works with PoolingWorkflow; results are undefined when used with other workflows. What actually happens is that if the current message (during workflowStart()) increases the count of messages in flight over the maximum pool size then a 503 Server Busy is immediately returned. The message is also marked with CoreConstants.STOP_PROCESSING_KEY and CoreConstants.KEY_WORKFLOW_SKIP_PRODUCER which will cause the underlying workflow to skip processing the message (effectively the message will be discarded); you will see logging to that effect at TRACE/DEBUG level.

    Since:
    3.7.3

    In the adapter configuration file this class is aliased as jetty-no-backlog-interceptor which is the preferred alternative to the fully qualified classname when building your configuration.

    • Constructor Detail

      • JettyNoBacklogInterceptor

        public JettyNoBacklogInterceptor()

    • Method Detail

      • init

        public void init()
          throws CoreException
        Description copied from interface: ComponentLifecycle
        Initialises the component.

        Component initialisation includes config verification, creation of connections etc.

        Throws:
        CoreException - wrapping any underlying Exceptions

      • start

        public void start()
           throws CoreException
        Description copied from interface: ComponentLifecycle
        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

      • stop

        public void stop()
        Description copied from interface: ComponentLifecycle
        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

      • close

        public void close()
        Description copied from interface: ComponentLifecycle
        Closes the component.

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

      • workflowStart

        public void workflowStart​(AdaptrisMessage inputMsg)
        Description copied from interface: WorkflowInterceptor
        Mark the start of a workflow. This doesn't mean the message has started processing but only that the message will - at some point - be processed by the workflow.
        Parameters:
        inputMsg - the message that will be processed by this workflow.

      • workflowEnd

        public void workflowEnd​(AdaptrisMessage inputMsg,
                        AdaptrisMessage outputMsg)
        Description copied from interface: WorkflowInterceptor
        Mark the end of a workflow.
        Parameters:
        inputMsg - the original message that was originally submitted to the workflow; in the event of an exception during processing, the exception will be stored in object metadata in the inputMsg
        outputMsg - the message contaning any changes that may have been applied by the services within the workflow.
        See Also:
        CoreConstants.OBJ_METADATA_EXCEPTION