org.kunlab.kpm.http

Class HTTPResponse

java.lang.Object

org.kunlab.kpm.http.HTTPResponse

All Implemented Interfaces:

AutoCloseable

public class HTTPResponse
extends Object
implements AutoCloseable

HTTP レスポンスを表すクラスです。

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTTPResponse.RequestStatus リクエストのステータスを表す列挙型です。

Constructor Summary

Constructors

Constructor and Description
HTTPResponse()

Method Summary

Modifier and Type	Method and Description
void	close() このクラスを破棄します。
static HTTPResponse	error(@NotNull RequestContext request, @NotNull HTTPResponse.RequestStatus status) エラーのレスポンスを生成します。
com.google.gson.JsonElement	getAsJson() レスポンスボディを JSON として取得します。
<T> T	getAsObject(Class<T> clazz) レスポンスボディをオブジェクトとして取得します。
String	getAsString() レスポンスボディを文字列として取得します。
@Nullable String	getHeader(@NotNull String header) ヘッダーを取得します。 ヘッダー名は大文字小文字を区別しません。
boolean	isClientError() クライアントエラーのレスポンスかどうかを取得します。
boolean	isError() エラーのレスポンスかどうかを取得します。
boolean	isOK() OK のレスポンスかどうかを取得します。
boolean	isRedirect() リダイレクトのレスポンスかどうかを取得します。
boolean	isServerError() サーバエラーのレスポンスかどうかを取得します。
boolean	isSuccessful() リクエストに成功したかどうかを取得します。

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPResponse

public HTTPResponse()

Method Detail

error

public static HTTPResponse error(@NotNull
                                 @NotNull RequestContext request,
                                 @NotNull
                                 @NotNull HTTPResponse.RequestStatus status)

エラーのレスポンスを生成します。

Parameters:

request - リクエスト

status - ステータス

Returns:

エラーのレスポンス

getAsString

public String getAsString()

レスポンスボディを文字列として取得します。

Returns:

レスポンスボディ

getAsJson

public com.google.gson.JsonElement getAsJson()

レスポンスボディを JSON として取得します。

Returns:

レスポンスボディ

getAsObject

public <T> T getAsObject(Class<T> clazz)

レスポンスボディをオブジェクトとして取得します。

Type Parameters:

T - クラスの型

Parameters:

clazz - クラス

Returns:

レスポンスボディ

close

public void close()
           throws IOException

このクラスを破棄します。

Specified by:

close in interface AutoCloseable

Throws:

IOException - I/O エラーが発生した場合

getHeader

@Nullable
public @Nullable String getHeader(@NotNull
                                            @NotNull String header)

ヘッダーを取得します。 ヘッダー名は大文字小文字を区別しません。

Parameters:

header - ヘッダー名

Returns:

ヘッダーの値

isSuccessful

public boolean isSuccessful()

リクエストに成功したかどうかを取得します。

Returns:

リクエストに成功したかどうか

isRedirect

public boolean isRedirect()

リダイレクトのレスポンスかどうかを取得します。

Returns:

リダイレクトのレスポンスかどうか

isClientError

public boolean isClientError()

クライアントエラーのレスポンスかどうかを取得します。

Returns:

クライアントエラーのレスポンスかどうか

isServerError

public boolean isServerError()

サーバエラーのレスポンスかどうかを取得します。

Returns:

サーバエラーのレスポンスかどうか

isError

public boolean isError()

エラーのレスポンスかどうかを取得します。

Returns:

エラーのレスポンスかどうか

See Also:

isClientError(), isServerError()

isOK

public boolean isOK()

OK のレスポンスかどうかを取得します。

Returns:

OK のレスポンスかどうか