-
@Documented @Retention(value=RUNTIME) public @interface HttpMethodConstraint
This annotation is used within theServletSecurity
annotation to represent security constraints on specific HTTP protocol messages.- Since:
- Servlet 3.0
-
-
Required Element Summary
Required Elements Modifier and Type Required Element and Description String
value
Http protocol method name
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and 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 Detail
-
value
public abstract 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 2616.
-
-
-
emptyRoleSemantic
public abstract ServletSecurity.EmptyRoleSemantic emptyRoleSemantic
The default authorization semantic. This value is insignificant whenrolesAllowed
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 whenrolesAllowed
returns an empty (that is, zero-length) array.
- Default:
- javax.servlet.annotation.ServletSecurity.EmptyRoleSemantic.PERMIT
-
-
-
transportGuarantee
public abstract 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:
- javax.servlet.annotation.ServletSecurity.TransportGuarantee.NONE
-
-
-
rolesAllowed
public abstract 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
. IfemptyRoleSemantic
returns DENY, androlesAllowed
returns a zero length array, access is to be denied independent of authentication state and identity. Conversely, ifemptyRoleSemantic
returnsPERMIT
, 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 byemptyRoleSemantic
).
- Default:
- {}
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/servlet/annotation/httpmethodconstraint.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.