JavaEE Web API 8.0.1 · javax.servlet.annotation.HttpMethodConstraint

Method Summary

Modifier and Type	Method and Description
public ServletSecurity.EmptyRoleSemantic	Returns: the `EmptyRoleSemantic` to be applied when `rolesAllowed` returns an empty (that is, zero-length) array. emptyRoleSemantic() The default authorization semantic.
public String[]	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`). 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 String	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. value() Http protocol method name

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

Method Detail

emptyRoleSemantic back to summary

emptyRoleSemantic	back to summary
public 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:ServletSecurity.EmptyRoleSemantic the `EmptyRoleSemantic` to be applied when `rolesAllowed` returns an empty (that is, zero-length) array.

public 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:ServletSecurity.EmptyRoleSemantic: the EmptyRoleSemantic to be applied when rolesAllowed returns an empty (that is, zero-length) array.

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 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`).

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 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).

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 String value() Http protocol method name Returns:String 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.

public String value()

Http protocol method name

Returns:String: 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.

public @Interface HttpMethodConstraint

Method Summary

Method Detail