Undertow 2.3.12.Final · io.undertow.servlet.api.ServletInfo

Field Summary

Modifier and Type	Field and Description
private boolean	asyncSupported
private boolean	enabled
private Executor	executor
private final List<HandlerWrapper>	handlerChainWrappers
private final Map<String, String>	initParams
private InstanceFactory<? extends Servlet>	instanceFactory
private String	jspFile
private Integer	loadOnStartup
private final List<String>	mappings
private MultipartConfigElement	multipartConfig
private final String	name
private boolean	requireWelcomeFileMapping If this is true this servlet will not be considered when evaluating welcome file mappings, and if the mapped path is a directory a welcome file match will be performed that may result in another servlet being selected.
private String	runAs
private final List<SecurityRoleRef>	securityRoleRefs
private final Class<? extends Servlet>	servletClass
private ServletSecurityInfo	servletSecurityInfo

Constructor Summary

Access	Constructor and Description
public	ServletInfo(final String name, final Class<? extends Servlet> servletClass)
public	ServletInfo(final String name, final Class<? extends Servlet> servletClass, final InstanceFactory<? extends Servlet> instanceFactory)

Method Summary

Modifier and Type	Method and Description
public ServletInfo	addHandlerChainWrapper(final HandlerWrapper wrapper)
public ServletInfo	addInitParam(final String name, final String value)
public ServletInfo	addMapping(final String mapping)
public ServletInfo	addMappings(final Collection<String> mappings)
public ServletInfo	addMappings(final String... mappings)
public void	addSecurityRoleRef(final String role, final String linkedRole)
public ServletInfo	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public Executor	getExecutor()
public List<HandlerWrapper>	getHandlerChainWrappers()
public Map<String, String>	getInitParams()
public InstanceFactory<? extends Servlet>	getInstanceFactory()
public String	getJspFile()
public Integer	getLoadOnStartup()
public List<String>	getMappings()
public MultipartConfigElement	getMultipartConfig()
public String	getName()
public String	getRunAs()
public List<SecurityRoleRef>	getSecurityRoleRefs()
public Class<? extends Servlet>	getServletClass()
public ServletSecurityInfo	getServletSecurityInfo()
public boolean	isAsyncSupported()
public boolean	isEnabled()
public boolean	isRequireWelcomeFileMapping()
public ServletInfo	setAsyncSupported(final boolean asyncSupported)
public ServletInfo	setEnabled(final boolean enabled)
public ServletInfo	setExecutor(final Executor executor)
public void	setInstanceFactory(final InstanceFactory<? extends Servlet> instanceFactory)
public ServletInfo	setJspFile(final String jspFile)
public ServletInfo	setLoadOnStartup(final Integer loadOnStartup)
public ServletInfo	setMultipartConfig(final MultipartConfigElement multipartConfig)
public ServletInfo	setRequireWelcomeFileMapping(boolean requireWelcomeFileMapping)
public ServletInfo	setRunAs(final String runAs)
public ServletInfo	setServletSecurityInfo(final ServletSecurityInfo servletSecurityInfo)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	validate()

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

asyncSupported	back to summary
private boolean asyncSupported

enabled	back to summary
private boolean enabled

executor	back to summary
private Executor executor

handlerChainWrappers	back to summary
private final List<HandlerWrapper> handlerChainWrappers

initParams	back to summary
private final Map<String, String> initParams

instanceFactory	back to summary
private InstanceFactory<? extends Servlet> instanceFactory

jspFile	back to summary
private String jspFile

loadOnStartup	back to summary
private Integer loadOnStartup

mappings	back to summary
private final List<String> mappings

multipartConfig	back to summary
private MultipartConfigElement multipartConfig

name	back to summary
private final String name

requireWelcomeFileMapping	back to summary
private boolean requireWelcomeFileMapping If this is true this servlet will not be considered when evaluating welcome file mappings, and if the mapped path is a directory a welcome file match will be performed that may result in another servlet being selected. Generally intended to be used by the default and JSP servlet.

runAs	back to summary
private String runAs

securityRoleRefs	back to summary
private final List<SecurityRoleRef> securityRoleRefs

servletClass	back to summary
private final Class<? extends Servlet> servletClass

servletSecurityInfo	back to summary
private ServletSecurityInfo servletSecurityInfo

Constructor Detail

ServletInfo	back to summary
public ServletInfo(final String name, final Class<? extends Servlet> servletClass)

ServletInfo	back to summary
public ServletInfo(final String name, final Class<? extends Servlet> servletClass, final InstanceFactory<? extends Servlet> instanceFactory)

Method Detail

addHandlerChainWrapper	back to summary
public ServletInfo addHandlerChainWrapper(final HandlerWrapper wrapper)

addInitParam	back to summary
public ServletInfo addInitParam(final String name, final String value)

addMapping	back to summary
public ServletInfo addMapping(final String mapping)

addMappings	back to summary
public ServletInfo addMappings(final Collection<String> mappings)

addMappings	back to summary
public ServletInfo addMappings(final String... mappings)

addSecurityRoleRef	back to summary
public void addSecurityRoleRef(final String role, final String linkedRole)

clone back to summary

clone	back to summary
public ServletInfo clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:ServletInfo a clone of this instance. Annotations @Override

public ServletInfo clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:ServletInfo

a clone of this instance.

Annotations

@Override

getExecutor	back to summary
public Executor getExecutor()

getHandlerChainWrappers	back to summary
public List<HandlerWrapper> getHandlerChainWrappers()

getInitParams	back to summary
public Map<String, String> getInitParams()

getInstanceFactory	back to summary
public InstanceFactory<? extends Servlet> getInstanceFactory()

getJspFile	back to summary
public String getJspFile()

getLoadOnStartup	back to summary
public Integer getLoadOnStartup()

getMappings	back to summary
public List<String> getMappings()

getMultipartConfig	back to summary
public MultipartConfigElement getMultipartConfig()

getName	back to summary
public String getName()

getRunAs	back to summary
public String getRunAs()

getSecurityRoleRefs	back to summary
public List<SecurityRoleRef> getSecurityRoleRefs()

getServletClass	back to summary
public Class<? extends Servlet> getServletClass()

getServletSecurityInfo	back to summary
public ServletSecurityInfo getServletSecurityInfo()

isAsyncSupported	back to summary
public boolean isAsyncSupported()

isEnabled	back to summary
public boolean isEnabled()

isRequireWelcomeFileMapping	back to summary
public boolean isRequireWelcomeFileMapping()

setAsyncSupported	back to summary
public ServletInfo setAsyncSupported(final boolean asyncSupported)

setEnabled	back to summary
public ServletInfo setEnabled(final boolean enabled)

setExecutor	back to summary
public ServletInfo setExecutor(final Executor executor)

setInstanceFactory	back to summary
public void setInstanceFactory(final InstanceFactory<? extends Servlet> instanceFactory)

setJspFile	back to summary
public ServletInfo setJspFile(final String jspFile)

setLoadOnStartup	back to summary
public ServletInfo setLoadOnStartup(final Integer loadOnStartup)

setMultipartConfig	back to summary
public ServletInfo setMultipartConfig(final MultipartConfigElement multipartConfig)

setRequireWelcomeFileMapping	back to summary
public ServletInfo setRequireWelcomeFileMapping(boolean requireWelcomeFileMapping)

setRunAs	back to summary
public ServletInfo setRunAs(final String runAs)

setServletSecurityInfo	back to summary
public ServletInfo setServletSecurityInfo(final ServletSecurityInfo servletSecurityInfo)

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object