javax.servlet

クラス HttpConstraintElement

java.lang.Object

javax.servlet.HttpConstraintElement

直系の既知のサブクラス:

HttpMethodConstraintElement, ServletSecurityElement

public class HttpConstraintElement
extends Object

HttpConstraintアノテーションの値を表現するJavaクラスです。

導入されたバージョン:

Servlet 3.0

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
HttpConstraintElement() デフォルトのHTTP制約属性を生成します。
HttpConstraintElement(ServletSecurity.EmptyRoleSemantic semantic) EmptyRoleSemantic.DENYを確立するための簡便なコンストラクタです。
HttpConstraintElement(ServletSecurity.EmptyRoleSemantic semantic, ServletSecurity.TransportGuarantee guarantee, String... roleNames) getEmptyRoleSemanticとgetRolesAllowed、getTransportGuaranteeのすべてを確立するためのコンストラクタです。
HttpConstraintElement(ServletSecurity.TransportGuarantee guarantee, String... roleNames) 空でないgetRolesAllowedと/もしくはTransportGuarantee.CONFIDENTIALを確立するためのコンストラクタです。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
ServletSecurity.EmptyRoleSemantic	getEmptyRoleSemantic() デフォルトの認可セマンティックを取得します。
String[]	getRolesAllowed() 権限のあるロールの名前を取得します。
ServletSecurity.TransportGuarantee	getTransportGuarantee() トランスポート層での接続で満たす必要のあるデータ保護要件(SSL/TLSが必要かどうか)を取得します。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

HttpConstraintElement

public HttpConstraintElement()

デフォルトのHTTP制約属性を生成します。

HttpConstraintElement

public HttpConstraintElement(ServletSecurity.EmptyRoleSemantic semantic)

EmptyRoleSemantic.DENYを確立するための簡便なコンストラクタです。

パラメータ:

semantic - EmptyRoleSemantic.DENY である必要があるセマンティック

HttpConstraintElement

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

空でないgetRolesAllowedと/もしくはTransportGuarantee.CONFIDENTIALを確立するためのコンストラクタです。

パラメータ:

guarantee - TransportGuarantee.NONEもしくはTransportGuarantee.CONFIDENTIAL

roleNames - アクセスが許容されるロールの名前

HttpConstraintElement

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

getEmptyRoleSemanticとgetRolesAllowed、getTransportGuaranteeのすべてを確立するためのコンストラクタです。

パラメータ:

semantic - EmptyRoleSemantic.DENYもしくはEmptyRoleSemantic.PERMIT

guarantee - TransportGuarantee.NONEもしくはTransportGuarantee.CONFIDENTIAL

roleNames - アクセスが許可されるロールの名前、そのセマンティックが存在しない場合はEmptyRoleSemantic.DENY

メソッドの詳細

getEmptyRoleSemantic

public ServletSecurity.EmptyRoleSemantic getEmptyRoleSemantic()

デフォルトの認可セマンティックを取得します。

この値はgetRolesAllowedが空でない配列を返すときは意味がないので、 getRolesAllowedに空でない配列が指定されているときは指定しないでください。

戻り値:

getRolesAllowedが空の(長さがゼロの)配列を返すときに適用されるServletSecurity.EmptyRoleSemantic

getTransportGuarantee

public ServletSecurity.TransportGuarantee getTransportGuarantee()

トランスポート層での接続で満たす必要のあるデータ保護要件(SSL/TLSが必要かどうか)を取得します。

戻り値:

接続で提供する必要のあるデータ保護を示すServletSecurity.TransportGuarantee

getRolesAllowed

public String[] getRolesAllowed()

権限のあるロールの名前を取得します。

getRolesAllowedに現れる重複したロール名に意味はなく、破棄されることがあります。 文字列"*"はロール名として特別な意味を持ちません。(getRolesAllowedで存在する必要があります)

戻り値:

ロール名の(空の可能性がある)配列。 配列が空の場合、getEmptyRoleSemantic()によって返される値に依存することを意味します。 その値がDENYで、getRolesAllowedが空の配列を返す場合、 認証状況と身元とは無関係にアクセスが拒否されます。 逆に、その値がPERMITの場合、認証状況と身元とは無関係にアクセスが許可されることを示します。 配列に1つ以上のロールの名前が含まれている場合、 (getEmptyRoleSemantic()の値とは独立して)名前の付けられたロールの少なくとも1つのメンバーシップに依存してアクセスすることを示します。