LogoutRequest (Nimbus OAuth 2.0 SDK with OpenID Connect 1.0 extensions v6.1.1)

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

Logout request initiated by an OpenID 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	Description
`LogoutRequest(URI uri)`	Creates a new OpenID Connect logout request without a post-logout redirection.
`LogoutRequest(URI uri, com.nimbusds.jwt.JWT idTokenHint)`	Creates a new OpenID Connect logout request without 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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(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, String query)`	Parses a logout request from the specified URI query string.
`static LogoutRequest`	`parse(URI uri, Map<String,List<String>> params)`	Parses a logout request from the specified URI and query parameters.
`static LogoutRequest`	`parse(Map<String,List<String>> params)`	Parses a logout request from the specified URI query parameters.
`HTTPRequest`	`toHTTPRequest()`	Returns the matching HTTP request.
`Map<String,List<String>>`	`toParameters()`	Returns the URI query parameters for this logout 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 (recommended), null if not specified.
    
    postLogoutRedirectURI - The optional post-logout redirection URI, null if not specified.
    
    state - The optional state parameter for the 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 without 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 (recommended), null if not specified.
  - LogoutRequest
```
public LogoutRequest(URI uri)
```
    Creates a new OpenID Connect logout request without a post-logout redirection.
    
    Parameters:
    
    uri - The URI of the end-session endpoint. May be null if the toHTTPRequest() method will not be used.
- Method Detail
  - getIDTokenHint
```
public com.nimbusds.jwt.JWT getIDTokenHint()
```
    Returns the ID token hint.
    
    Returns:
    
    The ID token hint, null if not specified.
  - 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,List<String>> toParameters()
```
    Returns the URI query parameters for this logout request.
    Example parameters:
```
 id_token_hint = eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 post_logout_redirect_uri = https://client.example.com/post-logout
 state = af0ifjsldkj
 
```
    Returns:
    
    The parameters.
  - toQueryString
```
public String toQueryString()
```
    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.
  - toURI
```
public URI toURI()
```
    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.
  - toHTTPRequest
```
public HTTPRequest toHTTPRequest()
```
    Description copied from interface: Request
    
    Returns the matching HTTP request.
    
    Returns:
    
    The HTTP request.
  - parse
```
public static LogoutRequest parse(Map<String,List<String>> params)
                           throws ParseException
```
    Parses a logout request from the specified URI query parameters.
    Example parameters:
```
 id_token_hint = eyJhbGciOiJSUzI1NiJ9.eyJpc3Mi...
 post_logout_redirect_uri = https://client.example.com/post-logout
 state = af0ifjsldkj
 
```
    Parameters:
    
    params - The parameters, empty map if none. 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,List<String>> params)
                           throws ParseException
```
    Parses a logout request from the specified URI and query 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, empty map if none. 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, null if none.
    
    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, null if none.
    
    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

LogoutRequest

Method Detail

getIDTokenHint

getPostLogoutRedirectionURI

getState

toParameters

toQueryString

toURI

toHTTPRequest

parse

parse

parse

parse

parse

parse