Package io.jans.as.client

Class 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 Summary

      Constructors 
      Constructor Description
      EndSessionResponse​(int status)
      Constructs an end session response.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.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.
      io.jans.as.model.session.EndSessionErrorResponseType getErrorType()
      Returns the error code when the request fails, otherwise will return null.
      java.lang.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.
      java.lang.String getHtmlPage()
      Html page of http based logout
      java.lang.String getState()
      Returns the state.
      void setErrorDescription​(java.lang.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.
      void setErrorType​(io.jans.as.model.session.EndSessionErrorResponseType errorType)
      Sets the error code when the request fails, otherwise will return null.
      void setErrorUri​(java.lang.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.
      void setState​(java.lang.String state)
      Sets the state.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • EndSessionResponse

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

    • Method Detail

      • getHtmlPage

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

      • getState

        public java.lang.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​(java.lang.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 io.jans.as.model.session.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​(io.jans.as.model.session.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 java.lang.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​(java.lang.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 java.lang.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​(java.lang.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.