org.seedstack.seed.web.spi

Class ServletDefinition

java.lang.Object

org.seedstack.seed.web.spi.AbstractDefinition

org.seedstack.seed.web.spi.ServletDefinition

public class ServletDefinition
extends AbstractDefinition

This class holds the full definition of a Servlet servlet. It can be returned as a collection element from WebProvider.servlets() to define the servlets that must be registered by Seed.

Constructor Summary

Constructors

Constructor and Description
ServletDefinition(String name, Class<? extends javax.servlet.Servlet> servletClass) Creates a servlet definition with the specified name and class.

Method Summary

Modifier and Type	Method and Description
void	addMappings(String... mappings) Add mappings to this Servlet definition.
int	getLoadOnStartup()
String[]	getMappings()
Class<? extends javax.servlet.Servlet>	getServletClass()
void	setLoadOnStartup(int loadOnStartup) Sets if the Servlet should be loaded on startup.

Methods inherited from class org.seedstack.seed.web.spi.AbstractDefinition

addInitParameters, getInitParameters, getName, isAsyncSupported, setAsyncSupported

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletDefinition

public ServletDefinition(String name,
                         Class<? extends javax.servlet.Servlet> servletClass)

Creates a servlet definition with the specified name and class.

Parameters:

name - the servlet name.

servletClass - the servlet class.

Method Detail

getServletClass

public Class<? extends javax.servlet.Servlet> getServletClass()

Returns:

the Servlet class.

getLoadOnStartup

public int getLoadOnStartup()

Returns:

true if the Servlet should be loaded on startup, false otherwise.

setLoadOnStartup

public void setLoadOnStartup(int loadOnStartup)

Sets if the Servlet should be loaded on startup.

Parameters:

loadOnStartup - true if the Servlet should be loaded on startup, false otherwise.

getMappings

public String[] getMappings()

Returns:

the servlet mappings (URL patterns).

addMappings

public void addMappings(String... mappings)

Add mappings to this Servlet definition.

Parameters:

mappings - the servlet mappings (URL patterns).