Package com.authlete.common.dto

Class ApiResponse

java.lang.Object

com.authlete.common.dto.ApiResponse

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthorizationAuthenticateResponse, AuthorizationFailResponse, AuthorizationIssueResponse, AuthorizationResponse, AuthorizationTicketInfoResponse, AuthorizationTicketUpdateResponse, BackchannelAuthenticationCompleteResponse, BackchannelAuthenticationFailResponse, BackchannelAuthenticationIssueResponse, BackchannelAuthenticationResponse, ClientRegistrationResponse, ClientSecretRefreshResponse, ClientSecretUpdateResponse, CredentialBatchIssueResponse, CredentialBatchParseResponse, CredentialDeferredIssueResponse, CredentialDeferredParseResponse, CredentialIssuerJwksResponse, CredentialIssuerMetadataResponse, CredentialJwtIssuerMetadataResponse, CredentialOfferCreateResponse, CredentialOfferInfoResponse, CredentialSingleIssueResponse, CredentialSingleParseResponse, DeviceAuthorizationResponse, DeviceCompleteResponse, DeviceVerificationResponse, FederationConfigurationResponse, FederationRegistrationResponse, GMResponse, GrantedScopesGetResponse, HskListResponse, HskResponse, IDTokenReissueResponse, IntrospectionResponse, JoseVerifyResponse, NativeSsoLogoutResponse, NativeSsoResponse, PushedAuthReqResponse, ResourceServerSignatureResponse, RevocationResponse, StandardIntrospectionResponse, TokenCreateBatchResponse, TokenCreateBatchStatusResponse, TokenCreateResponse, TokenFailResponse, TokenIssueResponse, TokenResponse, TokenRevokeResponse, TokenUpdateResponse, UserInfoIssueResponse, UserInfoResponse

public class ApiResponse
extends Object
implements Serializable

The base class of an API response from an Authlete API call.

Since:

Authlete 1.1

Author:

Takahiko Kawasaki

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ApiResponse()

Method Summary

Modifier and Type	Method	Description
Map<String,List<String>>	getResponseHeaders()	Get the HTTP response headers returned from an Authlete API call.
String	getResultCode()	Get the code of the result of an Authlete API call.
String	getResultMessage()	Get the message of the result of an Authlete API call.
void	setResponseHeaders(Map<String,List<String>> responseHeaders)	Set the HTTP response headers returned from an Authlete API call.
void	setResultCode(String code)	Set the code of the result of an Authlete API call.
void	setResultMessage(String message)	Set the message of the result of an Authlete API call.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiResponse

public ApiResponse()

Method Detail

getResultCode

public String getResultCode()

Get the code of the result of an Authlete API call.

Returns:

The result code. For example, "A004001".

setResultCode

public void setResultCode(String code)

Set the code of the result of an Authlete API call.

Parameters:

code - The result code.

getResultMessage

public String getResultMessage()

Get the message of the result of an Authlete API call.

Returns:

The result message. For example, "[A001202] /client/get/list, Authorization header is missing."

setResultMessage

public void setResultMessage(String message)

Set the message of the result of an Authlete API call.

Parameters:

message - The result message.

getResponseHeaders

public Map<String,List<String>> getResponseHeaders()

Get the HTTP response headers returned from an Authlete API call.

Returns:

A map of HTTP response headers. May be null or empty.

Since:

4.23

setResponseHeaders

public void setResponseHeaders(Map<String,List<String>> responseHeaders)

Set the HTTP response headers returned from an Authlete API call.

Parameters:

responseHeaders - A map of HTTP response headers where each key is a header name and the corresponding value is a list of header values.

Since:

4.23