Package net.shibboleth.idp.plugin.authn.oidc.rp.context

Class OAuth2ClientContext

java.lang.Object

org.opensaml.messaging.context.BaseContext

net.shibboleth.idp.plugin.authn.oidc.rp.context.OAuth2ClientContext

All Implemented Interfaces:

Iterable<BaseContext>

public class OAuth2ClientContext
extends BaseContext

A context to store information pertaining to the OAuth2 client (Relying Party) to use in communication with a OpenID Provider.

Typically a subcontext under OIDCPeerEntityContext, as it relates to the client associated pairwise with the upstream OP peer.

Parent:

OIDCPeerEntityContext

Added:

During an OAuth 2.0 authentication request attempt

Nested Class Summary

Nested classes/interfaces inherited from class org.opensaml.messaging.context.BaseContext

BaseContext.ContextSetNoRemoveIteratorDecorator

Field Summary

Fields

Modifier and Type	Field	Description
private String	clientId	The client_id.
private URI	redirectUriOverride	An redirect URI that should take preference over any automatically computed.

Constructor Summary

Constructors

Constructor	Description
OAuth2ClientContext()

Method Summary

Modifier and Type	Method	Description
String	getClientId()	Get the client_id.
URI	getRedirectUriOverride()	Get the redirect_uri which should be used in place of any other.
OAuth2ClientContext	setClientId(String id)	Set the client_id.
OAuth2ClientContext	setRedirectUriOverride(URI override)	Set the redirect_uri to use in place of any other.

Methods inherited from class org.opensaml.messaging.context.BaseContext

addSubcontext, addSubcontext, clearSubcontexts, containsSubcontext, createSubcontext, getParent, getSubcontext, getSubcontext, getSubcontext, getSubcontext, iterator, removeSubcontext, removeSubcontext, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

clientId

@Nullable
private String clientId

The client_id.

redirectUriOverride

@Nullable
private URI redirectUriOverride

An redirect URI that should take preference over any automatically computed.

Constructor Detail

OAuth2ClientContext

public OAuth2ClientContext()

Method Detail

setRedirectUriOverride

public OAuth2ClientContext setRedirectUriOverride(@Nullable
                                                  URI override)

Set the redirect_uri to use in place of any other.

Parameters:

override - the redirect_uri

Returns:

this

getRedirectUriOverride

public URI getRedirectUriOverride()

Get the redirect_uri which should be used in place of any other.

Returns:

the redirect_uri

setClientId

public OAuth2ClientContext setClientId(@Nonnull @NotEmpty
                                       String id)

Set the client_id.

Parameters:

id - the client_id

Returns:

this

getClientId

public String getClientId()

Get the client_id.

Returns:

the client_id