Package org.gluu.oxauth.client

Class EndSessionResponse

java.lang.Object
org.gluu.oxauth.client.BaseResponse
org.gluu.oxauth.client.EndSessionResponse
public class EndSessionResponse extends BaseResponse
Represents an end session response received from the authorization server.
Version:
December 20, 2015
Author:
Javier Rojas Blum

  • Constructor Details

    • EndSessionResponse

      public EndSessionResponse(int status)
      Constructs an end session response.
      Parameters:
      status - The response status code.

  • Method Details

    • getLocation

      public String getLocation()
      Returns the location of the response in the header.
      Overrides:
      getLocation in class BaseResponse
      Returns:
      The location of the response.

    • setLocation

      public void setLocation(String location)
      Sets the location of the response in the header.
      Overrides:
      setLocation in class BaseResponse
      Parameters:
      location - The location of the response.

    • getHtmlPage

      public String getHtmlPage()
      Html page of http based logout
      Returns:
      html

    • getState

      public String getState()
      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.
      Returns:
      The state.

    • setState

      public void setState(String state)
      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.
      Parameters:
      state - he state.

    • getErrorType

      public EndSessionErrorResponseType getErrorType()
      Returns the error code when the request fails, otherwise will return null.
      Returns:
      The error code when the request fails.

    • setErrorType

      public void setErrorType(EndSessionErrorResponseType errorType)
      Sets the error code when the request fails, otherwise will return null.
      Parameters:
      errorType - The error code when the request fails.

    • getErrorDescription

      public String getErrorDescription()
      Returns a human-readable UTF-8 encoded text providing additional information, used to assist the client developer in understanding the error that occurred.
      Returns:
      The error description.

    • setErrorDescription

      public void setErrorDescription(String errorDescription)
      Sets a human-readable UTF-8 encoded text providing additional information, used to assist the client developer in understanding the error that occurred.
      Parameters:
      errorDescription - The error description.

    • getErrorUri

      public String getErrorUri()
      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.
      Returns:
      A URI with information about the error.

    • setErrorUri

      public void setErrorUri(String errorUri)
      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.
      Parameters:
      errorUri - A URI with information about the error.