@Category(value="Basic") public class PipeLineExit extends Object implements IForwardTarget
Exits
for examples.
path
attribute of a Forward within a Pipe.Constructor and Description |
---|
PipeLineExit() |
Modifier and Type | Method and Description |
---|---|
boolean |
isSuccessExit() |
void |
setCode(int code)
HTTP statusCode e.g.
|
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 |
void |
setName(String name)
The name of the Exit that can be referenced by a
PipeForward 's path attribute. |
void |
setPath(String path)
Deprecated.
|
void |
setResponseRoot(String responseRoot)
Configures the responseRoot in the OpenAPI schema for this exit.
|
void |
setSkipValidation(boolean b)
If set to
true , the output will not be validated or transformed by the validator. |
void |
setSkipWrapping(boolean b)
If set to
true , the output will not be wrapped by the OutputWrapper. |
void |
setState(PipeLine.ExitState value)
The state of the Pipeline that is returned to the Receiver for this Exit.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getName
public boolean isSuccessExit()
public void setName(String name)
PipeForward
's path
attribute. When a Pipeline doesn't have an Exits
element configured it will be initialized with one Exit having name (and state SUCCESS
)@Deprecated @ConfigurationWarning(value="The attribute \'path\' has been renamed \'name\'") public void setPath(String path)
public void setState(PipeLine.ExitState value)
SUCCESS
(and name )public void setCode(int code)
500
public void setResponseRoot(String responseRoot)
SUCCESS
, the last for the other exits.public void setEmpty(boolean b)
true
, this removes the output and shows a blank page, the output is still logged in the ladybug testtoolfalse
public void setSkipWrapping(boolean b)
true
, the output will not be wrapped by the OutputWrapper.false
public void setSkipValidation(boolean b)
true
, the output will not be validated or transformed by the validator.false
Copyright © 2023 Frank!Framework. All rights reserved.