Top Description Fields Constructors Methods
javax.servlet

public Class HttpConstraintElement

extends Object
Class Inheritance
Known Direct Subclasses
javax.servlet.HttpMethodConstraintElement, javax.servlet.ServletSecurityElement
Imports
java.util.*, javax.servlet.annotation.HttpConstraint, .ServletSecurity.EmptyRoleSemantic, .ServletSecurity.TransportGuarantee

Java Class representation of an HttpConstraint annotation value.
Since
Servlet 3.0

Field Summary

Modifier and TypeField and Description
private ServletSecurity.EmptyRoleSemantic
private String[]
private ServletSecurity.TransportGuarantee

Constructor Summary

AccessConstructor and Description
public
HttpConstraintElement()

Constructs a default HTTP constraint element

public
HttpConstraintElement(ServletSecurity.EmptyRoleSemantic
should be EmptyRoleSemantic.DENY
semantic
)

Convenience constructor to establish EmptyRoleSemantic.DENY

public
HttpConstraintElement(ServletSecurity.TransportGuarantee
TransportGuarantee.NONE or TransportGuarantee.CONFIDENTIAL
guarantee
,
String...
the names of the roles that are to be allowed access
roleNames
)

Constructor to establish non-empty getRolesAllowed and/or TransportGuarantee.CONFIDENTIAL.

public
HttpConstraintElement(ServletSecurity.EmptyRoleSemantic
EmptyRoleSemantic.DENY or EmptyRoleSemantic.PERMIT
semantic
,
ServletSecurity.TransportGuarantee
TransportGuarantee.NONE or TransportGuarantee.CONFIDENTIAL
guarantee
,
String...
the names of the roles that are to be allowed access, or missing if the semantic is EmptyRoleSemantic.DENY
roleNames
)

Constructor to establish all of getEmptyRoleSemantic, getRolesAllowed, and getTransportGuarantee.

Method Summary

Modifier and TypeMethod and Description
private String[]
copyStrings(String[] strings)

public ServletSecurity.EmptyRoleSemantic

Returns:

the EmptyRoleSemantic to be applied when getRolesAllowed returns an empty (that is, zero-length) array
getEmptyRoleSemantic
()

Gets the default authorization semantic.

public String[]

Returns:

a (possibly empty) array of role names. When the array is empty, its meaning depends on the value of getEmptyRoleSemantic. If its value is DENY, and getRolesAllowed returns an empty array, access is to be denied independent of authentication state and identity. Conversely, if its value is PERMIT, it indicates that access is to be allowed independent of authentication state and identity. When the array contains the names of one or more roles, it indicates that access is contingent on membership in at least one of the named roles (independent of the value of getEmptyRoleSemantic).
getRolesAllowed
()

Gets the names of the authorized roles.

public ServletSecurity.TransportGuarantee

Returns:

the TransportGuarantee indicating the data protection that must be provided by the connection
getTransportGuarantee
()

Gets the data protection requirement (i.e., whether or not SSL/TLS is required) that must be satisfied by the transport connection.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

emptyRoleSemanticback to summary
private ServletSecurity.EmptyRoleSemantic emptyRoleSemantic
rolesAllowedback to summary
private String[] rolesAllowed
transportGuaranteeback to summary
private ServletSecurity.TransportGuarantee transportGuarantee

Constructor Detail

HttpConstraintElementback to summary
public HttpConstraintElement()

Constructs a default HTTP constraint element

HttpConstraintElementback to summary
public HttpConstraintElement(ServletSecurity.EmptyRoleSemantic semantic)

Convenience constructor to establish EmptyRoleSemantic.DENY

Parameters
semantic:ServletSecurity.EmptyRoleSemantic

should be EmptyRoleSemantic.DENY

HttpConstraintElementback to summary
public HttpConstraintElement(ServletSecurity.TransportGuarantee guarantee, String... roleNames)

Constructor to establish non-empty getRolesAllowed and/or TransportGuarantee.CONFIDENTIAL.

Parameters
guarantee:ServletSecurity.TransportGuarantee

TransportGuarantee.NONE or TransportGuarantee.CONFIDENTIAL

roleNames:String[]

the names of the roles that are to be allowed access

HttpConstraintElementback to summary
public HttpConstraintElement(ServletSecurity.EmptyRoleSemantic semantic, ServletSecurity.TransportGuarantee guarantee, String... roleNames)

Constructor to establish all of getEmptyRoleSemantic, getRolesAllowed, and getTransportGuarantee.

Parameters
semantic:ServletSecurity.EmptyRoleSemantic

EmptyRoleSemantic.DENY or EmptyRoleSemantic.PERMIT

guarantee:ServletSecurity.TransportGuarantee

TransportGuarantee.NONE or TransportGuarantee.CONFIDENTIAL

roleNames:String[]

the names of the roles that are to be allowed access, or missing if the semantic is EmptyRoleSemantic.DENY

Method Detail

copyStringsback to summary
private String[] copyStrings(String[] strings)
getEmptyRoleSemanticback to summary
public ServletSecurity.EmptyRoleSemantic getEmptyRoleSemantic()

Gets the default authorization semantic.

This value is insignificant when getRolesAllowed returns a non-empty array, and should not be specified when a non-empty array is specified for getRolesAllowed.

Returns:ServletSecurity.EmptyRoleSemantic

the EmptyRoleSemantic to be applied when getRolesAllowed returns an empty (that is, zero-length) array

getRolesAllowedback to summary
public String[] getRolesAllowed()

Gets the names of the authorized roles.

Duplicate role names appearing in getRolesAllowed are insignificant and may be discarded. The String "*" has no special meaning as a role name (should it occur in getRolesAllowed).

Returns:String[]

a (possibly empty) array of role names. When the array is empty, its meaning depends on the value of getEmptyRoleSemantic. If its value is DENY, and getRolesAllowed returns an empty array, access is to be denied independent of authentication state and identity. Conversely, if its value is PERMIT, it indicates that access is to be allowed independent of authentication state and identity. When the array contains the names of one or more roles, it indicates that access is contingent on membership in at least one of the named roles (independent of the value of getEmptyRoleSemantic).

getTransportGuaranteeback to summary
public ServletSecurity.TransportGuarantee getTransportGuarantee()

Gets the data protection requirement (i.e., whether or not SSL/TLS is required) that must be satisfied by the transport connection.

Returns:ServletSecurity.TransportGuarantee

the TransportGuarantee indicating the data protection that must be provided by the connection