ServletContainer (api 0.3.4 API)

java.lang.Object
- org.wildfly.swarm.config.undertow.ServletContainer

public class ServletContainer
extends Object

A servlet container

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ServletContainer.ServletContainerResources
Child mutators for ServletContainer

Nested Classes
Modifier and Type	Class and Description
`class`	`ServletContainer.ServletContainerResources` Child mutators for ServletContainer

Constructor Summary

Constructors
Constructor and Description

ServletContainer(String key)

Constructors
Constructor and Description
`ServletContainer(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`allowNonStandardWrappers()` If true then request and response wrappers that do not extend the standard wrapper classes can be used
`ServletContainer`	`allowNonStandardWrappers(Boolean value)` If true then request and response wrappers that do not extend the standard wrapper classes can be used
`String`	`defaultBufferCache()` The buffer cache to use for caching static resources
`ServletContainer`	`defaultBufferCache(String value)` The buffer cache to use for caching static resources
`String`	`defaultEncoding()` Default encoding to use for all deployed applications
`ServletContainer`	`defaultEncoding(String value)` Default encoding to use for all deployed applications
`Integer`	`defaultSessionTimeout()` The default session timeout (in minutes) for all applications deployed in the container.
`ServletContainer`	`defaultSessionTimeout(Integer value)` The default session timeout (in minutes) for all applications deployed in the container.
`Boolean`	`directoryListing()` If directory listing should be enabled for default servlets.
`ServletContainer`	`directoryListing(Boolean value)` If directory listing should be enabled for default servlets.
`Boolean`	`disableCachingForSecuredPages()` If Undertow should set headers to disable caching for secured paged.
`ServletContainer`	`disableCachingForSecuredPages(Boolean value)` If Undertow should set headers to disable caching for secured paged.
`Boolean`	`eagerFilterInitialization()` If true undertow calls filter init() on deployment start rather than when first requested.
`ServletContainer`	`eagerFilterInitialization(Boolean value)` If true undertow calls filter init() on deployment start rather than when first requested.
`String`	`getKey()`
`Boolean`	`ignoreFlush()` Ignore flushes on the servlet output stream.
`ServletContainer`	`ignoreFlush(Boolean value)` Ignore flushes on the servlet output stream.
`JspSetting`	`jspSetting()` JSP container configuration.
`ServletContainer`	`jspSetting(JspSetting value)` JSP container configuration.
`Integer`	`maxSessions()` The maximum number of sessions that can be active at one time
`ServletContainer`	`maxSessions(Integer value)` The maximum number of sessions that can be active at one time
`ServletContainer`	`mimeMapping(MimeMapping value)` Add the org.wildfly.swarm.config.undertow.servlet_container.MimeMapping object to the list of subresources
`ServletContainer`	`mimeMappings(List<MimeMapping> value)` Add all org.wildfly.swarm.config.undertow.servlet_container.MimeMapping objects to this subresource
`PersistentSessionsSetting`	`persistentSessionsSetting()` Session persistence sessions
`ServletContainer`	`persistentSessionsSetting(PersistentSessionsSetting value)` Session persistence sessions
`Boolean`	`proactiveAuthentication()` If proactive authentication should be used.
`ServletContainer`	`proactiveAuthentication(Boolean value)` If proactive authentication should be used.
`SessionCookieSetting`	`sessionCookieSetting()` Session cookie configuration
`ServletContainer`	`sessionCookieSetting(SessionCookieSetting value)` Session cookie configuration
`Integer`	`sessionIdLength()` The length of the generated session ID.
`ServletContainer`	`sessionIdLength(Integer value)` The length of the generated session ID.
`String`	`stackTraceOnError()` If an error page with the stack trace should be generated on error.
`ServletContainer`	`stackTraceOnError(String value)` If an error page with the stack trace should be generated on error.
`ServletContainer.ServletContainerResources`	`subresources()`
`Boolean`	`useListenerEncoding()` Use encoding defined on listener
`ServletContainer`	`useListenerEncoding(Boolean value)` Use encoding defined on listener
`WebsocketsSetting`	`websocketsSetting()` If websockets are enabled for this container
`ServletContainer`	`websocketsSetting(WebsocketsSetting value)` If websockets are enabled for this container
`ServletContainer`	`welcomeFile(WelcomeFile value)` Add the org.wildfly.swarm.config.undertow.servlet_container.WelcomeFile object to the list of subresources
`ServletContainer`	`welcomeFiles(List<WelcomeFile> value)` Add all org.wildfly.swarm.config.undertow.servlet_container.WelcomeFile objects to this subresource

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServletContainer
```
public ServletContainer(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - allowNonStandardWrappers
```
public Boolean allowNonStandardWrappers()
```
    If true then request and response wrappers that do not extend the standard wrapper classes can be used
  - allowNonStandardWrappers
```
public ServletContainer allowNonStandardWrappers(Boolean value)
```
    If true then request and response wrappers that do not extend the standard wrapper classes can be used
  - defaultBufferCache
```
public String defaultBufferCache()
```
    The buffer cache to use for caching static resources
  - defaultBufferCache
```
public ServletContainer defaultBufferCache(String value)
```
    The buffer cache to use for caching static resources
  - defaultEncoding
```
public String defaultEncoding()
```
    Default encoding to use for all deployed applications
  - defaultEncoding
```
public ServletContainer defaultEncoding(String value)
```
    Default encoding to use for all deployed applications
  - defaultSessionTimeout
```
public Integer defaultSessionTimeout()
```
    The default session timeout (in minutes) for all applications deployed in the container.
  - defaultSessionTimeout
```
public ServletContainer defaultSessionTimeout(Integer value)
```
    The default session timeout (in minutes) for all applications deployed in the container.
  - directoryListing
```
public Boolean directoryListing()
```
    If directory listing should be enabled for default servlets.
  - directoryListing
```
public ServletContainer directoryListing(Boolean value)
```
    If directory listing should be enabled for default servlets.
  - disableCachingForSecuredPages
```
public Boolean disableCachingForSecuredPages()
```
    If Undertow should set headers to disable caching for secured paged. Disabling this can cause security problems, as sensitive pages may be cached by an intermediary.
  - disableCachingForSecuredPages
```
public ServletContainer disableCachingForSecuredPages(Boolean value)
```
    If Undertow should set headers to disable caching for secured paged. Disabling this can cause security problems, as sensitive pages may be cached by an intermediary.
  - eagerFilterInitialization
```
public Boolean eagerFilterInitialization()
```
    If true undertow calls filter init() on deployment start rather than when first requested.
  - eagerFilterInitialization
```
public ServletContainer eagerFilterInitialization(Boolean value)
```
    If true undertow calls filter init() on deployment start rather than when first requested.
  - ignoreFlush
```
public Boolean ignoreFlush()
```
    Ignore flushes on the servlet output stream. In most cases these just hurt performance for no good reason.
  - ignoreFlush
```
public ServletContainer ignoreFlush(Boolean value)
```
    Ignore flushes on the servlet output stream. In most cases these just hurt performance for no good reason.
  - maxSessions
```
public Integer maxSessions()
```
    The maximum number of sessions that can be active at one time
  - maxSessions
```
public ServletContainer maxSessions(Integer value)
```
    The maximum number of sessions that can be active at one time
  - proactiveAuthentication
```
public Boolean proactiveAuthentication()
```
    If proactive authentication should be used. If this is true a user will always be authenticated if credentials are present.
  - proactiveAuthentication
```
public ServletContainer proactiveAuthentication(Boolean value)
```
    If proactive authentication should be used. If this is true a user will always be authenticated if credentials are present.
  - sessionIdLength
```
public Integer sessionIdLength()
```
    The length of the generated session ID. Longer session ID's are more secure.
  - sessionIdLength
```
public ServletContainer sessionIdLength(Integer value)
```
    The length of the generated session ID. Longer session ID's are more secure.
  - stackTraceOnError
```
public String stackTraceOnError()
```
    If an error page with the stack trace should be generated on error. Values are all, none and local-only
  - stackTraceOnError
```
public ServletContainer stackTraceOnError(String value)
```
    If an error page with the stack trace should be generated on error. Values are all, none and local-only
  - useListenerEncoding
```
public Boolean useListenerEncoding()
```
    Use encoding defined on listener
  - useListenerEncoding
```
public ServletContainer useListenerEncoding(Boolean value)
```
    Use encoding defined on listener
  - subresources
```
public ServletContainer.ServletContainerResources subresources()
```
  - mimeMappings
```
public ServletContainer mimeMappings(List<MimeMapping> value)
```
    Add all org.wildfly.swarm.config.undertow.servlet_container.MimeMapping objects to this subresource
    
    Parameters:
    
    value - List of org.wildfly.swarm.config.undertow.servlet_container.MimeMapping objects.
    
    Returns:
    
    this
  - mimeMapping
```
public ServletContainer mimeMapping(MimeMapping value)
```
    Add the org.wildfly.swarm.config.undertow.servlet_container.MimeMapping object to the list of subresources
    
    Parameters:
    
    value - The org.wildfly.swarm.config.undertow.servlet_container.MimeMapping to add
    
    Returns:
    
    this
  - welcomeFiles
```
public ServletContainer welcomeFiles(List<WelcomeFile> value)
```
    Add all org.wildfly.swarm.config.undertow.servlet_container.WelcomeFile objects to this subresource
    
    Parameters:
    
    value - List of org.wildfly.swarm.config.undertow.servlet_container.WelcomeFile objects.
    
    Returns:
    
    this
  - welcomeFile
```
public ServletContainer welcomeFile(WelcomeFile value)
```
    Add the org.wildfly.swarm.config.undertow.servlet_container.WelcomeFile object to the list of subresources
    
    Parameters:
    
    value - The org.wildfly.swarm.config.undertow.servlet_container.WelcomeFile to add
    
    Returns:
    
    this
  - persistentSessionsSetting
```
public PersistentSessionsSetting persistentSessionsSetting()
```
    Session persistence sessions
  - persistentSessionsSetting
```
public ServletContainer persistentSessionsSetting(PersistentSessionsSetting value)
```
    Session persistence sessions
  - jspSetting
```
public JspSetting jspSetting()
```
    JSP container configuration.
  - jspSetting
```
public ServletContainer jspSetting(JspSetting value)
```
    JSP container configuration.
  - websocketsSetting
```
public WebsocketsSetting websocketsSetting()
```
    If websockets are enabled for this container
  - websocketsSetting
```
public ServletContainer websocketsSetting(WebsocketsSetting value)
```
    If websockets are enabled for this container
  - sessionCookieSetting
```
public SessionCookieSetting sessionCookieSetting()
```
    Session cookie configuration
  - sessionCookieSetting
```
public ServletContainer sessionCookieSetting(SessionCookieSetting value)
```
    Session cookie configuration

Class ServletContainer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServletContainer

Method Detail

getKey

allowNonStandardWrappers

allowNonStandardWrappers

defaultBufferCache

defaultBufferCache

defaultEncoding

defaultEncoding

defaultSessionTimeout

defaultSessionTimeout

directoryListing

directoryListing

disableCachingForSecuredPages

disableCachingForSecuredPages

eagerFilterInitialization

eagerFilterInitialization

ignoreFlush

ignoreFlush

maxSessions

maxSessions

proactiveAuthentication

proactiveAuthentication

sessionIdLength

sessionIdLength

stackTraceOnError

stackTraceOnError

useListenerEncoding

useListenerEncoding

subresources

mimeMappings

mimeMapping

welcomeFiles

welcomeFile

persistentSessionsSetting

persistentSessionsSetting

jspSetting

jspSetting

websocketsSetting

websocketsSetting

sessionCookieSetting

sessionCookieSetting