Module jakarta.servlet

Package jakarta.servlet.annotation

Annotation Interface HttpMethodConstraint

@Documented
@Retention(RUNTIME)
public @interface HttpMethodConstraint

This annotation is used within the ServletSecurity annotation to represent security constraints on specific HTTP protocol messages.

Since:

Servlet 3.0

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	value	Http protocol method name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
ServletSecurity.EmptyRoleSemantic	emptyRoleSemantic	The default authorization semantic.
String[]	rolesAllowed	The names of the authorized roles.
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.

Element Details

value

String value

Http protocol method name

Returns:

the name of an HTTP protocol method. value may not be null, or the empty string, and must be a legitimate HTTP Method name as defined by RFC 7231.

emptyRoleSemantic

ServletSecurity.EmptyRoleSemantic emptyRoleSemantic

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:

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

Default:

PERMIT

transportGuarantee

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:

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

Default:

NONE

rolesAllowed

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:

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

Default:

{}