Package sonia.scm.web.cgi

Interface CGIExecutor

All Known Implementing Classes:

AbstractCGIExecutor

public interface CGIExecutor

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENV_AUTH_TYPE
static final String	ENV_CONTENT_LENGTH
static final String	ENV_CONTENT_TYPE
static final String	ENV_GATEWAY_INTERFACE
static final String	ENV_HTTP_HEADER_PREFIX
static final String	ENV_HTTPS
static final String	ENV_HTTPS_VALUE_OFF
static final String	ENV_HTTPS_VALUE_ON
static final String	ENV_PATH_INFO
static final String	ENV_PATH_TRANSLATED
static final String	ENV_QUERY_STRING
static final String	ENV_REMOTE_ADDR
static final String	ENV_REMOTE_HOST
static final String	ENV_REMOTE_USER
static final String	ENV_REQUEST_METHOD
static final String	ENV_SCRIPT_FILENAME
static final String	ENV_SCRIPT_NAME
static final String	ENV_SERVER_NAME
static final String	ENV_SERVER_PORT
static final String	ENV_SERVER_PROTOCOL
static final String	ENV_SERVER_SOFTWARE
static final String	ENV_SYSTEM_ROOT
static final String	REPSONSE_HEADER_CONTENT_TYPE	Deprecated. use RESPONSE_HEADER_CONTENT_TYPE instead.
static final String	RESPONSE_HEADER_CONTENT_LENGTH
static final String	RESPONSE_HEADER_CONTENT_TYPE
static final String	RESPONSE_HEADER_HTTP_PREFIX
static final String	RESPONSE_HEADER_LOCATION
static final String	RESPONSE_HEADER_STATUS

Method Summary

Modifier and Type	Method	Description
void	execute(String cmd)
default List<String>	getArgs()	Returns command args as list.
int	getBufferSize()
EnvList	getEnvironment()
CGIExceptionHandler	getExceptionHandler()
String	getInterpreter()
CGIStatusCodeHandler	getStatusCodeHandler()
File	getWorkDirectory()
boolean	isContentLengthWorkaround()
boolean	isIgnoreExitCode()
boolean	isPassShellEnvironment()
default void	setArgs(List<String> args)	Set command arguments.
void	setBufferSize(int bufferSize)
void	setContentLengthWorkaround(boolean contentLengthWorkaround)
void	setEnvironment(EnvList environment)
void	setExceptionHandler(CGIExceptionHandler exceptionHandler)
void	setIgnoreExitCode(boolean ignoreExitCode)
void	setInterpreter(String interpreter)
void	setPassShellEnvironment(boolean passShellEnvironment)
void	setStatusCodeHandler(CGIStatusCodeHandler statusCodeHandler)
void	setWorkDirectory(File workDirectory)

Field Details

ENV_AUTH_TYPE

static final String ENV_AUTH_TYPE

See Also:

• Constant Field Values

ENV_CONTENT_LENGTH

static final String ENV_CONTENT_LENGTH

See Also:

• Constant Field Values

ENV_CONTENT_TYPE

static final String ENV_CONTENT_TYPE

See Also:

• Constant Field Values

ENV_GATEWAY_INTERFACE

static final String ENV_GATEWAY_INTERFACE

See Also:

• Constant Field Values

ENV_HTTPS

static final String ENV_HTTPS

See Also:

• Constant Field Values

ENV_HTTPS_VALUE_OFF

static final String ENV_HTTPS_VALUE_OFF

See Also:

• Constant Field Values

ENV_HTTPS_VALUE_ON

static final String ENV_HTTPS_VALUE_ON

See Also:

• Constant Field Values

ENV_HTTP_HEADER_PREFIX

static final String ENV_HTTP_HEADER_PREFIX

See Also:

• Constant Field Values

ENV_PATH_INFO

static final String ENV_PATH_INFO

See Also:

• Constant Field Values

ENV_PATH_TRANSLATED

static final String ENV_PATH_TRANSLATED

See Also:

• Constant Field Values

ENV_QUERY_STRING

static final String ENV_QUERY_STRING

See Also:

• Constant Field Values

ENV_REMOTE_ADDR

static final String ENV_REMOTE_ADDR

See Also:

• Constant Field Values

ENV_REMOTE_HOST

static final String ENV_REMOTE_HOST

See Also:

• Constant Field Values

ENV_REMOTE_USER

static final String ENV_REMOTE_USER

See Also:

• Constant Field Values

ENV_REQUEST_METHOD

static final String ENV_REQUEST_METHOD

See Also:

• Constant Field Values

ENV_SCRIPT_FILENAME

static final String ENV_SCRIPT_FILENAME

See Also:

• Constant Field Values

ENV_SCRIPT_NAME

static final String ENV_SCRIPT_NAME

See Also:

• Constant Field Values

ENV_SERVER_NAME

static final String ENV_SERVER_NAME

See Also:

• Constant Field Values

ENV_SERVER_PORT

static final String ENV_SERVER_PORT

See Also:

• Constant Field Values

ENV_SERVER_PROTOCOL

static final String ENV_SERVER_PROTOCOL

See Also:

• Constant Field Values

ENV_SERVER_SOFTWARE

static final String ENV_SERVER_SOFTWARE

See Also:

• Constant Field Values

ENV_SYSTEM_ROOT

static final String ENV_SYSTEM_ROOT

See Also:

• Constant Field Values

RESPONSE_HEADER_CONTENT_TYPE

static final String RESPONSE_HEADER_CONTENT_TYPE

Since:

2.12.0

See Also:

• Constant Field Values

REPSONSE_HEADER_CONTENT_TYPE

@Deprecated
static final String REPSONSE_HEADER_CONTENT_TYPE

Deprecated.

use RESPONSE_HEADER_CONTENT_TYPE instead.

See Also:

• Constant Field Values

RESPONSE_HEADER_CONTENT_LENGTH

static final String RESPONSE_HEADER_CONTENT_LENGTH

See Also:

• Constant Field Values

RESPONSE_HEADER_HTTP_PREFIX

static final String RESPONSE_HEADER_HTTP_PREFIX

See Also:

• Constant Field Values

RESPONSE_HEADER_LOCATION

static final String RESPONSE_HEADER_LOCATION

See Also:

• Constant Field Values

RESPONSE_HEADER_STATUS

static final String RESPONSE_HEADER_STATUS

See Also:

• Constant Field Values

Method Details

execute

void execute(String cmd)
      throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

getBufferSize

int getBufferSize()

getEnvironment

EnvList getEnvironment()

getExceptionHandler

CGIExceptionHandler getExceptionHandler()

Since:

1.8

getInterpreter

String getInterpreter()

getStatusCodeHandler

CGIStatusCodeHandler getStatusCodeHandler()

Since:

1.15

getWorkDirectory

File getWorkDirectory()

isContentLengthWorkaround

boolean isContentLengthWorkaround()

Since:

1.12

isIgnoreExitCode

boolean isIgnoreExitCode()

isPassShellEnvironment

boolean isPassShellEnvironment()

getArgs

default List<String> getArgs()

Returns command args as list.

Since:

2.12.0

setBufferSize

void setBufferSize(int bufferSize)

setContentLengthWorkaround

void setContentLengthWorkaround(boolean contentLengthWorkaround)

Since:

1.12

setEnvironment

void setEnvironment(EnvList environment)

setExceptionHandler

void setExceptionHandler(CGIExceptionHandler exceptionHandler)

Since:

1.8

setIgnoreExitCode

void setIgnoreExitCode(boolean ignoreExitCode)

setInterpreter

void setInterpreter(String interpreter)

setPassShellEnvironment

void setPassShellEnvironment(boolean passShellEnvironment)

setStatusCodeHandler

void setStatusCodeHandler(CGIStatusCodeHandler statusCodeHandler)

Since:

1.15

setWorkDirectory

void setWorkDirectory(File workDirectory)

setArgs

default void setArgs(List<String> args)

Set command arguments.

Parameters:

args - command arguments

Since:

2.12.0