Package rife.config

Class RifeConfig.EngineConfig

java.lang.Object

rife.config.RifeConfig.EngineConfig

Enclosing class:

RifeConfig

public class RifeConfig.EngineConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DEFAULT_CONTINUATION_DURATION	The default duration is 20 minutes.
static final int	DEFAULT_CONTINUATION_PURGE_FREQUENCY	The default frequency is every 20 times out of the scale, with the default scale of 1000 this means, 1/50th of the time.
static final int	DEFAULT_CONTINUATION_PURGE_SCALE	The default purge scale is 1000.
static final String	DEFAULT_CSRF_COOKIE_NAME
static final String	DEFAULT_CSRF_HEADER_NAME
static final String	DEFAULT_CSRF_PARAMETER_NAME
static final String	DEFAULT_DEFAULT_CONTENT_TYPE
static final String	DEFAULT_FILE_UPLOAD_PATH
static final String	DEFAULT_FILE_UPLOAD_RIFE_FOLDER
static final boolean	DEFAULT_FILE_UPLOAD_SIZE_CHECK
static final boolean	DEFAULT_FILE_UPLOAD_SIZE_EXCEPTION
static final long	DEFAULT_FILE_UPLOAD_SIZE_LIMIT
static final boolean	DEFAULT_GLOBAL_NO_CACHE_HEADERS
static final boolean	DEFAULT_GZIP_COMPRESSION
static final Collection<String>	DEFAULT_GZIP_COMPRESSION_TYPES
static final boolean	DEFAULT_LOG_ENGINE_EXCEPTIONS
static final Set<String>	DEFAULT_PASS_THROUGH_SUFFIXES
static final boolean	DEFAULT_PRETTY_ENGINE_EXCEPTIONS
static final String	DEFAULT_PROXY_ROOT_URL
static final Charset	DEFAULT_REQUEST_ENCODING
static final Charset	DEFAULT_RESPONSE_ENCODING
static final String	DEFAULT_WEBAPP_CONTEXT_PATH

Constructor Summary

Constructors

Constructor	Description
EngineConfig()

Method Summary

Modifier and Type	Method	Description
long	getContinuationDuration()
int	getContinuationPurgeFrequency()
int	getContinuationPurgeScale()
String	getCsrfCookieName()	Retrieves the name of the cookie that holds the CSRF token.
String	getCsrfHeaderName()	Retrieves the name of the request header that submits the CSRF token.
String	getCsrfParameterName()	Retrieves the name of the request parameter that submits the CSRF token.
String	getDefaultContentType()
String	getFileUploadPath()
boolean	getFileUploadSizeCheck()
boolean	getFileUploadSizeException()
long	getFileUploadSizeLimit()
boolean	getGlobalNoCacheHeaders()
boolean	getGzipCompression()
Collection<String>	getGzipCompressionTypes()
boolean	getLogEngineExceptions()
Set<String>	getPassThroughSuffixes()
boolean	getPrettyEngineExceptions()
String	getProxyRootUrl()
Charset	getRequestEncoding()
Charset	getResponseEncoding()
String	getWebappContextPath()
RifeConfig.EngineConfig	setContinuationDuration(long duration)
RifeConfig.EngineConfig	setContinuationPurgeFrequency(int frequency)
RifeConfig.EngineConfig	setContinuationPurgeScale(int frequency)
RifeConfig.EngineConfig	setCsrfCookieName(String name)
RifeConfig.EngineConfig	setCsrfHeaderName(String name)
RifeConfig.EngineConfig	setCsrfParameterName(String name)
RifeConfig.EngineConfig	setDefaultContentType(String type)
RifeConfig.EngineConfig	setFileUploadPath(String path)
RifeConfig.EngineConfig	setFileUploadSizeCheck(boolean flag)
RifeConfig.EngineConfig	setFileUploadSizeException(boolean flag)
RifeConfig.EngineConfig	setFileUploadSizeLimit(long limit)
RifeConfig.EngineConfig	setGlobalNoCacheHeaders(boolean flag)
RifeConfig.EngineConfig	setGzipCompression(boolean flag)
RifeConfig.EngineConfig	setGzipCompressionTypes(Collection<String> types)
RifeConfig.EngineConfig	setLogEngineExceptions(boolean flag)
RifeConfig.EngineConfig	setPassThroughSuffixes(Set<String> suffixes)
RifeConfig.EngineConfig	setPrettyEngineExceptions(boolean flag)
RifeConfig.EngineConfig	setProxyRootUrl(String url)
RifeConfig.EngineConfig	setRequestEncoding(Charset encoding)
RifeConfig.EngineConfig	setResponseEncoding(Charset encoding)
RifeConfig.EngineConfig	setWebappContextPath(String path)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CONTINUATION_DURATION

public static final long DEFAULT_CONTINUATION_DURATION

The default duration is 20 minutes.

Since:

1.0

See Also:

• Constant Field Values

DEFAULT_CONTINUATION_PURGE_FREQUENCY

public static final int DEFAULT_CONTINUATION_PURGE_FREQUENCY

The default frequency is every 20 times out of the scale, with the default scale of 1000 this means, 1/50th of the time.

Since:

1.0

See Also:

• Constant Field Values

DEFAULT_CONTINUATION_PURGE_SCALE

public static final int DEFAULT_CONTINUATION_PURGE_SCALE

The default purge scale is 1000.

Since:

1.0

See Also:

• Constant Field Values

DEFAULT_DEFAULT_CONTENT_TYPE

public static final String DEFAULT_DEFAULT_CONTENT_TYPE

See Also:

• Constant Field Values

DEFAULT_PRETTY_ENGINE_EXCEPTIONS

public static final boolean DEFAULT_PRETTY_ENGINE_EXCEPTIONS

See Also:

• Constant Field Values

DEFAULT_LOG_ENGINE_EXCEPTIONS

public static final boolean DEFAULT_LOG_ENGINE_EXCEPTIONS

See Also:

• Constant Field Values

DEFAULT_FILE_UPLOAD_PATH

public static final String DEFAULT_FILE_UPLOAD_PATH

DEFAULT_FILE_UPLOAD_RIFE_FOLDER

public static final String DEFAULT_FILE_UPLOAD_RIFE_FOLDER

See Also:

• Constant Field Values

DEFAULT_FILE_UPLOAD_SIZE_LIMIT

public static final long DEFAULT_FILE_UPLOAD_SIZE_LIMIT

See Also:

• Constant Field Values

DEFAULT_FILE_UPLOAD_SIZE_CHECK

public static final boolean DEFAULT_FILE_UPLOAD_SIZE_CHECK

See Also:

• Constant Field Values

DEFAULT_FILE_UPLOAD_SIZE_EXCEPTION

public static final boolean DEFAULT_FILE_UPLOAD_SIZE_EXCEPTION

See Also:

• Constant Field Values

DEFAULT_GLOBAL_NO_CACHE_HEADERS

public static final boolean DEFAULT_GLOBAL_NO_CACHE_HEADERS

See Also:

• Constant Field Values

DEFAULT_CSRF_COOKIE_NAME

public static final String DEFAULT_CSRF_COOKIE_NAME

See Also:

• Constant Field Values

DEFAULT_CSRF_PARAMETER_NAME

public static final String DEFAULT_CSRF_PARAMETER_NAME

See Also:

• Constant Field Values

DEFAULT_CSRF_HEADER_NAME

public static final String DEFAULT_CSRF_HEADER_NAME

See Also:

• Constant Field Values

DEFAULT_GZIP_COMPRESSION

public static final boolean DEFAULT_GZIP_COMPRESSION

See Also:

• Constant Field Values

DEFAULT_GZIP_COMPRESSION_TYPES

public static final Collection<String> DEFAULT_GZIP_COMPRESSION_TYPES

DEFAULT_PROXY_ROOT_URL

public static final String DEFAULT_PROXY_ROOT_URL

DEFAULT_WEBAPP_CONTEXT_PATH

public static final String DEFAULT_WEBAPP_CONTEXT_PATH

DEFAULT_PASS_THROUGH_SUFFIXES

public static final Set<String> DEFAULT_PASS_THROUGH_SUFFIXES

DEFAULT_REQUEST_ENCODING

public static final Charset DEFAULT_REQUEST_ENCODING

DEFAULT_RESPONSE_ENCODING

public static final Charset DEFAULT_RESPONSE_ENCODING

Constructor Details

EngineConfig

public EngineConfig()

Method Details

getDefaultContentType

public String getDefaultContentType()

setDefaultContentType

public RifeConfig.EngineConfig setDefaultContentType(String type)

getCsrfCookieName

public String getCsrfCookieName()

Retrieves the name of the cookie that holds the CSRF token.

This defaults to DEFAULT_CSRF_COOKIE_NAME.

Returns:

the name of the CSRF token cookie

Since:

1.10

See Also:

• setCsrfCookieName(String)

setCsrfCookieName

public RifeConfig.EngineConfig setCsrfCookieName(String name)

getCsrfParameterName

public String getCsrfParameterName()

Retrieves the name of the request parameter that submits the CSRF token.

This defaults to DEFAULT_CSRF_PARAMETER_NAME.

Returns:

the name of the CSRF token parameter

Since:

1.10

See Also:

• setCsrfParameterName(String)

setCsrfParameterName

public RifeConfig.EngineConfig setCsrfParameterName(String name)

getCsrfHeaderName

public String getCsrfHeaderName()

Retrieves the name of the request header that submits the CSRF token.

This defaults to DEFAULT_CSRF_HEADER_NAME.

Returns:

the name of the CSRF token header

Since:

1.10

See Also:

• setCsrfHeaderName(String)

setCsrfHeaderName

public RifeConfig.EngineConfig setCsrfHeaderName(String name)

getPrettyEngineExceptions

public boolean getPrettyEngineExceptions()

setPrettyEngineExceptions

public RifeConfig.EngineConfig setPrettyEngineExceptions(boolean flag)

getLogEngineExceptions

public boolean getLogEngineExceptions()

setLogEngineExceptions

public RifeConfig.EngineConfig setLogEngineExceptions(boolean flag)

getFileUploadPath

public String getFileUploadPath()

setFileUploadPath

public RifeConfig.EngineConfig setFileUploadPath(String path)

getFileUploadSizeLimit

public long getFileUploadSizeLimit()

setFileUploadSizeLimit

public RifeConfig.EngineConfig setFileUploadSizeLimit(long limit)

getFileUploadSizeCheck

public boolean getFileUploadSizeCheck()

setFileUploadSizeCheck

public RifeConfig.EngineConfig setFileUploadSizeCheck(boolean flag)

getFileUploadSizeException

public boolean getFileUploadSizeException()

setFileUploadSizeException

public RifeConfig.EngineConfig setFileUploadSizeException(boolean flag)

getContinuationDuration

public long getContinuationDuration()

setContinuationDuration

public RifeConfig.EngineConfig setContinuationDuration(long duration)

getContinuationPurgeFrequency

public int getContinuationPurgeFrequency()

setContinuationPurgeFrequency

public RifeConfig.EngineConfig setContinuationPurgeFrequency(int frequency)

getContinuationPurgeScale

public int getContinuationPurgeScale()

setContinuationPurgeScale

public RifeConfig.EngineConfig setContinuationPurgeScale(int frequency)

getGlobalNoCacheHeaders

public boolean getGlobalNoCacheHeaders()

setGlobalNoCacheHeaders

public RifeConfig.EngineConfig setGlobalNoCacheHeaders(boolean flag)

getGzipCompression

public boolean getGzipCompression()

setGzipCompression

public RifeConfig.EngineConfig setGzipCompression(boolean flag)

getGzipCompressionTypes

public Collection<String> getGzipCompressionTypes()

setGzipCompressionTypes

public RifeConfig.EngineConfig setGzipCompressionTypes(Collection<String> types)

getProxyRootUrl

public String getProxyRootUrl()

setProxyRootUrl

public RifeConfig.EngineConfig setProxyRootUrl(String url)

getWebappContextPath

public String getWebappContextPath()

setWebappContextPath

public RifeConfig.EngineConfig setWebappContextPath(String path)

getPassThroughSuffixes

public Set<String> getPassThroughSuffixes()

setPassThroughSuffixes

public RifeConfig.EngineConfig setPassThroughSuffixes(Set<String> suffixes)

getRequestEncoding

public Charset getRequestEncoding()

setRequestEncoding

public RifeConfig.EngineConfig setRequestEncoding(Charset encoding)

getResponseEncoding

public Charset getResponseEncoding()

setResponseEncoding

public RifeConfig.EngineConfig setResponseEncoding(Charset encoding)