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

Class EventListenerModel

java.lang.Object

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

org.ops4j.pax.web.service.spi.model.elements.ElementModel<EventListener,EventListenerEventData>

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

All Implemented Interfaces:

Comparable<ElementModel<EventListener,EventListenerEventData>>

public class EventListenerModel
extends ElementModel<EventListener,EventListenerEventData>

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
EventListenerModel()
EventListenerModel(EventListener eventListener)

Method Summary

Modifier and Type	Method and Description
EventListenerEventData	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.
EventListener	getEventListener()
EventListener	getResolvedListener()
boolean	isDynamic()
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	releaseEventListener()
EventListener	resolveEventListener() Method to be called by actual runtime to obtain an instance of the listener.
void	setDynamic(boolean dynamic)
void	setEventListener(EventListener eventListener)
org.osgi.service.http.runtime.dto.ListenerDTO	toDTO()
org.osgi.service.http.runtime.dto.FailedListenerDTO	toFailedDTO(int dtoFailureCode)
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, getIdPrefix, getNumericId

Methods inherited from class java.lang.Object

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

Constructor Detail

EventListenerModel

public EventListenerModel()

EventListenerModel

public EventListenerModel(EventListener eventListener)

Method Detail

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<EventListener,EventListenerEventData>

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<EventListener,EventListenerEventData>

asEventData

public EventListenerEventData 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<EventListener,EventListenerEventData>

Returns:

getEventListener

public EventListener getEventListener()

setEventListener

public void setEventListener(EventListener eventListener)

setDynamic

public void setDynamic(boolean dynamic)

isDynamic

public boolean isDynamic()

resolveEventListener

public EventListener resolveEventListener()

Method to be called by actual runtime to obtain an instance of the listener. With servlets and filters it is performed by runtime-specific holder classes which control the lifecycle of servlets/filters, but here we do it ourselves, as there's no lifecycle of the listener itself from the point of view of JavaEE Servlets specification.

Returns:

releaseEventListener

public void releaseEventListener()

getResolvedListener

public EventListener getResolvedListener()

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<EventListener,EventListenerEventData>

Returns:

toDTO

public org.osgi.service.http.runtime.dto.ListenerDTO toDTO()

toFailedDTO

public org.osgi.service.http.runtime.dto.FailedListenerDTO toFailedDTO(int dtoFailureCode)

toString

public String toString()

Overrides:

toString in class ElementModel<EventListener,EventListenerEventData>