header(String name, Object value)メソッド
説明
構文
public T header(String name,
Object value)
パラメタ
- name
- HTTPヘッダ名です。
- value
- HTTPヘッダの値です。
戻り値
ビルダ(WebResource.Builderオブジェクト)を返します。
注意事項
- nameパラメタとvalueパラメタ両方の値がnullの場合,呼び出しは無視されます。
- nameパラメタの値がnullではない場合も,valueパラメタの値がnullのとき,呼び出しは無視されます。
- nameパラメタの値がnullで,かつvalueパラメタの値がnullではない場合,エラーとなり(KDJJ18888-E),NullPointerExceptionをラップしたClientHandlerExceptionがスローされます。
- このメソッドでContent-Length,Connection,Hostの各HTTPヘッダを設定することはできません。nameパラメタにこれらが指定された場合,valueパラメタの値がnullではないときでも,呼び出しは無視されます。なお,それぞれのHTTPヘッダはHttpURLConnectionによって設定されます。
- nameパラメタで指定されたHTTPヘッダの値はvalueパラメタで指定されたnullではないオブジェクトのtoString()メソッドによって返される値が設定されます。JAX-RSエンジンはtoString()メソッドによって返される値を検証しません。valueパラメタには標準仕様に従って値を指定してください。
- accept,acceptLanguage,cookieの各HTTPヘッダは,次のメソッドでも追加できます。
- ClientRequest.Builderクラス
accept(MediaType... types)メソッド
accept(String... types)メソッド
acceptLanguage(Locale... locales)メソッド
acceptLanguage(String... locales)メソッド
cookie(Cookie cookie)メソッド
- WebResourceクラス
accept(MediaType... types)メソッド
accept(String... types)メソッド
acceptLanguage(Locale... locales)メソッド
acceptLanguage(String... locales)メソッド
cookie(Cookie cookie)メソッド
- WebResource.Builderクラス
accept(MediaType... types)メソッド
accept(String... types)メソッド
acceptLanguage(Locale... locales)メソッド
acceptLanguage(String... locales)メソッド
cookie(Cookie cookie)メソッド
これらのメソッドおよびheader(String name, Object value)メソッドで,各HTTPヘッダが追加されていない場合の動作は,HttpURLConnectionオブジェクトに各HTTPヘッダを追加しない場合と同様です。
- Content-Type HTTPヘッダが次のメソッドですでに設定されていた場合,valueパラメタの値で上書きされます。
- ClientRequest.Builderクラス
entity(Object entity, MediaType type)メソッド
entity(Object entity, String type)メソッド
header(String name, Object value)メソッド
type(MediaType type)メソッド
type(String type)メソッド
- WebResourceクラス
entity(Object entity, MediaType type)メソッド
entity(Object entity, String type)メソッド
header(String name, Object value)メソッド
type(MediaType type)メソッド
type(String type)メソッド
- WebResource.Builderクラス
entity(Object entity, MediaType type)メソッド
entity(Object entity, String type)メソッド
type(MediaType type)メソッド
type(String type)メソッド
これらのメソッドおよびheader(String name, Object value)メソッドで,MIMEメディアタイプが設定されない場合の動作は,HTTP通信を行う前に,HttpURLConnectionオブジェクトにContent-Type HTTPヘッダを設定しない場合の動作と同様です。