gluu
公開メンバ関数 | 限定公開変数類 | 非公開変数類 | 全メンバ一覧
org.xdi.oxauth.client.EndSessionResponse クラス
org.xdi.oxauth.client.EndSessionResponse の継承関係図
Inheritance graph
org.xdi.oxauth.client.EndSessionResponse 連携図
Collaboration graph

公開メンバ関数

 EndSessionResponse (int status)
 
String getLocation ()
 
void setLocation (String location)
 
String getHtmlPage ()
 
String getState ()
 
void setState (String state)
 
EndSessionErrorResponseType getErrorType ()
 
void setErrorType (EndSessionErrorResponseType errorType)
 
String getErrorDescription ()
 
void setErrorDescription (String errorDescription)
 
String getErrorUri ()
 
void setErrorUri (String errorUri)
 
int getStatus ()
 
void setStatus (int status)
 
String getEntity ()
 
void setEntity (String entity)
 
MultivaluedMap< String, Object > getHeaders ()
 
void setHeaders (MultivaluedMap< String, Object > headers)
 

限定公開変数類

int status
 
String entity
 
MultivaluedMap< String, Object > headers
 

非公開変数類

String location
 
String state
 
EndSessionErrorResponseType errorType
 
String errorDescription
 
String errorUri
 

詳解

Represents an end session response received from the authorization server.

著者
Javier Rojas Blum
バージョン
December 20, 2015

構築子と解体子

◆ EndSessionResponse()

org.xdi.oxauth.client.EndSessionResponse.EndSessionResponse ( int  status)
inline

Constructs an end session response.

引数
statusThe response status code.
31  {
32  super(status);
33  }
int status
Definition: BaseResponse.java:19

関数詳解

◆ getEntity()

String org.xdi.oxauth.client.BaseResponse.getEntity ( )
inlineinherited

Returns the entity or body content of the response.

戻り値
The entity or body content of the response.
85  {
86  return entity;
87  }
String entity
Definition: BaseResponse.java:21

◆ getErrorDescription()

String org.xdi.oxauth.client.EndSessionResponse.getErrorDescription ( )
inline

Returns a human-readable UTF-8 encoded text providing additional information, used to assist the client developer in understanding the error that occurred.

戻り値
The error description.
111  {
112  return errorDescription;
113  }
String errorDescription
Definition: EndSessionResponse.java:23

◆ getErrorType()

EndSessionErrorResponseType org.xdi.oxauth.client.EndSessionResponse.getErrorType ( )
inline

Returns the error code when the request fails, otherwise will return null.

戻り値
The error code when the request fails.
91  {
92  return errorType;
93  }
EndSessionErrorResponseType errorType
Definition: EndSessionResponse.java:22

◆ getErrorUri()

String org.xdi.oxauth.client.EndSessionResponse.getErrorUri ( )
inline

Returns a URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.

戻り値
A URI with information about the error.
133  {
134  return errorUri;
135  }
String errorUri
Definition: EndSessionResponse.java:24

◆ getHeaders()

MultivaluedMap<String, Object> org.xdi.oxauth.client.BaseResponse.getHeaders ( )
inlineinherited
98  {
99  return headers;
100  }
MultivaluedMap< String, Object > headers
Definition: BaseResponse.java:22

◆ getHtmlPage()

String org.xdi.oxauth.client.EndSessionResponse.getHtmlPage ( )
inline

Html page of http based logout

戻り値
html
58  {
59  return entity;
60  }
String entity
Definition: BaseResponse.java:21

◆ getLocation()

String org.xdi.oxauth.client.EndSessionResponse.getLocation ( )
inline

Returns the location of the response in the header.

戻り値
The location of the response.
40  {
41  return location;
42  }
String location
Definition: EndSessionResponse.java:19

◆ getState()

String org.xdi.oxauth.client.EndSessionResponse.getState ( )
inline

Returns the state. The state is an opaque value used by the RP to maintain state between the logout request and the callback to the endpoint specified by the post_logout_redirect_uri parameter. If included in the logout request, the OP passes this value back to the RP using the state query parameter when redirecting the User Agent back to the RP.

戻り値
The state.
70  {
71  return state;
72  }
String state
Definition: EndSessionResponse.java:20

◆ getStatus()

int org.xdi.oxauth.client.BaseResponse.getStatus ( )
inlineinherited

Returns the HTTP status code of the response.

戻り値
The HTTP status code.
49  {
50  return status;
51  }
int status
Definition: BaseResponse.java:19

◆ setEntity()

void org.xdi.oxauth.client.BaseResponse.setEntity ( String  entity)
inlineinherited

Sets the entity or body content of the response.

引数
entityThe entity or body content of the response.
94  {
95  this.entity = entity;
96  }
String entity
Definition: BaseResponse.java:21

◆ setErrorDescription()

void org.xdi.oxauth.client.EndSessionResponse.setErrorDescription ( String  errorDescription)
inline

Sets a human-readable UTF-8 encoded text providing additional information, used to assist the client developer in understanding the error that occurred.

引数
errorDescriptionThe error description.
122  {
124  }
String errorDescription
Definition: EndSessionResponse.java:23

◆ setErrorType()

void org.xdi.oxauth.client.EndSessionResponse.setErrorType ( EndSessionErrorResponseType  errorType)
inline

Sets the error code when the request fails, otherwise will return null.

引数
errorTypeThe error code when the request fails.
100  {
101  this.errorType = errorType;
102  }
EndSessionErrorResponseType errorType
Definition: EndSessionResponse.java:22

◆ setErrorUri()

void org.xdi.oxauth.client.EndSessionResponse.setErrorUri ( String  errorUri)
inline

Sets a URI identifying a human-readable web page with information about the error, used to provide the client developer with additional information about the error.

引数
errorUriA URI with information about the error.
144  {
145  this.errorUri = errorUri;
146  }
String errorUri
Definition: EndSessionResponse.java:24

◆ setHeaders()

void org.xdi.oxauth.client.BaseResponse.setHeaders ( MultivaluedMap< String, Object >  headers)
inlineinherited
102  {
103  this.headers = headers;
104  }
MultivaluedMap< String, Object > headers
Definition: BaseResponse.java:22

◆ setLocation()

void org.xdi.oxauth.client.EndSessionResponse.setLocation ( String  location)
inline

Sets the location of the response in the header.

引数
locationThe location of the response.
49  {
50  this.location = location;
51  }
String location
Definition: EndSessionResponse.java:19

◆ setState()

void org.xdi.oxauth.client.EndSessionResponse.setState ( String  state)
inline

Sets the state. The state is an opaque value used by the RP to maintain state between the logout request and the callback to the endpoint specified by the post_logout_redirect_uri parameter. If included in the logout request, the OP passes this value back to the RP using the state query parameter when redirecting the User Agent back to the RP.

引数
statehe state.
82  {
83  this.state = state;
84  }
String state
Definition: EndSessionResponse.java:20

◆ setStatus()

void org.xdi.oxauth.client.BaseResponse.setStatus ( int  status)
inlineinherited

Sets the HTTP status code of the response.

引数
statusThe HTTP status code.
76  {
77  this.status = status;
78  }
int status
Definition: BaseResponse.java:19

メンバ詳解

◆ entity

String org.xdi.oxauth.client.BaseResponse.entity
protectedinherited

◆ errorDescription

String org.xdi.oxauth.client.EndSessionResponse.errorDescription
private

◆ errorType

EndSessionErrorResponseType org.xdi.oxauth.client.EndSessionResponse.errorType
private

◆ errorUri

String org.xdi.oxauth.client.EndSessionResponse.errorUri
private

◆ headers

MultivaluedMap<String, Object> org.xdi.oxauth.client.BaseResponse.headers
protectedinherited

◆ location

String org.xdi.oxauth.client.EndSessionResponse.location
private

◆ state

String org.xdi.oxauth.client.EndSessionResponse.state
private

◆ status

int org.xdi.oxauth.client.BaseResponse.status
protectedinherited

このクラス詳解は次のファイルから抽出されました: