Collaboration diagram for dev.filechampion.filechampion4j.PluginsHelper.StepConfig:

Public Member Functions
boolean	isRunBefore ()

void	setRunBefore (boolean runBefore)

boolean	isRunAfter ()

void	setRunAfter (boolean runAfter)

CliPluginHelper	getCliPluginHelper ()

void	setCliPluginHelper (CliPluginHelper cliPluginHelper)

String	getName ()

void	setName (String name)

String	getType ()

void	setType (String type)

String	getEndpoint ()

void	setEndpoint (String endpoint)

int	getTimeout ()

void	setTimeout (int timeout)

String	getOnFail ()

void	setOnFail (String onFail)

String	getResponse ()

void	setResponse (String response)

String	getMethod ()

void	setMethod (String method)

JSONObject	getHeaders ()

void	setHeaders (JSONObject headers)

JSONObject	getBody ()

void	setBody (JSONObject body)

int	getHttpPassCode ()

void	setHttpPassCode (int httpPassCode)

int	getHttpFailCode ()

void	setHttpFailCode (int httpFailCode)

String	getCredsPath ()

void	setCredsPath (String credsPath)

Private Attributes
String	name

String	type

String	endpoint

int	timeout

String	onFail

String	response

String	method

JSONObject	headers

JSONObject	body

int	httpPassCode

int	httpFailCode

String	credsPath

CliPluginHelper	cliPluginHelper

boolean	runBefore

boolean	runAfter

Detailed Description

Class to set and return a single step configuration.

Definition at line 120 of file PluginsHelper.java.

Member Function Documentation

◆ getBody()

JSONObject dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getBody ( )

Return the body of the step.

Returns: (JSONObject) the body of the step

Definition at line 317 of file PluginsHelper.java.

                                    {
            return body;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.body.

◆ getCliPluginHelper()

CliPluginHelper dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getCliPluginHelper ( )

Return a CliPluginHelper object.

Returns: (CliPluginHelper) a CliPluginHelper object

Definition at line 173 of file PluginsHelper.java.

                                                    {
            return cliPluginHelper;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.cliPluginHelper.

◆ getCredsPath()

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getCredsPath ( )

Return the credsPath of the step.

Returns: (String) the credsPath of the step

Definition at line 365 of file PluginsHelper.java.

                                     {
            return credsPath;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.credsPath.

◆ getEndpoint()

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getEndpoint ( )

Return the endpoint of the step.

Returns: (String) the endpoint of the step

Definition at line 221 of file PluginsHelper.java.

                                    {
            return endpoint;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.endpoint.

Referenced by dev.filechampion.filechampion4j.CliPluginHelper.CliPluginHelper().

Here is the caller graph for this function:

◆ getHeaders()

JSONObject dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getHeaders ( )

Return the headers of the step.

Returns: (JSONObject) the headers of the step

Definition at line 301 of file PluginsHelper.java.

                                       {
            return headers;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.headers.

◆ getHttpFailCode()

int dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getHttpFailCode ( )

Return the httpFailCode of the step.

Returns: (int) the httpFailCode of the step

Definition at line 349 of file PluginsHelper.java.

                                     {
            return httpFailCode;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.httpFailCode.

◆ getHttpPassCode()

int dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getHttpPassCode ( )

Return the httpPassCode of the step.

Returns: (int) the httpPassCode of the step

Definition at line 333 of file PluginsHelper.java.

                                     {
            return httpPassCode;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.httpPassCode.

◆ getMethod()

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getMethod ( )

Return the method of the step.

Returns: (String) the method of the step

Definition at line 285 of file PluginsHelper.java.

                                  {
            return method;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.method.

◆ getName()

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getName ( )

Return the name of the step.

Returns: (String) the name of the step

Definition at line 189 of file PluginsHelper.java.

                                {
            return name;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.name.

Referenced by dev.filechampion.filechampion4j.CliPluginHelper.CliPluginHelper(), and dev.filechampion.filechampion4j.CliPluginHelper.execute().

Here is the caller graph for this function:

◆ getOnFail()

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getOnFail ( )

Return the onFail of the step.

Returns: (String) the onFail of the step

Definition at line 253 of file PluginsHelper.java.

                                  {
            return onFail;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.onFail.

◆ getResponse()

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getResponse ( )

Return the response of the step.

Returns: (String) the response of the step

Definition at line 269 of file PluginsHelper.java.

                                    {
            return response;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.response.

Referenced by dev.filechampion.filechampion4j.CliPluginHelper.CliPluginHelper().

Here is the caller graph for this function:

◆ getTimeout()

int dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getTimeout ( )

Return the timeout of the step.

Returns: (int) the timeout of the step

Definition at line 237 of file PluginsHelper.java.

                                {
            return timeout;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.timeout.

Referenced by dev.filechampion.filechampion4j.CliPluginHelper.CliPluginHelper().

Here is the caller graph for this function:

◆ getType()

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getType ( )

Return the type of the step.

Returns: (String) the type of the step

Definition at line 205 of file PluginsHelper.java.

                                {
            return type;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.type.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ isRunAfter()

boolean dev.filechampion.filechampion4j.PluginsHelper.StepConfig.isRunAfter ( )

Check if run_after is set to true.

Returns: (boolean) true if run_after is set to true, false otherwise

Definition at line 157 of file PluginsHelper.java.

                                    {
            return runAfter;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.runAfter.

Referenced by dev.filechampion.filechampion4j.FileValidator.loadPlugins().

Here is the caller graph for this function:

◆ isRunBefore()

boolean dev.filechampion.filechampion4j.PluginsHelper.StepConfig.isRunBefore ( )

Check if run_before is set to true.

Returns: (boolean) true if run_before is set to true, false otherwise

Definition at line 141 of file PluginsHelper.java.

                                     {
            return runBefore;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.runBefore.

Referenced by dev.filechampion.filechampion4j.FileValidator.loadPlugins().

Here is the caller graph for this function:

◆ setBody()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setBody ( JSONObject body )

Set the body of the step.

Parameters

body	(JSONObject) the body of the step

Definition at line 325 of file PluginsHelper.java.

                                             {
            this.body = body;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.body.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setCliPluginHelper()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setCliPluginHelper ( CliPluginHelper cliPluginHelper )

Set a CliPluginHelper object.

Parameters

cliPluginHelper (CliPluginHelper) a CliPluginHelper object

Definition at line 181 of file PluginsHelper.java.

                                                                        {
            this.cliPluginHelper = cliPluginHelper;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.cliPluginHelper.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setCredsPath()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setCredsPath ( String credsPath )

Set the credsPath of the step.

Parameters

credsPath (String) the credsPath of the step

Definition at line 373 of file PluginsHelper.java.

                                                   {
            this.credsPath = credsPath;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.credsPath.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setEndpoint()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setEndpoint ( String endpoint )

Set the endpoint of the step.

Parameters

endpoint (String) the endpoint of the step

Definition at line 229 of file PluginsHelper.java.

                                                 {
            this.endpoint = endpoint;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.endpoint.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setHeaders()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setHeaders ( JSONObject headers )

Set the headers of the step.

Parameters

headers (JSONObject) the headers of the step

Definition at line 309 of file PluginsHelper.java.

                                                   {
            this.headers = headers;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.headers.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setHttpFailCode()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setHttpFailCode ( int httpFailCode )

Set the httpFailCode of the step.

Parameters

httpFailCode (int) the httpFailCode of the step

Definition at line 357 of file PluginsHelper.java.

                                                      {
            this.httpFailCode = httpFailCode;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.httpFailCode.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setHttpPassCode()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setHttpPassCode ( int httpPassCode )

Set the httpPassCode of the step.

Parameters

httpPassCode (int) the httpPassCode of the step

Definition at line 341 of file PluginsHelper.java.

                                                      {
            this.httpPassCode = httpPassCode;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.httpPassCode.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setMethod()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setMethod ( String method )

Set the method of the step.

Parameters

method (String) the method of the step

Definition at line 293 of file PluginsHelper.java.

                                             {
            this.method = method;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.method.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setName()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setName ( String name )

Set the name of the step.

Parameters

name	(String) the name of the step

Definition at line 197 of file PluginsHelper.java.

                                         {
            this.name = name;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.name.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setOnFail()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setOnFail ( String onFail )

Set the onFail of the step.

Parameters

onFail (String) the onFail of the step

Definition at line 261 of file PluginsHelper.java.

                                             {
            this.onFail = onFail;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.onFail.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setResponse()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setResponse ( String response )

Set the response of the step.

Parameters

response (String) the response of the step

Definition at line 277 of file PluginsHelper.java.

                                                 {
            this.response = response;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.response.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setRunAfter()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setRunAfter ( boolean runAfter )

Set run_after to true or false.

Parameters

runAfter (boolean) true if run_after is set to true, false otherwise

Definition at line 165 of file PluginsHelper.java.

                                                  {
            this.runAfter = runAfter;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.runAfter.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setRunBefore()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setRunBefore ( boolean runBefore )

Set run_before to true or false.

Parameters

runBefore (boolean) true if run_before is set to true, false otherwise

Definition at line 149 of file PluginsHelper.java.

                                                    {
            this.runBefore = runBefore;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.runBefore.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setTimeout()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setTimeout ( int timeout )

Set the timeout of the step.

Parameters

timeout (int) the timeout of the step

Definition at line 245 of file PluginsHelper.java.

                                            {
            this.timeout = timeout;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.timeout.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

◆ setType()

void dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setType ( String type )

Set the type of the step.

Parameters

type	(String) the type of the step

Definition at line 213 of file PluginsHelper.java.

                                         {
            this.type = type;
        }

References dev.filechampion.filechampion4j.PluginsHelper.StepConfig.type.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.getPluginConfigs().

Here is the caller graph for this function:

Member Data Documentation

◆ body

JSONObject dev.filechampion.filechampion4j.PluginsHelper.StepConfig.body

private

Definition at line 129 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getBody(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setBody().

◆ cliPluginHelper

CliPluginHelper dev.filechampion.filechampion4j.PluginsHelper.StepConfig.cliPluginHelper

private

Definition at line 133 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getCliPluginHelper(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setCliPluginHelper().

◆ credsPath

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.credsPath

private

Definition at line 132 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getCredsPath(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setCredsPath().

◆ endpoint

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.endpoint

private

Definition at line 123 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getEndpoint(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setEndpoint().

◆ headers

JSONObject dev.filechampion.filechampion4j.PluginsHelper.StepConfig.headers

private

Definition at line 128 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getHeaders(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setHeaders().

◆ httpFailCode

int dev.filechampion.filechampion4j.PluginsHelper.StepConfig.httpFailCode

private

Definition at line 131 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getHttpFailCode(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setHttpFailCode().

◆ httpPassCode

int dev.filechampion.filechampion4j.PluginsHelper.StepConfig.httpPassCode

private

Definition at line 130 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getHttpPassCode(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setHttpPassCode().

◆ method

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.method

private

Definition at line 127 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getMethod(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setMethod().

◆ name

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.name

private

Definition at line 121 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getName(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setName().

◆ onFail

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.onFail

private

Definition at line 125 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getOnFail(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setOnFail().

◆ response

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.response

private

Definition at line 126 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getResponse(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setResponse().

◆ runAfter

boolean dev.filechampion.filechampion4j.PluginsHelper.StepConfig.runAfter

private

Definition at line 135 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.isRunAfter(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setRunAfter().

◆ runBefore

boolean dev.filechampion.filechampion4j.PluginsHelper.StepConfig.runBefore

private

Definition at line 134 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.isRunBefore(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setRunBefore().

◆ timeout

int dev.filechampion.filechampion4j.PluginsHelper.StepConfig.timeout

private

Definition at line 124 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getTimeout(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setTimeout().

◆ type

String dev.filechampion.filechampion4j.PluginsHelper.StepConfig.type

private

Definition at line 122 of file PluginsHelper.java.

Referenced by dev.filechampion.filechampion4j.PluginsHelper.StepConfig.getType(), and dev.filechampion.filechampion4j.PluginsHelper.StepConfig.setType().

The documentation for this class was generated from the following file:

src/main/java/dev/filechampion/filechampion4j/PluginsHelper.java

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ getBody()

◆ getCliPluginHelper()

◆ getCredsPath()

◆ getEndpoint()

◆ getHeaders()

◆ getHttpFailCode()

◆ getHttpPassCode()

◆ getMethod()

◆ getName()

◆ getOnFail()

◆ getResponse()

◆ getTimeout()

◆ getType()

◆ isRunAfter()

◆ isRunBefore()

◆ setBody()

◆ setCliPluginHelper()

◆ setCredsPath()

◆ setEndpoint()

◆ setHeaders()

◆ setHttpFailCode()

◆ setHttpPassCode()

◆ setMethod()

◆ setName()

◆ setOnFail()

◆ setResponse()

◆ setRunAfter()

◆ setRunBefore()

◆ setTimeout()

◆ setType()

Member Data Documentation

◆ body

◆ cliPluginHelper

◆ credsPath

◆ endpoint

◆ headers

◆ httpFailCode

◆ httpPassCode

◆ method

◆ name

◆ onFail

◆ response

◆ runAfter

◆ runBefore

◆ timeout

◆ type