Jakarta EE 11.0.0 · jakarta.servlet.HttpConstraintElement

Modifier and Type	Field and Description
private final ServletSecurity.EmptyRoleSemantic	emptyRoleSemantic
private final String[]	rolesAllowed
private final ServletSecurity.TransportGuarantee	transportGuarantee

Constructor Summary

Access	Constructor and Description
public	HttpConstraintElement() Constructs a default HTTP constraint element
public	HttpConstraintElement(ServletSecurity.EmptyRoleSemantic should be EmptyRoleSemantic.DENY semantic) Convenience constructor to establish `EmptyRoleSemantic.DENY`
public	HttpConstraintElement(ServletSecurity.TransportGuarantee `TransportGuarantee.NONE` or `TransportGuarantee.CONFIDENTIAL` guarantee, String... the names of the roles that are to be allowed access roleNames) Constructor to establish non-empty getRolesAllowed and/or `TransportGuarantee.CONFIDENTIAL`.
public	HttpConstraintElement(ServletSecurity.EmptyRoleSemantic `EmptyRoleSemantic.DENY` or `EmptyRoleSemantic.PERMIT` semantic, ServletSecurity.TransportGuarantee `TransportGuarantee.NONE` or `TransportGuarantee.CONFIDENTIAL` guarantee, String... the names of the roles that are to be allowed access, or missing if the semantic is `EmptyRoleSemantic.DENY` roleNames) Constructor to establish all of getEmptyRoleSemantic, getRolesAllowed, and getTransportGuarantee.

Method Summary

Modifier and Type	Method and Description
private String[]	copyStrings(String[] strings)
public ServletSecurity.EmptyRoleSemantic	Returns: the `EmptyRoleSemantic` to be applied when `getRolesAllowed` returns an empty (that is, zero-length) array getEmptyRoleSemantic() Gets the default authorization semantic.
public String[]	Returns: a (possibly empty) array of role names. When the array is empty, its meaning depends on the value of `getEmptyRoleSemantic`. If its value is `DENY`, and `getRolesAllowed` returns an empty array, access is to be denied independent of authentication state and identity. Conversely, if its value is `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 of `getEmptyRoleSemantic`). getRolesAllowed() Gets the names of the authorized roles.
public ServletSecurity.TransportGuarantee	Returns: the `TransportGuarantee` indicating the data protection that must be provided by the connection getTransportGuarantee() Gets the data protection requirement (i.e., whether or not SSL/TLS is required) that must be satisfied by the transport connection.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

emptyRoleSemantic	back to summary
private final ServletSecurity.EmptyRoleSemantic emptyRoleSemantic

rolesAllowed	back to summary
private final String[] rolesAllowed

transportGuarantee	back to summary
private final ServletSecurity.TransportGuarantee transportGuarantee

Constructor Detail

HttpConstraintElement	back to summary
public HttpConstraintElement() Constructs a default HTTP constraint element

HttpConstraintElement back to summary

HttpConstraintElement	back to summary
public HttpConstraintElement(ServletSecurity.EmptyRoleSemantic semantic) Convenience constructor to establish `EmptyRoleSemantic.DENY` Parameters semantic:ServletSecurity.EmptyRoleSemantic should be EmptyRoleSemantic.DENY

public HttpConstraintElement(ServletSecurity.EmptyRoleSemantic semantic)

Convenience constructor to establish EmptyRoleSemantic.DENY

Parameters

semantic:ServletSecurity.EmptyRoleSemantic: should be EmptyRoleSemantic.DENY

HttpConstraintElement back to summary

HttpConstraintElement	back to summary
public HttpConstraintElement(ServletSecurity.TransportGuarantee guarantee, String... roleNames) Constructor to establish non-empty getRolesAllowed and/or `TransportGuarantee.CONFIDENTIAL`. Parameters guarantee:ServletSecurity.TransportGuarantee `TransportGuarantee.NONE` or `TransportGuarantee.CONFIDENTIAL` roleNames:String[] the names of the roles that are to be allowed access

public HttpConstraintElement(ServletSecurity.TransportGuarantee guarantee, String... roleNames)

Constructor to establish non-empty getRolesAllowed and/or TransportGuarantee.CONFIDENTIAL.

Parameters

guarantee:ServletSecurity.TransportGuarantee: TransportGuarantee.NONE or TransportGuarantee.CONFIDENTIAL
roleNames:String[]: the names of the roles that are to be allowed access

HttpConstraintElement back to summary

HttpConstraintElement	back to summary
public HttpConstraintElement(ServletSecurity.EmptyRoleSemantic semantic, ServletSecurity.TransportGuarantee guarantee, String... roleNames) Constructor to establish all of getEmptyRoleSemantic, getRolesAllowed, and getTransportGuarantee. Parameters semantic:ServletSecurity.EmptyRoleSemantic `EmptyRoleSemantic.DENY` or `EmptyRoleSemantic.PERMIT` guarantee:ServletSecurity.TransportGuarantee `TransportGuarantee.NONE` or `TransportGuarantee.CONFIDENTIAL` roleNames:String[] the names of the roles that are to be allowed access, or missing if the semantic is `EmptyRoleSemantic.DENY`

public HttpConstraintElement(ServletSecurity.EmptyRoleSemantic semantic, ServletSecurity.TransportGuarantee guarantee, String... roleNames)

Constructor to establish all of getEmptyRoleSemantic, getRolesAllowed, and getTransportGuarantee.

Parameters

semantic:ServletSecurity.EmptyRoleSemantic: EmptyRoleSemantic.DENY or EmptyRoleSemantic.PERMIT
guarantee:ServletSecurity.TransportGuarantee: TransportGuarantee.NONE or TransportGuarantee.CONFIDENTIAL
roleNames:String[]: the names of the roles that are to be allowed access, or missing if the semantic is EmptyRoleSemantic.DENY

Method Detail

copyStrings	back to summary
private String[] copyStrings(String[] strings)

getEmptyRoleSemantic back to summary

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

public ServletSecurity.EmptyRoleSemantic getEmptyRoleSemantic()

Gets the default authorization semantic.

This value is insignificant when getRolesAllowed returns a non-empty array, and should not be specified when a non-empty array is specified for getRolesAllowed.

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

getRolesAllowed back to summary

getRolesAllowed	back to summary
public String[] getRolesAllowed() Gets the names of the authorized roles. Duplicate role names appearing in getRolesAllowed are insignificant and may be discarded. The String `"*"` has no special meaning as a role name (should it occur in getRolesAllowed). Returns:String[] a (possibly empty) array of role names. When the array is empty, its meaning depends on the value of `getEmptyRoleSemantic`. If its value is `DENY`, and `getRolesAllowed` returns an empty array, access is to be denied independent of authentication state and identity. Conversely, if its value is `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 of `getEmptyRoleSemantic`).

public String[] getRolesAllowed()

Gets the names of the authorized roles.

Duplicate role names appearing in getRolesAllowed are insignificant and may be discarded. The String "*" has no special meaning as a role name (should it occur in getRolesAllowed).

Returns:String[]: a (possibly empty) array of role names. When the array is empty, its meaning depends on the value of getEmptyRoleSemantic. If its value is DENY, and getRolesAllowed returns an empty array, access is to be denied independent of authentication state and identity. Conversely, if its value is 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 of getEmptyRoleSemantic).

getTransportGuarantee back to summary

getTransportGuarantee	back to summary
public ServletSecurity.TransportGuarantee getTransportGuarantee() Gets the data protection requirement (i.e., whether or not SSL/TLS is required) that must be satisfied by the transport connection. Returns:ServletSecurity.TransportGuarantee the `TransportGuarantee` indicating the data protection that must be provided by the connection

public ServletSecurity.TransportGuarantee getTransportGuarantee()

Gets the data protection requirement (i.e., whether or not SSL/TLS is required) that must be satisfied by the transport connection.

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

public Class HttpConstraintElement

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail