org.ops4j.pax.web.service.spi.model.elements

Class ServletModel

java.lang.Object

org.ops4j.pax.web.service.spi.model.Identity

org.ops4j.pax.web.service.spi.model.elements.ElementModel<javax.servlet.Servlet,ServletEventData>

org.ops4j.pax.web.service.spi.model.elements.ServletModel

All Implemented Interfaces:

Comparable<ElementModel<javax.servlet.Servlet,ServletEventData>>

public class ServletModel
extends ElementModel<javax.servlet.Servlet,ServletEventData>

Set of parameters describing everything that's required to register a Servlet.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServletModel.Builder

Field Summary

Fields inherited from class org.ops4j.pax.web.service.spi.model.elements.ElementModel

contextModels, contextModelsInfo, dtoFailureCode, isValid

Constructor Summary

Constructors

Constructor and Description
ServletModel(String[] urlPatterns, Class<? extends javax.servlet.Servlet> servletClass, Dictionary<String,String> initParams, Integer loadOnStartup, Boolean asyncSupported, javax.servlet.MultipartConfigElement multiPartConfig)
ServletModel(String alias, javax.servlet.Servlet servlet, Dictionary<?,?> initParams, Integer loadOnStartup, Boolean asyncSupported)
ServletModel(String servletName, String[] urlPatterns, javax.servlet.Servlet servlet, Dictionary<String,String> initParams, Integer loadOnStartup, Boolean asyncSupported, javax.servlet.MultipartConfigElement multiPartConfig)
ServletModel(String alias, String servletName, javax.servlet.Servlet servlet, Class<? extends javax.servlet.Servlet> servletClass, org.osgi.framework.ServiceReference<javax.servlet.Servlet> reference) Constructor used for servlet unregistration

Method Summary

Modifier and Type	Method and Description
ServletEventData	asEventData() When sending events related to ElementModel we can't use the same instance which is kept in ServerModel, we have to copy relevant information to lightweight object.
int	compareTo(ElementModel<javax.servlet.Servlet,ServletEventData> o) Returns negative value if this element is "lesser" than the argument, which means it should have higher priority.
void	configureJspServlet(JspConfiguration config) Special configuration just before registration of the ServletModel if it's a JSP servlet
Class<? extends javax.servlet.Servlet>	getActualClass() Returns a Class of the servlet whether it is registered as instance, class or reference.
String	getAlias()
Boolean	getAsyncSupported()
URL	getBaseFileUrl()
String	getBasePath()
ErrorPageModel	getErrorPageModel()
static URL	getFileUrlIfAccessible(String base) Returns URL if and only if the base is proper file: based absolute url.
Map<String,String>	getInitParams()
Integer	getLoadOnStartup()
javax.servlet.MultipartConfigElement	getMultipartConfigElement()
String	getName()
String	getRawPath()
Map<String,String>	getRoleLinks()
String	getRunAs()
javax.servlet.Servlet	getServlet()
Class<? extends javax.servlet.Servlet>	getServletClass()
String[]	getUrlPatterns()
boolean	isDynamic()
boolean	isJspServlet()
boolean	isOverridable()
boolean	isResourceServlet()
boolean	isServletSecurityPresent()
Boolean	performValidation() Perform element-specific validation and throws different exceptions for all element-specific validation problems.
void	register(WhiteboardWebContainerView view) Each ElementModel can register itself as Whiteboard element.
void	setAsyncSupported(Boolean asyncSupported)
void	setBaseFileUrl(URL baseFileUrl)
void	setBasePath(String basePath)
void	setDynamic(boolean dynamic)
void	setJspFile(String jspFile)
void	setJspServlet(boolean jspServlet)
void	setLoadOnStartup(Integer loadOnStartup)
void	setMultipartConfigElement(javax.servlet.MultipartConfigElement multipartConfigElement)
void	setName(String name)
void	setRawPath(String rawPath)
void	setRunAs(String runAs)
void	setServlet(javax.servlet.Servlet servlet)
void	setServletSecurityPresent(boolean servletSecurityPresent)
void	setUrlPatterns(String[] urlPatterns)
org.osgi.service.http.runtime.dto.FailedResourceDTO	toFailedResourceDTO(int dtoFailureCode)
org.osgi.service.http.runtime.dto.FailedServletDTO	toFailedServletDTO(int dtoFailureCode)
org.osgi.service.http.runtime.dto.ResourceDTO	toResourceDTO()
org.osgi.service.http.runtime.dto.ServletDTO	toServletDTO()
String	toString()
void	unregister(WhiteboardWebContainerView view) Each ElementModel can unregister itself as Whiteboard element.

Methods inherited from class org.ops4j.pax.web.service.spi.model.elements.ElementModel

addContextModel, changeContextModels, equals, getContextFilter, getContextModels, getContextModelsInfo, getContextSelector, getDtoFailureCode, getElementReference, getElementSupplier, getRegisteringBundle, getServiceId, getServiceRank, getTimestamp, hasContextModels, hashCode, isAsynchronusRegistration, isPrototype, isValid, resetContextModels, setAsynchronusRegistration, setCommonEventProperties, setContextSelectFilter, setContextSelector, setDtoFailureCode, setElementReference, setElementSupplier, setRegisteringBundle, setServiceId, setServiceRank, setTimestamp

Methods inherited from class org.ops4j.pax.web.service.spi.model.Identity

getId, getIdPrefix, getNumericId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ServletModel

public ServletModel(String alias,
                    String servletName,
                    javax.servlet.Servlet servlet,
                    Class<? extends javax.servlet.Servlet> servletClass,
                    org.osgi.framework.ServiceReference<javax.servlet.Servlet> reference)

Constructor used for servlet unregistration

Parameters:

alias -

servletName -

servlet -

servletClass -

reference -

ServletModel

public ServletModel(String alias,
                    javax.servlet.Servlet servlet,
                    Dictionary<?,?> initParams,
                    Integer loadOnStartup,
                    Boolean asyncSupported)

ServletModel

public ServletModel(String servletName,
                    String[] urlPatterns,
                    javax.servlet.Servlet servlet,
                    Dictionary<String,String> initParams,
                    Integer loadOnStartup,
                    Boolean asyncSupported,
                    javax.servlet.MultipartConfigElement multiPartConfig)

ServletModel

public ServletModel(String[] urlPatterns,
                    Class<? extends javax.servlet.Servlet> servletClass,
                    Dictionary<String,String> initParams,
                    Integer loadOnStartup,
                    Boolean asyncSupported,
                    javax.servlet.MultipartConfigElement multiPartConfig)

Method Detail

performValidation

public Boolean performValidation()
                          throws Exception

Description copied from class: ElementModel

Perform element-specific validation and throws different exceptions for all element-specific validation problems. This method should not be called for Whiteboard purposes, where "failure DTO" has to be configured.

This method should be called in Http Service scenario where we immediately need strong feedback - with exceptions thrown for all validation problems. In Whiteboard scenario, the exception is caught, logged and it's the tracker that prevents further registration.

This method may alter the state of the model when (which is possible during validation) some extra information is obtained/compiled/processed.

Specified by:

performValidation in class ElementModel<javax.servlet.Servlet,ServletEventData>

Returns:

Throws:

Exception

getFileUrlIfAccessible

public static URL getFileUrlIfAccessible(String base)

Returns URL if and only if the base is proper file: based absolute url.

Parameters:

base -

Returns:

register

public void register(WhiteboardWebContainerView view)

Description copied from class: ElementModel

Each ElementModel can register itself as Whiteboard element.

Specified by:

register in class ElementModel<javax.servlet.Servlet,ServletEventData>

unregister

public void unregister(WhiteboardWebContainerView view)

Description copied from class: ElementModel

Each ElementModel can unregister itself as Whiteboard element.

Specified by:

unregister in class ElementModel<javax.servlet.Servlet,ServletEventData>

asEventData

public ServletEventData asEventData()

Description copied from class: ElementModel

When sending events related to ElementModel we can't use the same instance which is kept in ServerModel, we have to copy relevant information to lightweight object.

Specified by:

asEventData in class ElementModel<javax.servlet.Servlet,ServletEventData>

Returns:

compareTo

public int compareTo(ElementModel<javax.servlet.Servlet,ServletEventData> o)

Description copied from class: ElementModel

Returns negative value if this element is "lesser" than the argument, which means it should have higher priority.

Specified by:

compareTo in interface Comparable<ElementModel<javax.servlet.Servlet,ServletEventData>>

Overrides:

compareTo in class ElementModel<javax.servlet.Servlet,ServletEventData>

getAlias

public String getAlias()

getUrlPatterns

public String[] getUrlPatterns()

setUrlPatterns

public void setUrlPatterns(String[] urlPatterns)

getName

public String getName()

setName

public void setName(String name)

getInitParams

public Map<String,String> getInitParams()

getLoadOnStartup

public Integer getLoadOnStartup()

setLoadOnStartup

public void setLoadOnStartup(Integer loadOnStartup)

getAsyncSupported

public Boolean getAsyncSupported()

setAsyncSupported

public void setAsyncSupported(Boolean asyncSupported)

getMultipartConfigElement

public javax.servlet.MultipartConfigElement getMultipartConfigElement()

setMultipartConfigElement

public void setMultipartConfigElement(javax.servlet.MultipartConfigElement multipartConfigElement)

getServlet

public javax.servlet.Servlet getServlet()

setServlet

public void setServlet(javax.servlet.Servlet servlet)

getServletClass

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

getActualClass

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

Returns a Class of the servlet whether it is registered as instance, class or reference.

Returns:

isResourceServlet

public boolean isResourceServlet()

isJspServlet

public boolean isJspServlet()

setJspServlet

public void setJspServlet(boolean jspServlet)

setJspFile

public void setJspFile(String jspFile)

isOverridable

public boolean isOverridable()

getBasePath

public String getBasePath()

setBasePath

public void setBasePath(String basePath)

setBaseFileUrl

public void setBaseFileUrl(URL baseFileUrl)

getBaseFileUrl

public URL getBaseFileUrl()

getRawPath

public String getRawPath()

setRawPath

public void setRawPath(String rawPath)

getErrorPageModel

public ErrorPageModel getErrorPageModel()

setDynamic

public void setDynamic(boolean dynamic)

isDynamic

public boolean isDynamic()

getRunAs

public String getRunAs()

setRunAs

public void setRunAs(String runAs)

getRoleLinks

public Map<String,String> getRoleLinks()

setServletSecurityPresent

public void setServletSecurityPresent(boolean servletSecurityPresent)

isServletSecurityPresent

public boolean isServletSecurityPresent()

configureJspServlet

public void configureJspServlet(JspConfiguration config)

Special configuration just before registration of the ServletModel if it's a JSP servlet

Parameters:

config -

toResourceDTO

public org.osgi.service.http.runtime.dto.ResourceDTO toResourceDTO()

toFailedResourceDTO

public org.osgi.service.http.runtime.dto.FailedResourceDTO toFailedResourceDTO(int dtoFailureCode)

toServletDTO

public org.osgi.service.http.runtime.dto.ServletDTO toServletDTO()

toFailedServletDTO

public org.osgi.service.http.runtime.dto.FailedServletDTO toFailedServletDTO(int dtoFailureCode)

toString

public String toString()

Overrides:

toString in class ElementModel<javax.servlet.Servlet,ServletEventData>