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

Class ContainerInitializerModel

java.lang.Object

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

org.ops4j.pax.web.service.spi.model.elements.ElementModel<javax.servlet.ServletContainerInitializer,ContainerInitializerEventData>

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

All Implemented Interfaces:

Comparable<ElementModel<javax.servlet.ServletContainerInitializer,ContainerInitializerEventData>>

public class ContainerInitializerModel
extends ElementModel<javax.servlet.ServletContainerInitializer,ContainerInitializerEventData>

Model for ServletContainerInitializer. It'll never (at least for now) be registered through Whiteboard, so we don't have to pay attention to OSGi service references. And we will never (for now) be able to register single SCI into multiple OsgiServletContext instances. Only one - the one associated with a bundle to which an instance of WebContainer is scoped.

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
ContainerInitializerModel(javax.servlet.ServletContainerInitializer containerInitializer, Class<?>[] classes)

Method Summary

Modifier and Type	Method and Description
ContainerInitializerEventData	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.
Set<Class<?>>	getClasses()
javax.servlet.ServletContainerInitializer	getContainerInitializer()
protected String	getIdPrefix()
List<ServletModel>	getRelatedServletModels()
List<WebSocketModel>	getRelatedWebSocketModels()
boolean	isForAnyRuntime()
boolean	isForJetty()
boolean	isForTomcat()
boolean	isForUndertow()
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	setForAnyRuntime(boolean forAnyRuntime)
void	setForJetty(boolean forJetty)
void	setForTomcat(boolean forTomcat)
void	setForUndertow(boolean forUndertow)
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, compareTo, 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, getNumericId

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerInitializerModel

public ContainerInitializerModel(javax.servlet.ServletContainerInitializer containerInitializer,
                                 Class<?>[] classes)

Method Detail

getIdPrefix

protected String getIdPrefix()

Overrides:

getIdPrefix in class Identity

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.ServletContainerInitializer,ContainerInitializerEventData>

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.ServletContainerInitializer,ContainerInitializerEventData>

asEventData

public ContainerInitializerEventData 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.ServletContainerInitializer,ContainerInitializerEventData>

Returns:

getContainerInitializer

public javax.servlet.ServletContainerInitializer getContainerInitializer()

getClasses

public Set<Class<?>> getClasses()

Returns:

the classes

performValidation

public Boolean performValidation()

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.ServletContainerInitializer,ContainerInitializerEventData>

Returns:

getRelatedWebSocketModels

public List<WebSocketModel> getRelatedWebSocketModels()

getRelatedServletModels

public List<ServletModel> getRelatedServletModels()

isForJetty

public boolean isForJetty()

setForJetty

public void setForJetty(boolean forJetty)

isForTomcat

public boolean isForTomcat()

setForTomcat

public void setForTomcat(boolean forTomcat)

isForUndertow

public boolean isForUndertow()

setForUndertow

public void setForUndertow(boolean forUndertow)

isForAnyRuntime

public boolean isForAnyRuntime()

setForAnyRuntime

public void setForAnyRuntime(boolean forAnyRuntime)

toString

public String toString()

Overrides:

toString in class ElementModel<javax.servlet.ServletContainerInitializer,ContainerInitializerEventData>