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

Class SecurityConfigurationModel

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.SecurityConfigurationMapping,SecurityConfigurationEventData>

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

All Implemented Interfaces:

Comparable<ElementModel<org.ops4j.pax.web.service.whiteboard.SecurityConfigurationMapping,SecurityConfigurationEventData>>

public class SecurityConfigurationModel
extends ElementModel<org.ops4j.pax.web.service.whiteboard.SecurityConfigurationMapping,SecurityConfigurationEventData>

Single configuration class for 3 top-level elements of web.xml:

• <login-config> (1 per context):
  • org.eclipse.jetty.security.SecurityHandler#setRealmName() + few others
  • org.apache.catalina.Context#setLoginConfig()
  • io.undertow.servlet.api.DeploymentInfo#setLoginConfig()
• <security-constraint> (N per context):
  • org.eclipse.jetty.security.ConstraintAware#addConstraintMapping()
  • org.apache.catalina.Context#addConstraint()
  • io.undertow.servlet.api.DeploymentInfo#addSecurityConstraint()
• <security-role> (N per context):
  • org.eclipse.jetty.security.ConstraintSecurityHandler#setRoles()
  • org.apache.catalina.Context#addSecurityRole()
  • io.undertow.servlet.api.DeploymentInfo#addSecurityRole()

Additionally, security declarations may be passed through ServletRegistration.Dynamic.setServletSecurity(javax.servlet.ServletSecurityElement) and for example, Tomcat passes the arguments to org.apache.catalina.core.StandardContext#addServletSecurity().

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
SecurityConfigurationModel()

Method Summary

Modifier and Type	Method and Description
SecurityConfigurationEventData	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.
LoginConfigModel	getLoginConfig() Returns a single, context-wide login configuration matching <login-config> element from web.xml.
List<SecurityConstraintModel>	getSecurityConstraints() Returns a list of constraints matching the <security-constraint> elements from web.xml.
Set<String>	getSecurityRoles() Returns a list of roles matching the <security-role>/<role-name> elements from web.xml.
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	setLoginConfig(LoginConfigModel loginConfig)
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

SecurityConfigurationModel

public SecurityConfigurationModel()

Method Detail

getLoginConfig

public LoginConfigModel getLoginConfig()

Returns a single, context-wide login configuration matching <login-config> element from web.xml.

Returns:

setLoginConfig

public void setLoginConfig(LoginConfigModel loginConfig)

getSecurityConstraints

public List<SecurityConstraintModel> getSecurityConstraints()

Returns a list of constraints matching the <security-constraint> elements from web.xml.

Returns:

getSecurityRoles

public Set<String> getSecurityRoles()

Returns a list of roles matching the <security-role>/<role-name> elements from web.xml.

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

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.SecurityConfigurationMapping,SecurityConfigurationEventData>

toString

public String toString()

Overrides:

toString in class ElementModel<org.ops4j.pax.web.service.whiteboard.SecurityConfigurationMapping,SecurityConfigurationEventData>

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

Returns:

Throws:

Exception

asEventData

public SecurityConfigurationEventData 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.SecurityConfigurationMapping,SecurityConfigurationEventData>

Returns: