LogoutRequest (OAuth 2.0 SDK with OpenID Connect extensions 4.9 API)

java.lang.Object
- com.nimbusds.oauth2.sdk.AbstractRequest
- - com.nimbusds.openid.connect.sdk.LogoutRequest

All Implemented Interfaces:: Message, Request

@Immutable
public class LogoutRequest
extends AbstractRequest

OpenID Connect logout request initiated by the relying party (RP).

Example HTTP request:

 https://server.example.com/op/logout?
 id_token_hint=eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 &post_logout_redirect_uri=https%3A%2F%2Fclient.example.org%2Fpost-logout
 &state=af0ifjsldkj

Related specifications:

OpenID Connect Session Management 1.0, section 5.

Constructor Summary

Constructors
Constructor and Description
`LogoutRequest(URI uri, com.nimbusds.jwt.JWT idTokenHint)` Creates a new OpenID Connect logout request with a post-logout redirection.
`LogoutRequest(URI uri, com.nimbusds.jwt.JWT idTokenHint, URI postLogoutRedirectURI, State state)` Creates a new OpenID Connect logout request.

Method Summary

Methods
Modifier and Type	Method and Description
`com.nimbusds.jwt.JWT`	`getIDTokenHint()` Returns the ID token hint.
`URI`	`getPostLogoutRedirectionURI()` Return the post-logout redirection URI.
`State`	`getState()` Returns the state parameter for a post-logout redirection URI.
`static LogoutRequest`	`parse(HTTPRequest httpRequest)` Parses a logout request from the specified HTTP request.
`static LogoutRequest`	`parse(Map<String,String> params)` Parses a logout request from the specified parameters.
`static LogoutRequest`	`parse(String query)` Parses a logout request from the specified URI query string.
`static LogoutRequest`	`parse(URI uri)` Parses a logout request from the specified URI.
`static LogoutRequest`	`parse(URI uri, Map<String,String> params)` Parses a logout request from the specified parameters.
`static LogoutRequest`	`parse(URI uri, String query)` Parses a logout request from the specified URI query string.
`HTTPRequest`	`toHTTPRequest()` Returns the matching HTTP request.
`Map<String,String>`	`toParameters()` Returns the parameters for this authorisation request.
`String`	`toQueryString()` Returns the URI query string for this logout request.
`URI`	`toURI()` Returns the complete URI representation for this logout request, consisting of the `end-session endpoint URI` with the `query string` appended.

Methods inherited from class com.nimbusds.oauth2.sdk.AbstractRequest
getEndpointURI

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LogoutRequest
```
public LogoutRequest(URI uri,
             com.nimbusds.jwt.JWT idTokenHint,
             URI postLogoutRedirectURI,
             State state)
```
    Creates a new OpenID Connect logout request.
    
    Parameters:
    uri - The URI of the end-session endpoint. May be null if the toHTTPRequest() method will not be used.
    idTokenHint - The ID token hint. Must not be null.
    postLogoutRedirectURI - The optional post-logout redirection URI, null if not specified.
    state - The optional state parameter for a post-logout redirection URI, null if not specified.
  - LogoutRequest
```
public LogoutRequest(URI uri,
             com.nimbusds.jwt.JWT idTokenHint)
```
    Creates a new OpenID Connect logout request with a post-logout redirection.
    
    Parameters:
    uri - The URI of the end-session endpoint. May be null if the toHTTPRequest() method will not be used.
    idTokenHint - The ID token hint. Must not be null.
- Method Detail
  - getIDTokenHint
```
public com.nimbusds.jwt.JWT getIDTokenHint()
```
    Returns the ID token hint.
    
    Returns:
    The ID token hint.
  - getPostLogoutRedirectionURI
```
public URI getPostLogoutRedirectionURI()
```
    Return the post-logout redirection URI.
    
    Returns:
    The post-logout redirection URI, null if not specified.
  - getState
```
public State getState()
```
    Returns the state parameter for a post-logout redirection URI.
    
    Returns:
    The state parameter, null if not specified.
  - toParameters
```
public Map<String,String> toParameters()
                                throws SerializeException
```
    Returns the parameters for this authorisation request.
    Example parameters:
```
 id_token_hint = eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 post_logout_redirect_uri = https://client.example.com/post-logout
 state = af0ifjsldkj
 
```
    Returns:
    The parameters.
    
    Throws:
    
    SerializeException - If this logout request couldn't be serialised to an parameters map.
  - toQueryString
```
public String toQueryString()
                     throws SerializeException
```
    Returns the URI query string for this logout request.
    Note that the '?' character preceding the query string in an URI is not included in the returned string.
    Example URI query string:
```
 id_token_hint = eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 &post_logout_redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fpost-logout
 &state=af0ifjsldkj
 
```
    Returns:
    The URI query string.
    
    Throws:
    
    SerializeException - If this logout request couldn't be serialised to an URI query string.
  - toURI
```
public URI toURI()
          throws SerializeException
```
    Returns the complete URI representation for this logout request, consisting of the end-session endpoint URI with the query string appended.
    Example URI:
```
 https://server.example.com/logout?
 id_token_hint = eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 &post_logout_redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fpost-logout
 &state=af0ifjsldkj
 
```
    Returns:
    The URI representation.
    
    Throws:
    
    SerializeException - If this logout request couldn't be serialised to a URI.
  - toHTTPRequest
```
public HTTPRequest toHTTPRequest()
                          throws SerializeException
```
    Description copied from interface: Request
    
    Returns the matching HTTP request.
    
    Returns:
    The HTTP request.
    
    Throws:
    
    SerializeException - If the request message couldn't be serialised to an HTTP request.
  - parse
```
public static LogoutRequest parse(Map<String,String> params)
                           throws ParseException
```
    Parses a logout request from the specified parameters.
    Example parameters:
```
 id_token_hint = eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 post_logout_redirect_uri = https://client.example.com/post-logout
 state = af0ifjsldkj
 
```
    Parameters:
    params - The parameters. Must not be null.
    
    Returns:
    The logout request.
    
    Throws:
    
    ParseException - If the parameters couldn't be parsed to a logout request.
  - parse
```
public static LogoutRequest parse(URI uri,
                  Map<String,String> params)
                           throws ParseException
```
    Parses a logout request from the specified parameters.
    Example parameters:
```
 id_token_hint = eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 post_logout_redirect_uri = https://client.example.com/post-logout
 state = af0ifjsldkj
 
```
    Parameters:
    uri - The URI of the end-session endpoint. May be null if the toHTTPRequest() method will not be used.
    params - The parameters. Must not be null.
    
    Returns:
    The logout request.
    
    Throws:
    
    ParseException - If the parameters couldn't be parsed to a logout request.
  - parse
```
public static LogoutRequest parse(String query)
                           throws ParseException
```
    Parses a logout request from the specified URI query string.
    Example URI query string:
```
 id_token_hint = eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 &post_logout_redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fpost-logout
 &state=af0ifjsldkj
 
```
    Parameters:
    query - The URI query string. Must not be null.
    
    Returns:
    The logout request.
    
    Throws:
    
    ParseException - If the query string couldn't be parsed to a logout request.
  - parse
```
public static LogoutRequest parse(URI uri,
                  String query)
                           throws ParseException
```
    Parses a logout request from the specified URI query string.
    Example URI query string:
```
 id_token_hint = eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 &post_logout_redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fpost-logout
 &state=af0ifjsldkj
 
```
    Parameters:
    uri - The URI of the end-session endpoint. May be null if the toHTTPRequest() method will not be used.
    query - The URI query string. Must not be null.
    
    Returns:
    The logout request.
    
    Throws:
    
    ParseException - If the query string couldn't be parsed to a logout request.
  - parse
```
public static LogoutRequest parse(URI uri)
                           throws ParseException
```
    Parses a logout request from the specified URI.
    Example URI:
```
 https://server.example.com/logout?
 id_token_hint = eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 &post_logout_redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fpost-logout
 &state=af0ifjsldkj
 
```
    Parameters:
    uri - The URI. Must not be null.
    
    Returns:
    The logout request.
    
    Throws:
    
    ParseException - If the URI couldn't be parsed to a logout request.
  - parse
```
public static LogoutRequest parse(HTTPRequest httpRequest)
                           throws ParseException
```
    Parses a logout request from the specified HTTP request.
    Example HTTP request (GET):
```
 https://server.example.com/logout?
 id_token_hint = eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 &post_logout_redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fpost-logout
 &state=af0ifjsldkj
 
```
    Parameters:
    httpRequest - The HTTP request. Must not be null.
    
    Returns:
    The logout request.
    
    Throws:
    
    ParseException - If the HTTP request couldn't be parsed to a logout request.

Class LogoutRequest

Constructor Summary

Method Summary

Methods inherited from class com.nimbusds.oauth2.sdk.AbstractRequest

Methods inherited from class java.lang.Object

Constructor Detail

LogoutRequest

LogoutRequest

Method Detail

getIDTokenHint

getPostLogoutRedirectionURI

getState

toParameters

toQueryString

toURI

toHTTPRequest

parse

parse

parse

parse

parse

parse