Package org.frankframework.core

Class PipeLineExit

java.lang.Object
org.frankframework.core.PipeLineExit
All Implemented Interfaces:
IForwardTarget
@Category(BASIC) @FrankDocGroup(OTHER) public class PipeLineExit extends Object implements IForwardTarget
The Exit of a Pipeline that specifies the end state of a PipeLine. The state is returned to the receiver as well as the optionally specified http status code. Each Exit should have a unique name. See Exits for examples.

When a Pipeline doesn't have an Exits element configured it will be initialized with one Exit having name "READY" and state "SUCCESS".

The name of an Exit can be referenced by the path attribute of a Forward within a Pipe.
Author:
Johan Verrips, Niels Meijer

  • Constructor Details

    • PipeLineExit

      public PipeLineExit()

  • Method Details

    • isSuccessExit

      public boolean isSuccessExit()

    • setName

      public void setName(String name)
      The name of the Exit that can be referenced by a PipeForward's path attribute. When a Pipeline doesn't have an Exits element configured it will be initialized with one Exit having name "READY" (and state SUCCESS)

    • setPath

      @Deprecated(forRemoval=true, since="7.8.0") @ConfigurationWarning("The attribute \'path\' has been renamed to: \'name\'") public void setPath(String path)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setState

      public void setState(PipeLine.ExitState value)
      The state of the Pipeline that is returned to the Receiver for this Exit. When a Pipeline doesn't have an Exits element configured it will be initialized with one Exit having state SUCCESS (and name "READY")

    • setCode

      public void setCode(int code)
      HTTP statusCode e.g. 500
      Default value
      200

    • setResponseRoot

      public void setResponseRoot(String responseRoot)
      Configures the responseRoot in the OpenAPI schema for this exit. If not set, the responseRoot value of the validator will be used. If that contains multiple (comma separated) values, the first will be used for the exits with state SUCCESS, the last for the other exits.

    • setEmpty

      public void setEmpty(boolean b)
      If using RestListener and set to true, this removes the output and shows a blank page, the output is still logged in the ladybug testtool
      Default value
      false

    • setSkipWrapping

      public void setSkipWrapping(boolean b)
      If set to true, the output will not be wrapped by the OutputWrapper.
      Default value
      false

    • setSkipValidation

      public void setSkipValidation(boolean b)
      If set to true, the output will not be validated or transformed by the validator.
      Default value
      false

    • getName

      public String getName()
      Description copied from interface: IForwardTarget
      The part of the object that identifies its destination: The name of the Pipe or the path of the PipeLineExit.
      Specified by:
      getName in interface IForwardTarget

    • getState

      public PipeLine.ExitState getState()

    • getExitCode

      public int getExitCode()

    • getResponseRoot

      public String getResponseRoot()

    • isEmptyResult

      public boolean isEmptyResult()

    • isSkipValidation

      public boolean isSkipValidation()

    • isSkipWrapping

      public boolean isSkipWrapping()