パッケージ jakarta.ws.rs.core
クラス NewCookie
- java.lang.ObjectSE
-
- jakarta.ws.rs.core.Cookie
-
- jakarta.ws.rs.core.NewCookie
public class NewCookie extends Cookie
レスポンスで転送される新しい HTTP Cookie を作成するために使用されます。- 導入:
- 1.0
- 作成者:
- Paul Sandoz, Marc Hadley
- 関連事項:
- IETF RFC 2109
ネストされたクラスの要約
ネストされたクラス 修飾子と型 クラス 説明 static classNewCookie.AbstractNewCookieBuilder<T extends NewCookie.AbstractNewCookieBuilder<T>>JAX-RS 抽象NewCookieビルダークラス。static classNewCookie.BuilderJAX-RSNewCookieビルダークラス。static classNewCookie.SameSiteSameSiteCookie 属性で使用可能な値。クラス jakarta.ws.rs.core.Cookie から継承されたネストクラス / インターフェース
Cookie.AbstractCookieBuilder<T extends Cookie.AbstractCookieBuilder<T>>
フィールドのサマリー
フィールド 修飾子と型 フィールド 説明 static intDEFAULT_MAX_AGECookie が現在のアプリケーション / ブラウザーセッションで期限切れになることを指定します。クラス jakarta.ws.rs.core.Cookie から継承されたフィールド
DEFAULT_VERSION
コンストラクターの概要
コンストラクター 修飾子 コンストラクター 説明 NewCookie(Cookie cookie)使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。NewCookie(Cookie cookie, StringSE comment, int maxAge, boolean secure)使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。NewCookie(Cookie cookie, StringSE comment, int maxAge, DateSE expiry, boolean secure, boolean httpOnly)使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。NewCookie(Cookie cookie, StringSE comment, int maxAge, DateSE expiry, boolean secure, boolean httpOnly, NewCookie.SameSite sameSite)使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。protectedNewCookie(NewCookie.AbstractNewCookieBuilder<?> builder)提供されたNewCookie.AbstractNewCookieBuilderインスタンスから新しいインスタンスを作成します。NewCookie(StringSE name, StringSE value)使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。NewCookie(StringSE name, StringSE value, StringSE path, StringSE domain, int version, StringSE comment, int maxAge, boolean secure)使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。NewCookie(StringSE name, StringSE value, StringSE path, StringSE domain, int version, StringSE comment, int maxAge, DateSE expiry, boolean secure, boolean httpOnly)使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。NewCookie(StringSE name, StringSE value, StringSE path, StringSE domain, int version, StringSE comment, int maxAge, DateSE expiry, boolean secure, boolean httpOnly, NewCookie.SameSite sameSite)使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。NewCookie(StringSE name, StringSE value, StringSE path, StringSE domain, StringSE comment, int maxAge, boolean secure)使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。NewCookie(StringSE name, StringSE value, StringSE path, StringSE domain, StringSE comment, int maxAge, boolean secure, boolean httpOnly)使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンスメソッド 具象メソッド 非推奨のメソッド 修飾子と型 メソッド 説明 booleanequals(ObjectSE obj)等しいかどうかを比較します。StringSEgetComment()Cookie に関連付けられたコメントを取得します。DateSEgetExpiry()Cookie の有効期限を取得します。intgetMaxAge()Cookie の最大有効期間を秒単位で取得します。NewCookie.SameSitegetSameSite()この Cookie のSameSite属性の値を返します。属性が設定されていない場合はnullを返します。inthashCode()すべてのプロパティをハッシュすることにより、ハッシュコードを生成します。booleanisHttpOnly()この Cookie にHttpOnly属性が含まれている場合、trueを返します。booleanisSecure()Cookie が安全な接続を介してのみ送信されるかどうか。CookietoCookie()このNewCookieと同じ名前、値、パス、ドメイン、バージョンを持つCookieの新しいインスタンスを取得します。StringSEtoString()使用すべきではありません。toString() メソッドの形式は、将来のバージョンで変更される可能性があります。static NewCookievalueOf(StringSE value)使用すべきではありません。このメソッドは、将来のバージョンで削除される予定です。
フィールドの詳細
DEFAULT_MAX_AGE
public static final int DEFAULT_MAX_AGE
Cookie が現在のアプリケーション / ブラウザーセッションで期限切れになることを指定します。- 関連事項:
- 定数フィールド値
コンストラクターの詳細
NewCookie
@DeprecatedSE public NewCookie(StringSE name, StringSE value)
使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。代わりにNewCookie.Builderを使用してください。新しいインスタンスを作成します。- パラメーター:
name- クッキーの名前。value- クッキーの値。- 例外:
IllegalArgumentExceptionSE- 名前がnullの場合
NewCookie
@DeprecatedSE public NewCookie(StringSE name, StringSE value, StringSE path, StringSE domain, StringSE comment, int maxAge, boolean secure)
使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。代わりにNewCookie.Builderを使用してください。新しいインスタンスを作成します。- パラメーター:
name- クッキーの名前。value- クッキーの値。path- Cookie が有効な URI パス。domain- Cookie が有効なホストドメイン。comment- コメント。maxAge- Cookie の最大経過時間(秒単位)。secure- Cookie が安全な接続を介してのみ送信されるかどうかを指定します。- 例外:
IllegalArgumentExceptionSE- 名前がnullの場合
NewCookie
@DeprecatedSE public NewCookie(StringSE name, StringSE value, StringSE path, StringSE domain, StringSE comment, int maxAge, boolean secure, boolean httpOnly)
使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。代わりにNewCookie.Builderを使用してください。新しいインスタンスを作成します。- パラメーター:
name- クッキーの名前。value- クッキーの値。path- Cookie が有効な URI パス。domain- Cookie が有効なホストドメイン。comment- コメント。maxAge- Cookie の最大経過時間(秒単位)。secure- Cookie が安全な接続を介してのみ送信されるかどうかを指定します。httpOnly-trueが Cookie を HTTP のみにする場合、つまり HTTP リクエストの一部としてのみ表示される場合。- 例外:
IllegalArgumentExceptionSE- 名前がnullの場合- 導入:
- 2.0
NewCookie
@DeprecatedSE public NewCookie(StringSE name, StringSE value, StringSE path, StringSE domain, int version, StringSE comment, int maxAge, boolean secure)
使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。代わりにNewCookie.Builderを使用してください。新しいインスタンスを作成します。- パラメーター:
name- クッキーの名前value- クッキーの値path- Cookie が有効な URI パスdomain- Cookie が有効なホストドメインversion- Cookie が準拠する仕様のバージョンcomment- コメントmaxAge- Cookie の最大有効期間(秒)secure- Cookie が安全な接続を介してのみ送信されるかどうかを指定します- 例外:
IllegalArgumentExceptionSE- 名前がnullの場合
NewCookie
@DeprecatedSE public NewCookie(StringSE name, StringSE value, StringSE path, StringSE domain, int version, StringSE comment, int maxAge, DateSE expiry, boolean secure, boolean httpOnly)
使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。代わりにNewCookie.Builderを使用してください。新しいインスタンスを作成します。- パラメーター:
name- クッキーの名前value- クッキーの値path- Cookie が有効な URI パスdomain- Cookie が有効なホストドメインversion- Cookie が準拠する仕様のバージョンcomment- コメントmaxAge- Cookie の最大有効期間(秒)expiry- Cookie の有効期限。secure- Cookie が安全な接続を介してのみ送信されるかどうかを指定しますhttpOnly-trueが Cookie を HTTP のみにする場合、つまり HTTP リクエストの一部としてのみ表示される場合。- 例外:
IllegalArgumentExceptionSE- 名前がnullの場合- 導入:
- 2.0
NewCookie
@DeprecatedSE public NewCookie(StringSE name, StringSE value, StringSE path, StringSE domain, int version, StringSE comment, int maxAge, DateSE expiry, boolean secure, boolean httpOnly, NewCookie.SameSite sameSite)
使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。代わりにNewCookie.Builderを使用してください。新しいインスタンスを作成します。- パラメーター:
name- クッキーの名前value- クッキーの値path- Cookie が有効な URI パスdomain- Cookie が有効なホストドメインversion- Cookie が準拠する仕様のバージョンcomment- コメントmaxAge- Cookie の最大有効期間(秒)expiry- Cookie の有効期限。secure- Cookie が安全な接続を介してのみ送信されるかどうかを指定しますhttpOnly-trueが Cookie を HTTP のみにする場合、つまり HTTP リクエストの一部としてのみ表示される場合。sameSite-SameSitecookie 属性の値を指定します- 例外:
IllegalArgumentExceptionSE- 名前がnullの場合- 導入:
- 3.1
NewCookie
@DeprecatedSE public NewCookie(Cookie cookie)
使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。代わりにNewCookie.Builderを使用してください。提供された Cookie の情報をコピーする新しいインスタンスを作成します。- パラメーター:
cookie- クローンする Cookie。- 例外:
IllegalArgumentExceptionSE- Cookie がnullの場合
NewCookie
@DeprecatedSE public NewCookie(Cookie cookie, StringSE comment, int maxAge, boolean secure)
使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。代わりにNewCookie.Builderを使用してください。提供された Cookie の情報を補足する新しいインスタンスを作成します。- パラメーター:
cookie- クローンする Cookie。comment- コメント。maxAge- Cookie の最大経過時間(秒単位)。secure- Cookie が安全な接続を介してのみ送信されるかどうかを指定します。- 例外:
IllegalArgumentExceptionSE- Cookie がnullの場合
NewCookie
@DeprecatedSE public NewCookie(Cookie cookie, StringSE comment, int maxAge, DateSE expiry, boolean secure, boolean httpOnly)
使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。代わりにNewCookie.Builderを使用してください。提供された Cookie の情報を補足する新しいインスタンスを作成します。- パラメーター:
cookie- クローンする Cookie。comment- コメント。maxAge- Cookie の最大経過時間(秒単位)。expiry- Cookie の有効期限。secure- Cookie が安全な接続を介してのみ送信されるかどうかを指定します。httpOnly-trueが Cookie を HTTP のみにする場合、つまり HTTP リクエストの一部としてのみ表示される場合。- 例外:
IllegalArgumentExceptionSE- Cookie がnullの場合- 導入:
- 2.0
NewCookie
@DeprecatedSE public NewCookie(Cookie cookie, StringSE comment, int maxAge, DateSE expiry, boolean secure, boolean httpOnly, NewCookie.SameSite sameSite)
使用すべきではありません。このコンストラクターは、将来のバージョンで削除される予定です。代わりにNewCookie.Builderを使用してください。提供された Cookie の情報を補足する新しいインスタンスを作成します。- パラメーター:
cookie- クローンする Cookie。comment- コメント。maxAge- Cookie の最大経過時間(秒単位)。expiry- Cookie の有効期限。secure- Cookie が安全な接続を介してのみ送信されるかどうかを指定します。httpOnly-trueが Cookie を HTTP のみにする場合、つまり HTTP リクエストの一部としてのみ表示される場合。sameSite-SameSitecookie 属性の値を指定します- 例外:
IllegalArgumentExceptionSE- Cookie がnullの場合- 導入:
- 3.1
NewCookie
protected NewCookie(NewCookie.AbstractNewCookieBuilder<?> builder)
提供されたNewCookie.AbstractNewCookieBuilderインスタンスから新しいインスタンスを作成します。- パラメーター:
builder- ビルダー。- 例外:
IllegalArgumentExceptionSE-builder.nameがnullの場合。- 導入:
- 3.1
メソッドの詳細
valueOf
@DeprecatedSE public static NewCookie valueOf(StringSE value)
使用すべきではありません。このメソッドは、将来のバージョンで削除される予定です。代わりに、RuntimeDelegate.getInstance()。createHeaderDelegate(NewCookie.class).fromString(value)を使用してください。指定された文字列を解析して、NewCookie の新しいインスタンスを作成します。- パラメーター:
value- クッキー文字列。- 戻り値:
- 新しく作成された
NewCookie - 例外:
IllegalArgumentExceptionSE- 指定された文字列を解析できないか、nullである場合
getComment
public StringSE getComment()
Cookie に関連付けられたコメントを取得します。- 戻り値:
- コメント。設定されていない場合は null
getMaxAge
public int getMaxAge()
Cookie の最大有効期間を秒で取得します。最大年齢よりも古い Cookie は破棄されます。Cookie は、既存の Cookie を上書きしてすぐに破棄されるため、最大有効期間 0 の新しい Cookie を送信することで設定解除できます。-1のデフォルト値は、ブラウザー / アプリケーションセッションの終了時に Cookie が破棄されることを示します。Max-Ageを使用して Cookie の有効期限を制御することをお勧めしますが、一部のブラウザーはMax-Ageを理解しないため、getExpiry()Expires} パラメーターの設定が必要になる場合があります。- 戻り値:
- 秒単位の最大経過時間。
- 関連事項:
getExpiry()
getExpiry
public DateSE getExpiry()
クッキーの有効期限を取得します。有効期限が過ぎたクッキーは破棄されます。Cookie の設定を解除するには、過去の有効期限、通常は設定可能な最も低い日付で新しい Cookie を設定します。Max-Ageを使用して Cookie の有効期限を制御することをお勧めしますが、ブラウザーによってはMax-Ageを認識しないため、Expiresパラメーターの設定が必要になる場合があります。- 戻り値:
- Cookie の有効期限、または有効期限が設定されていない場合は
null。 - 導入:
- 2.0
- 関連事項:
getMaxAge()
isSecure
public boolean isSecure()
Cookie が安全な接続でのみ送信されるかどうか。デフォルトはfalseです。- 戻り値:
- Cookie が安全な接続でのみ送信される場合は
true、それ以外の場合はfalse。
isHttpOnly
public boolean isHttpOnly()
この Cookie にHttpOnly属性が含まれている場合は、trueを返します。つまり、JavaScript のようなスクリプトエンジンから Cookie にアクセスできないようにする必要があります。- 戻り値:
- この Cookie を http のみと見なす場合は
true、それ以外の場合はfalse。 - 導入:
- 2.0
getSameSite
public NewCookie.SameSite getSameSite()
この Cookie のSameSite属性の値を返します。属性が設定されていない場合はnullを返します。この属性は、Cookie がクロスオリジンリクエストで送信されるかどうかを制御し、クロスサイトリクエストフォージェリに対する保護を提供します。- 戻り値:
SameSiteCookie 属性またはnullの値。- 導入:
- 3.1
toCookie
public Cookie toCookie()
このNewCookieと同じ名前、値、パス、ドメイン、バージョンのCookieの新しいインスタンスを取得します。このメソッドを使用して、別のCookieと等しいかどうかを比較できるオブジェクトを取得できます。CookieがNewCookieと比較されることは決してないからです。- 戻り値:
Cookie
toString
@DeprecatedSE public StringSE toString()
使用すべきではありません。toString() メソッドの形式は、将来のバージョンで変更される可能性があります。このメソッドの形式に依存する場合は、代わりに RuntimeDelegate.getInstance()。createHeaderDelegate(NewCookie.class).toString(value)を使用してください。Cookie を、対応する HTTP ヘッダーの値として使用するのに適した文字列に変換します。
hashCode
public int hashCode()
すべてのプロパティをハッシュすることにより、ハッシュコードを生成します。