パッケージ jakarta.ws.rs.core
クラス NewCookie.AbstractNewCookieBuilder<T extends NewCookie.AbstractNewCookieBuilder<T>>
- java.lang.ObjectSE
-
- jakarta.ws.rs.core.Cookie.AbstractCookieBuilder<NewCookie.AbstractNewCookieBuilder<T>>
-
- jakarta.ws.rs.core.NewCookie.AbstractNewCookieBuilder<T>
- 型パラメーター:
T
- 現行の AbstractNewCookieBuilder 型。
- 既知の直属サブクラス
NewCookie.Builder
- 含まれているクラス:
- NewCookie
public abstract static class NewCookie.AbstractNewCookieBuilder<T extends NewCookie.AbstractNewCookieBuilder<T>> extends Cookie.AbstractCookieBuilder<NewCookie.AbstractNewCookieBuilder<T>>
JAX-RS 抽象NewCookie
ビルダークラス。- 導入:
- 3.1
コンストラクターのサマリー
コンストラクター コンストラクター 説明 AbstractNewCookieBuilder(Cookie cookie)
提供された Cookie の情報を補足する新しいインスタンスを作成します。AbstractNewCookieBuilder(StringSE name)
新しいインスタンスを作成します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 abstract NewCookie
build()
このビルダーで以前に指定されたすべての構成を使用して、新しいNewCookie
インスタンスをビルドします。T
comment(StringSE comment)
Cookie に関連付けられたコメントを設定します。T
expiry(DateSE expiry)
Cookie の有効期限を設定します。T
httpOnly(boolean httpOnly)
Cookie が HTTP リクエストの一部としてのみ表示されるかどうか。T
maxAge(int maxAge)
Cookie の最大存続期間を秒単位で設定します。T
sameSite(NewCookie.SameSite sameSite)
クロスオリジンリクエストで Cookie を送信するかどうかを制御する属性を設定し、クロスサイトリクエストフォージェリから保護します。T
secure(boolean secure)
Cookie が安全な接続を介してのみ送信されるかどうか。クラス jakarta.ws.rs.core.Cookie.AbstractCookieBuilder から継承されたメソッド
domain, path, value, version
メソッドの詳細
comment
public T comment(StringSE comment)
Cookie に関連付けられたコメントを設定します。- パラメーター:
comment
- コメント。- 戻り値:
- 更新されたビルダーインスタンス。
maxAge
public T maxAge(int maxAge)
Cookie の最大存続期間を秒単位で設定します。最大保存期間を超えた Cookie は破棄されます。Cookie は既存の Cookie を上書きし、すぐに破棄されるため、最大有効期間 0 の新しい Cookie を送信することで設定を解除できます。デフォルト値の-1
は、ブラウザー / アプリケーションセッションの終了時に Cookie が破棄されることを示します。- パラメーター:
maxAge
- 秒単位の最大経過時間。- 戻り値:
- 更新されたビルダーインスタンス。
- 関連事項:
expiry(Date)
expiry
public T expiry(DateSE expiry)
Cookie の有効期限を設定します。有効期限を過ぎた Cookie は破棄されます。Cookie の設定を解除するには、新しい Cookie に過去の有効期限 (通常は設定できる最も低い日付) を設定します。Max-Age
を使用して Cookie の有効期限を制御することをお勧めしますが、ブラウザーによってはMax-Age
を認識しないため、Expires
パラメーターの設定が必要になる場合があります。- パラメーター:
expiry
- クッキーの有効期限- 戻り値:
- 更新されたビルダーインスタンス。
- 関連事項:
maxAge(int)
secure
public T secure(boolean secure)
Cookie が安全な接続でのみ送信されるかどうか。デフォルトはfalse
です。- パラメーター:
secure
- Cookie が安全な接続を介してのみ送信されるかどうかを指定します。- 戻り値:
- 更新されたビルダーインスタンス。
httpOnly
public T httpOnly(boolean httpOnly)
Cookie が HTTP リクエストの一部としてのみ表示されるかどうか。デフォルトはfalse
です。- パラメーター:
httpOnly
-true
が Cookie を HTTP のみにする場合、つまり HTTP リクエストの一部としてのみ表示される場合。- 戻り値:
- 更新されたビルダーインスタンス。
sameSite
public T sameSite(NewCookie.SameSite sameSite)
クロスオリジンリクエストで Cookie を送信するかどうかを制御する属性を設定し、クロスサイトリクエストフォージェリから保護します。- パラメーター:
sameSite
-SameSite
Cookie 属性の値を指定します。- 戻り値:
- 更新されたビルダーインスタンス。
build
public abstract NewCookie build()
このビルダーで以前に指定されたすべての構成を使用して、新しいNewCookie
インスタンスをビルドします。- 次で指定:
- クラス
Cookie.AbstractCookieBuilder<NewCookie.AbstractNewCookieBuilder<T extends NewCookie.AbstractNewCookieBuilder<T>>>
のbuild
- 戻り値:
- 新しい
NewCookie
インスタンス。 - 例外:
IllegalArgumentExceptionSE
- 名前がnull
の場合