Package net.shibboleth.oidc.profile.core

Class OIDCLogoutRequest

java.lang.Object
net.shibboleth.oidc.profile.core.OIDCLogoutRequest
@NotThreadSafe public class OIDCLogoutRequest extends Object
OpenID Connect RP-Initiated Logout Request.

This class is intentionally mutable and not thread-safe.

Since:
3.4.0

  • Field Details

    • logoutEndpoint

      @Nonnull private URI logoutEndpoint
      The logout endpoint.

    • idTokenHint

      @Nullable private JWT idTokenHint
      The ID Token hint. Optional but typically required by OPs.

    • logoutHint

      @Nullable private String logoutHint
      The logout hint. Optional.

    • clientID

      @Nullable private com.nimbusds.oauth2.sdk.id.ClientID clientID
      The client identifier. Optional.

    • postLogoutRedirectURI

      @Nullable private URI postLogoutRedirectURI
      The post logout redirect URI. Optional.

    • state

      @Nullable private com.nimbusds.oauth2.sdk.id.State state
      Opaque state value. Optional but recommended.

    • uiLocales

      @Nonnull @NotLive private List<LangTag> uiLocales
      End-User's preferred languages and scripts for the user interface. Optional.

  • Constructor Details

    • OIDCLogoutRequest

      public OIDCLogoutRequest(@Nonnull URI endpoint)
      Constructor.
      Parameters:
      endpoint - the end_session_endpoint logout endpoint.

  • Method Details

    • getLogoutEndpoint

      @Nonnull public URI getLogoutEndpoint()
      Get the logout endpoint to send the request to.
      Returns:
      the logout endpoint.

    • setLogoutEndpoint

      public void setLogoutEndpoint(@Nonnull URI endpoint)
      Set the logout endpoint to send the request to.
      Parameters:
      endpoint - the logout endpoint.

    • getIdTokenHint

      @Nullable public JWT getIdTokenHint()
      Get the id_token_hint parameter.
      Returns:
      the ID token hint.

    • setIdTokenHint

      public void setIdTokenHint(@Nullable JWT hint)
      Set the id_token_hint parameter.
      Parameters:
      hint - the ID token hint

    • getLogoutHint

      @Nullable public String getLogoutHint()
      Get the logout_hint parameter.
      Returns:
      the logout hint.

    • setLogoutHint

      public void setLogoutHint(@Nullable String hint)
      Set the logout_hint parameter.
      Parameters:
      hint - The logout hint to set.

    • getClientID

      @Nullable public com.nimbusds.oauth2.sdk.id.ClientID getClientID()
      Get the client ID.
      Returns:
      the clientID.

    • setClientID

      public void setClientID(@Nullable com.nimbusds.oauth2.sdk.id.ClientID id)
      Set the client ID.
      Parameters:
      id - The clientID.

    • getPostLogoutRedirectURI

      @Nullable public URI getPostLogoutRedirectURI()
      Get the post_logout_redirect_uri parameter.
      Returns:
      the post logout redirect URI parameter.

    • setPostLogoutRedirectURI

      public void setPostLogoutRedirectURI(@Nullable URI uri)
      Set the post_logout_redirect_uri parameter.
      Parameters:
      uri - the post logout redirect URI parameter.

    • getState

      @Nullable public com.nimbusds.oauth2.sdk.id.State getState()
      Get the state parameter.
      Returns:
      the state parameter.

    • setState

      public void setState(@Nullable com.nimbusds.oauth2.sdk.id.State stateIn)
      Set the state parameter.
      Parameters:
      stateIn - he state parameter.

    • setUiLocales

      public void setUiLocales(@Nullable @NonnullElements List<LangTag> locales)
      Set the list of optional ui_locales that specifies the End-User's preferred languages and scripts for the user interface.
      Parameters:
      locales - The uiLocales to set.

    • getUiLocales

      @Nonnull @NotLive @Unmodifiable public List<LangTag> getUiLocales()
      Get the list of optional ui_locales that specifies the End-User's preferred languages and scripts for the user interface.
      Returns:
      the uiLocales.