Module cloud.piranha.webapp.api

Package cloud.piranha.webapp.api

Interface ServletEnvironment

All Superinterfaces:

Registration, Registration.Dynamic, ServletConfig, ServletRegistration, ServletRegistration.Dynamic

All Known Implementing Classes:

DefaultServletEnvironment

public interface ServletEnvironment
extends ServletRegistration.Dynamic, ServletConfig

Nested Class Summary

Nested classes/interfaces inherited from interface javax.servlet.Registration

Registration.Dynamic

Nested classes/interfaces inherited from interface javax.servlet.ServletRegistration

ServletRegistration.Dynamic

Field Summary

Fields

Modifier and Type	Field	Description
static int	UNAVAILABLE	Defines the UNAVAILABLE constant.

Method Summary

Modifier and Type	Method	Description
int	getLoadOnStartup()	Get the load on startup.
MultipartConfigElement	getMultipartConfig()	Get the multi-part config.
Servlet	getServlet()	Get the servlet.
java.lang.Class<? extends Servlet>	getServletClass()	Get the servlet class.
int	getStatus()	Get the status.
java.lang.Throwable	getUnavailableException()	The exception that caused this servlet to become unavailable
WebApplication	getWebApplication()	Get the web application.
boolean	isAsyncSupported()	Is async supported.
void	setClassName(java.lang.String className)	Set the class name.
void	setServlet(Servlet servlet)	Set the servlet.
void	setStatus(int status)	Set the status.
void	setUnavailableException(java.lang.Throwable unavailableException)	Sets the exception that caused this servlet to become unavailable

Methods inherited from interface javax.servlet.Registration

getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters

Methods inherited from interface javax.servlet.Registration.Dynamic

setAsyncSupported

Methods inherited from interface javax.servlet.ServletConfig

getInitParameter, getInitParameterNames, getServletContext, getServletName

Methods inherited from interface javax.servlet.ServletRegistration

addMapping, getMappings, getRunAsRole

Methods inherited from interface javax.servlet.ServletRegistration.Dynamic

setLoadOnStartup, setMultipartConfig, setRunAsRole, setServletSecurity

Field Details

UNAVAILABLE

static final int UNAVAILABLE

Defines the UNAVAILABLE constant.

See Also:

Constant Field Values

Method Details

getLoadOnStartup

int getLoadOnStartup()

Get the load on startup.

Returns:

the load on startup.

getMultipartConfig

MultipartConfigElement getMultipartConfig()

Get the multi-part config.

Returns:

the multi-part config.

getServlet

Servlet getServlet()

Get the servlet.

Returns:

the servlet.

getServletClass

java.lang.Class<? extends Servlet> getServletClass()

Get the servlet class.

Returns:

the servlet class.

getStatus

int getStatus()

Get the status.

Returns:

the status.

getWebApplication

WebApplication getWebApplication()

Get the web application.

Returns:

the web application.

isAsyncSupported

boolean isAsyncSupported()

Is async supported.

Returns:

true if it is, false otherwise.

setClassName

void setClassName(java.lang.String className)

Set the class name.

Parameters:

className - the class name.

setServlet

void setServlet(Servlet servlet)

Set the servlet.

Parameters:

servlet - the servlet.

setStatus

void setStatus(int status)

Set the status.

Parameters:

status - the status.

getUnavailableException

java.lang.Throwable getUnavailableException()

The exception that caused this servlet to become unavailable

Returns:

the exception.

setUnavailableException

void setUnavailableException(java.lang.Throwable unavailableException)

Sets the exception that caused this servlet to become unavailable