winstone.cmdline

Class Option<T>

java.lang.Object

winstone.cmdline.Option<T>

Direct Known Subclasses:

Option.OBoolean, Option.OClass, Option.OFile, Option.OInt, Option.OString

public class Option<T>
extends Object

Command line options used in Launcher.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Option.OBoolean
static class	Option.OClass
static class	Option.OFile
static class	Option.OInt
static class	Option.OString

Field Summary

Fields

Modifier and Type	Field and Description
static Option.OBoolean	_DO_HOSTNAME_LOOKUPS
static Option.OInt	_KEEP_ALIVE_TIMEOUT Number of milliseconds for the HTTP keep-alive to hang around until the next request is sent.
static Option.OString	_LISTEN_ADDRESS
static Option.OInt	_PORT
static Option.OClass	ACCESS_LOGGER_CLASSNAME
static Option.OString	AJP13_LISTEN_ADDRESS
static Option.OInt	AJP13_PORT
static Option.OString	ARGUMENTS_REALM_PASSWORD
static Option.OString	ARGUMENTS_REALM_ROLES
static Option.OFile	COMMON_LIB_FOLDER
static Option.OFile	CONFIG
static Option.OInt	CONTROL_PORT
static Option.OBoolean	DEBUG
T	defaultValue
static Option.OBoolean	DIRECTORY_LISTINGS
static Option.OFile	FILEREALM_CONFIGFILE
static Option.OInt	HANDLER_COUNT_MAX How many requests do we handle concurrently? If the system gets really loaded, too many concurrent threads will create vicious cycles and make everyone slow (or worst case choke every request by OOME), so better to err on the conservative side (and have inbound connections wait in the queue)
static Option.OInt	HANDLER_COUNT_MAX_IDLE Leave this number of request handler threads in the pool even when they are idle.
static Option.OInt	HANDLER_COUNT_STARTUP Currently unused.
static Option.OBoolean	HELP
static Option.OBoolean	HTTP_DO_HOSTNAME_LOOKUPS
static Option.OInt	HTTP_KEEP_ALIVE_TIMEOUT
static Option.OString	HTTP_LISTEN_ADDRESS
static Option.OInt	HTTP_PORT
static Option.OFile	HTTPS_CERTIFICATE
static Option.OString	HTTPS_CERTIFICATE_ALIAS
static Option.OBoolean	HTTPS_DO_HOSTNAME_LOOKUPS
static Option.OInt	HTTPS_KEEP_ALIVE_TIMEOUT
static Option.OString	HTTPS_KEY_MANAGER_TYPE
static Option.OFile	HTTPS_KEY_STORE
static Option.OString	HTTPS_KEY_STORE_PASSWORD
static Option.OString	HTTPS_LISTEN_ADDRESS
static Option.OInt	HTTPS_PORT
static Option.OFile	HTTPS_PRIVATE_KEY
static Option.OString	HTTPS_PRIVATE_KEY_PASSWORD
static Option.OBoolean	HTTPS_SPDY
static Option.OBoolean	HTTPS_VERIFY_CLIENT
static Option.OString	INVOKER_PREFIX
static Option.OFile	JAVA_HOME
static Option.OBoolean	LOG_THROWING_LINE_NO
static Option.OBoolean	LOG_THROWING_THREAD
static Option.OFile	LOGFILE
static Option.OInt	MAX_PARAM_COUNT
static Option.OString	MIME_TYPES
String	name Option name without the "--" prefix.
static Option.OClass	PREFERRED_CLASS_LOADER
static Option.OString	PREFIX
static Option.OClass	REALM_CLASS_NAME
static Option.OInt	REQUEST_BUFFER_SIZE
static Option.OInt	REQUEST_HEADER_SIZE
static Option.OInt	SESSION_TIMEOUT
static Option.OString	SIMPLE_ACCESS_LOGGER_FILE
static Option.OString	SIMPLE_ACCESS_LOGGER_FORMAT
static Option.OBoolean	SIMULATE_MOD_UNIQUE_ID
static Option.OFile	TOOLS_JAR
Class<T>	type Expected type.
static Option.OBoolean	USAGE
static Option.OBoolean	USE_INVOKER
static Option.OBoolean	USE_JASPER
static Option.OBoolean	USE_SAVED_SESSIONS
static Option.OBoolean	USE_SERVLET_RELOADING
static Option.OFile	WARFILE
static Option.OFile	WEBAPPS_DIR
static Option.OFile	WEBROOT

Constructor Summary

Constructors

Constructor and Description
Option(String name, Class<T> type, T defaultValue)

Method Summary

Modifier and Type	Method and Description
static List<Option<?>>	all(Class<?> clazz) List up all the known options.
static Option.OBoolean	bool(String name, boolean defaultValue)
static boolean	booleanArg(Map args, String name, boolean defaultTrue)
static Option.OClass	clazz(String name, Class defaultValue)
static Option.OFile	file(String name)
static int	intArg(Map args, String name, int defaultValue)
static Option.OInt	integer(String name)
static Option.OInt	integer(String name, int defaultValue)
boolean	isIn(Map args)
boolean	isWildcard() Indicates an option name that takes some argument.
void	put(Map args, String value)
void	remove(Map args)
static Option.OString	string(String name)
static Option.OString	string(String name, String defaultValue)
static String	stringArg(Map args, String name, String defaultValue)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

WEBROOT

public static final Option.OFile WEBROOT

WARFILE

public static final Option.OFile WARFILE

WEBAPPS_DIR

public static final Option.OFile WEBAPPS_DIR

JAVA_HOME

public static final Option.OFile JAVA_HOME

TOOLS_JAR

public static final Option.OFile TOOLS_JAR

CONFIG

public static final Option.OFile CONFIG

PREFIX

public static final Option.OString PREFIX

COMMON_LIB_FOLDER

public static final Option.OFile COMMON_LIB_FOLDER

LOGFILE

public static final Option.OFile LOGFILE

LOG_THROWING_LINE_NO

public static final Option.OBoolean LOG_THROWING_LINE_NO

LOG_THROWING_THREAD

public static final Option.OBoolean LOG_THROWING_THREAD

DEBUG

public static final Option.OBoolean DEBUG

_PORT

public static final Option.OInt _PORT

_LISTEN_ADDRESS

public static final Option.OString _LISTEN_ADDRESS

_DO_HOSTNAME_LOOKUPS

public static final Option.OBoolean _DO_HOSTNAME_LOOKUPS

_KEEP_ALIVE_TIMEOUT

public static final Option.OInt _KEEP_ALIVE_TIMEOUT

Number of milliseconds for the HTTP keep-alive to hang around until the next request is sent.

HTTP_PORT

public static final Option.OInt HTTP_PORT

HTTP_LISTEN_ADDRESS

public static final Option.OString HTTP_LISTEN_ADDRESS

HTTP_DO_HOSTNAME_LOOKUPS

public static final Option.OBoolean HTTP_DO_HOSTNAME_LOOKUPS

HTTP_KEEP_ALIVE_TIMEOUT

public static final Option.OInt HTTP_KEEP_ALIVE_TIMEOUT

HTTPS_PORT

public static final Option.OInt HTTPS_PORT

HTTPS_LISTEN_ADDRESS

public static final Option.OString HTTPS_LISTEN_ADDRESS

HTTPS_DO_HOSTNAME_LOOKUPS

public static final Option.OBoolean HTTPS_DO_HOSTNAME_LOOKUPS

HTTPS_KEEP_ALIVE_TIMEOUT

public static final Option.OInt HTTPS_KEEP_ALIVE_TIMEOUT

HTTPS_KEY_STORE

public static final Option.OFile HTTPS_KEY_STORE

HTTPS_KEY_STORE_PASSWORD

public static final Option.OString HTTPS_KEY_STORE_PASSWORD

HTTPS_PRIVATE_KEY_PASSWORD

public static final Option.OString HTTPS_PRIVATE_KEY_PASSWORD

HTTPS_KEY_MANAGER_TYPE

public static final Option.OString HTTPS_KEY_MANAGER_TYPE

HTTPS_VERIFY_CLIENT

public static final Option.OBoolean HTTPS_VERIFY_CLIENT

HTTPS_CERTIFICATE

public static final Option.OFile HTTPS_CERTIFICATE

HTTPS_CERTIFICATE_ALIAS

public static final Option.OString HTTPS_CERTIFICATE_ALIAS

HTTPS_PRIVATE_KEY

public static final Option.OFile HTTPS_PRIVATE_KEY

HTTPS_SPDY

public static final Option.OBoolean HTTPS_SPDY

AJP13_PORT

public static final Option.OInt AJP13_PORT

AJP13_LISTEN_ADDRESS

public static final Option.OString AJP13_LISTEN_ADDRESS

CONTROL_PORT

public static final Option.OInt CONTROL_PORT

HANDLER_COUNT_STARTUP

public static final Option.OInt HANDLER_COUNT_STARTUP

Currently unused.

HANDLER_COUNT_MAX

public static final Option.OInt HANDLER_COUNT_MAX

How many requests do we handle concurrently? If the system gets really loaded, too many concurrent threads will create vicious cycles and make everyone slow (or worst case choke every request by OOME), so better to err on the conservative side (and have inbound connections wait in the queue)

HANDLER_COUNT_MAX_IDLE

public static final Option.OInt HANDLER_COUNT_MAX_IDLE

Leave this number of request handler threads in the pool even when they are idle. Other threads are destroyed when they are idle to free up resources.

DIRECTORY_LISTINGS

public static final Option.OBoolean DIRECTORY_LISTINGS

USE_JASPER

public static final Option.OBoolean USE_JASPER

USE_SERVLET_RELOADING

public static final Option.OBoolean USE_SERVLET_RELOADING

PREFERRED_CLASS_LOADER

public static final Option.OClass PREFERRED_CLASS_LOADER

USE_INVOKER

public static final Option.OBoolean USE_INVOKER

INVOKER_PREFIX

public static final Option.OString INVOKER_PREFIX

SIMULATE_MOD_UNIQUE_ID

public static final Option.OBoolean SIMULATE_MOD_UNIQUE_ID

USE_SAVED_SESSIONS

public static final Option.OBoolean USE_SAVED_SESSIONS

MIME_TYPES

public static final Option.OString MIME_TYPES

MAX_PARAM_COUNT

public static final Option.OInt MAX_PARAM_COUNT

USAGE

public static final Option.OBoolean USAGE

SESSION_TIMEOUT

public static final Option.OInt SESSION_TIMEOUT

REQUEST_HEADER_SIZE

public static final Option.OInt REQUEST_HEADER_SIZE

REQUEST_BUFFER_SIZE

public static final Option.OInt REQUEST_BUFFER_SIZE

HELP

public static final Option.OBoolean HELP

REALM_CLASS_NAME

public static final Option.OClass REALM_CLASS_NAME

ARGUMENTS_REALM_PASSWORD

public static final Option.OString ARGUMENTS_REALM_PASSWORD

ARGUMENTS_REALM_ROLES

public static final Option.OString ARGUMENTS_REALM_ROLES

FILEREALM_CONFIGFILE

public static final Option.OFile FILEREALM_CONFIGFILE

ACCESS_LOGGER_CLASSNAME

public static final Option.OClass ACCESS_LOGGER_CLASSNAME

SIMPLE_ACCESS_LOGGER_FORMAT

public static final Option.OString SIMPLE_ACCESS_LOGGER_FORMAT

SIMPLE_ACCESS_LOGGER_FILE

public static final Option.OString SIMPLE_ACCESS_LOGGER_FILE

name

public final String name

Option name without the "--" prefix.

type

public final Class<T> type

Expected type.

defaultValue

public final T defaultValue

Constructor Detail

Option

public Option(String name,
              Class<T> type,
              T defaultValue)

Method Detail

all

public static List<Option<?>> all(Class<?> clazz)

List up all the known options.

remove

public void remove(Map args)

put

public void put(Map args,
                String value)

isIn

public boolean isIn(Map args)

isWildcard

public boolean isWildcard()

Indicates an option name that takes some argument.

toString

public String toString()

Overrides:

toString in class Object

string

public static Option.OString string(String name)

string

public static Option.OString string(String name,
                                    String defaultValue)

bool

public static Option.OBoolean bool(String name,
                                   boolean defaultValue)

file

public static Option.OFile file(String name)

clazz

public static Option.OClass clazz(String name,
                                  Class defaultValue)

integer

public static Option.OInt integer(String name)

integer

public static Option.OInt integer(String name,
                                  int defaultValue)

booleanArg

public static boolean booleanArg(Map args,
                                 String name,
                                 boolean defaultTrue)

stringArg

public static String stringArg(Map args,
                               String name,
                               String defaultValue)

intArg

public static int intArg(Map args,
                         String name,
                         int defaultValue)