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

Class ErrorPageModel

java.lang.Object

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

org.ops4j.pax.web.service.spi.model.elements.ElementModel<org.ops4j.pax.web.service.whiteboard.ErrorPageMapping,ErrorPageEventData>

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

All Implemented Interfaces:

Comparable<ElementModel<org.ops4j.pax.web.service.whiteboard.ErrorPageMapping,ErrorPageEventData>>

public class ErrorPageModel
extends ElementModel<org.ops4j.pax.web.service.whiteboard.ErrorPageMapping,ErrorPageEventData>

Since:

0.3.0, January 12, 2008

Author:

Alin Dreghiciu

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

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

contextModels, contextModelsInfo, dtoFailureCode, isValid

Constructor Summary

Constructors

Constructor and Description
ErrorPageModel(String[] errorPages) Constructor used for unregistration purposes.
ErrorPageModel(String[] errorPages, String location)

Method Summary

Modifier and Type	Method and Description
ErrorPageEventData	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.
List<Integer>	getErrorCodes()
String[]	getErrorPages()
List<String>	getExceptionClassNames()
String	getLocation()
boolean	isXx4()
boolean	isXx5()
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	setLocation(String location)
org.osgi.service.http.runtime.dto.ErrorPageDTO	toDTO(ServletModel sm)
org.osgi.service.http.runtime.dto.FailedErrorPageDTO	toFailedDTO(ServletModel sm, 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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

ErrorPageModel

public ErrorPageModel(String[] errorPages)

Constructor used for unregistration purposes.

Parameters:

errorPages -

ErrorPageModel

public ErrorPageModel(String[] errorPages,
                      String location)

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<org.ops4j.pax.web.service.whiteboard.ErrorPageMapping,ErrorPageEventData>

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<org.ops4j.pax.web.service.whiteboard.ErrorPageMapping,ErrorPageEventData>

asEventData

public ErrorPageEventData 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<org.ops4j.pax.web.service.whiteboard.ErrorPageMapping,ErrorPageEventData>

Returns:

getErrorPages

public String[] getErrorPages()

getLocation

public String getLocation()

setLocation

public void setLocation(String location)

toFailedDTO

public org.osgi.service.http.runtime.dto.FailedErrorPageDTO toFailedDTO(ServletModel sm,
                                                                        int dtoFailureCode)

toDTO

public org.osgi.service.http.runtime.dto.ErrorPageDTO toDTO(ServletModel sm)

toString

public String toString()

Overrides:

toString in class ElementModel<org.ops4j.pax.web.service.whiteboard.ErrorPageMapping,ErrorPageEventData>

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<org.ops4j.pax.web.service.whiteboard.ErrorPageMapping,ErrorPageEventData>

Returns:

isXx4

public boolean isXx4()

isXx5

public boolean isXx5()

getErrorCodes

public List<Integer> getErrorCodes()

getExceptionClassNames

public List<String> getExceptionClassNames()