Tomcat 10.1.19 · jakarta.servlet.annotation.HttpConstraint

This annotation represents the security constraints that are applied to all requests with HTTP protocol method types that are not otherwise represented by a corresponding jakarta.servlet.annotation.HttpMethodConstraint in a jakarta.servlet.annotation.ServletSecurity annotation.

Method Summary

Modifier and Type	Method and Description
public String[]	Returns: array of names. The array may be of zero length, in which case the EmptyRoleSemantic applies; the returned value determines whether access is to be permitted or denied regardless of the identity and authentication state in either case, PERMIT or DENY. Otherwise, when the array contains one or more role names access is permitted if the user a member of at least one of the named roles. The EmptyRoleSemantic is not applied in this case. rolesAllowed() The authorized roles' names.
public ServletSecurity.TransportGuarantee	Returns: transport guarantee transportGuarantee() Determines whether SSL/TLS is required to process the current request.
public ServletSecurity.EmptyRoleSemantic	Returns: empty role semantic value() The EmptyRoleSemantic determines the behaviour when the rolesAllowed list is empty.

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

Method Detail

rolesAllowed	back to summary
public String[] rolesAllowed() The authorized roles' names. The container may discard duplicate role names during processing of the annotation. N.B. The String "*" does not have a special meaning if it occurs as a role name. Returns:String[] array of names. The array may be of zero length, in which case the EmptyRoleSemantic applies; the returned value determines whether access is to be permitted or denied regardless of the identity and authentication state in either case, PERMIT or DENY. Otherwise, when the array contains one or more role names access is permitted if the user a member of at least one of the named roles. The EmptyRoleSemantic is not applied in this case.

rolesAllowed

back to summary

public String[] rolesAllowed()

The authorized roles' names. The container may discard duplicate role names during processing of the annotation. N.B. The String "*" does not have a special meaning if it occurs as a role name.

Returns:String[]: array of names. The array may be of zero length, in which case the EmptyRoleSemantic applies; the returned value determines whether access is to be permitted or denied regardless of the identity and authentication state in either case, PERMIT or DENY.
Otherwise, when the array contains one or more role names access is permitted if the user a member of at least one of the named roles. The EmptyRoleSemantic is not applied in this case.

transportGuarantee	back to summary
public ServletSecurity.TransportGuarantee transportGuarantee() Determines whether SSL/TLS is required to process the current request. Returns:ServletSecurity.TransportGuarantee transport guarantee

transportGuarantee

back to summary

public ServletSecurity.TransportGuarantee transportGuarantee()

Determines whether SSL/TLS is required to process the current request.

Returns:ServletSecurity.TransportGuarantee: transport guarantee

value	back to summary
public ServletSecurity.EmptyRoleSemantic value() The EmptyRoleSemantic determines the behaviour when the rolesAllowed list is empty. Returns:ServletSecurity.EmptyRoleSemantic empty role semantic

value

back to summary

public ServletSecurity.EmptyRoleSemantic value()

The EmptyRoleSemantic determines the behaviour when the rolesAllowed list is empty.

Returns:ServletSecurity.EmptyRoleSemantic: empty role semantic

public @Interface HttpConstraint

Method Summary

Method Detail