SecurityConstraintMapping (OPS4J Pax Web - API 9.0.8 API)

All Superinterfaces:

ContextRelated
```
public interface SecurityConstraintMapping
extends ContextRelated
```
Single constraint mapping to be used by SecurityConfigurationMapping. It represents single <security-constraint> element from web.xml.

Author:

Grzegorz Grzybek

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`SecurityConstraintMapping.WebResourceCollectionMapping`	A representation of single `<security-constraint>/<web-resource-collection>`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`Collection<String>`	`getAuthRoles()`	Returns a collection of `<security-constraint>/<auth-constraint>/<role-name>`
`String`	`getName()`	Returns `<security-constraint>/<display-name>`
`default javax.servlet.annotation.ServletSecurity.TransportGuarantee`	`getTransportGuarantee()`	Returns `<security-constraint>/<user-data-constraint>/<transport-guarantee>`.
`Collection<SecurityConstraintMapping.WebResourceCollectionMapping>`	`getWebResourceCollections()`	Returns a collection of `<security-constraint>/<web-resource-collection>` information.
`default boolean`	`isAuthRolesSet()`	When returning `true`, it means that empty roles collection mean "deny all authentication attempts".

Methods inherited from interface org.ops4j.pax.web.service.whiteboard.ContextRelated
getContextId, getContextSelectFilter

- Method Detail
  - getName
```
String getName()
```
    Returns <security-constraint>/<display-name>
    
    Returns:
  - getWebResourceCollections
```
Collection<SecurityConstraintMapping.WebResourceCollectionMapping> getWebResourceCollections()
```
    Returns a collection of <security-constraint>/<web-resource-collection> information.
    
    Returns:
  - getAuthRoles
```
Collection<String> getAuthRoles()
```
    Returns a collection of <security-constraint>/<auth-constraint>/<role-name>
    
    Returns:
  - isAuthRolesSet
```
default boolean isAuthRolesSet()
```
    When returning true, it means that empty roles collection mean "deny all authentication attempts". false means that authentication is successful despite the associated user roles. Effectively this flag disctinguishes between empty roles set (true) and no roles set at all (false).
    
    Returns:
  - getTransportGuarantee
```
default javax.servlet.annotation.ServletSecurity.TransportGuarantee getTransportGuarantee()
```
    Returns <security-constraint>/<user-data-constraint>/<transport-guarantee>.
    
    Returns: