Java Servlet API 4.0.1 · javax.servlet.annotation.HttpConstraint

This annotation is used within the ServletSecurity annotation to represent the security constraints to be applied to all HTTP protocol methods for which a corresponding HttpMethodConstraint element does NOT occur within the ServletSecurity annotation.

For the special case where an @HttpConstraint that returns all default values occurs in combination with at least one HttpMethodConstraint that returns other than all default values, the @HttpConstraint represents that no security constraint is to be applied to any of the HTTP protocol methods to which a security constraint would otherwise apply. This exception is made to ensure that such potentially non-specific uses of @HttpConstraint do not yield constraints that will explicitly establish unprotected access for such methods; given that they would not otherwise be covered by a constraint.

Method Summary

Modifier and Type	Method and Description
public String[]	Returns: an array of zero or more role names. When the array contains zero elements, its meaning depends on the `EmptyRoleSemantic` returned by the `value` method. If `value` returns `DENY`, and `rolesAllowed` returns a zero length array, access is to be denied independent of authentication state and identity. Conversely, if `value` returns `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 `EmptyRoleSemantic` returned by the `value` method). rolesAllowed() The names of the authorized roles.
public ServletSecurity.TransportGuarantee	Returns: the `TransportGuarantee` indicating the data protection that must be provided by the connection. transportGuarantee() The data protection requirements (i.e., whether or not SSL/TLS is required) that must be satisfied by the connections on which requests arrive.
public ServletSecurity.EmptyRoleSemantic	Returns: the `EmptyRoleSemantic` to be applied when `rolesAllowed` returns an empty (that is, zero-length) array. value() The default authorization semantic.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

rolesAllowed back to summary

rolesAllowed	back to summary
public String[] rolesAllowed() The names of the authorized roles. Duplicate role names appearing in rolesAllowed are insignificant and may be discarded during runtime processing of the annotation. The String `"*"` has no special meaning as a role name (should it occur in rolesAllowed). Returns:String[] an array of zero or more role names. When the array contains zero elements, its meaning depends on the `EmptyRoleSemantic` returned by the `value` method. If `value` returns `DENY`, and `rolesAllowed` returns a zero length array, access is to be denied independent of authentication state and identity. Conversely, if `value` returns `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 `EmptyRoleSemantic` returned by the `value` method).

public String[] rolesAllowed()

The names of the authorized roles. Duplicate role names appearing in rolesAllowed are insignificant and may be discarded during runtime processing of the annotation. The String "*" has no special meaning as a role name (should it occur in rolesAllowed).

Returns:String[]: an array of zero or more role names. When the array contains zero elements, its meaning depends on the EmptyRoleSemantic returned by the value method. If value returns DENY, and rolesAllowed returns a zero length array, access is to be denied independent of authentication state and identity. Conversely, if value returns 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 EmptyRoleSemantic returned by the value method).

transportGuarantee back to summary

transportGuarantee	back to summary
public ServletSecurity.TransportGuarantee transportGuarantee() The data protection requirements (i.e., whether or not SSL/TLS is required) that must be satisfied by the connections on which requests arrive. Returns:ServletSecurity.TransportGuarantee the `TransportGuarantee` indicating the data protection that must be provided by the connection.

public ServletSecurity.TransportGuarantee transportGuarantee()

The data protection requirements (i.e., whether or not SSL/TLS is required) that must be satisfied by the connections on which requests arrive.

Returns:ServletSecurity.TransportGuarantee: the TransportGuarantee indicating the data protection that must be provided by the connection.

value back to summary

value	back to summary
public ServletSecurity.EmptyRoleSemantic value() The default authorization semantic. This value is insignificant when `rolesAllowed` returns a non-empty array, and should not be specified when a non-empty array is specified for `rolesAllowed`. Returns:ServletSecurity.EmptyRoleSemantic the `EmptyRoleSemantic` to be applied when `rolesAllowed` returns an empty (that is, zero-length) array.

public ServletSecurity.EmptyRoleSemantic value()

The default authorization semantic. This value is insignificant when rolesAllowed returns a non-empty array, and should not be specified when a non-empty array is specified for rolesAllowed.

Returns:ServletSecurity.EmptyRoleSemantic: the EmptyRoleSemantic to be applied when rolesAllowed returns an empty (that is, zero-length) array.

public @Interface HttpConstraint

Method Summary

Method Detail