AddScopeToClientMetadata (Shibboleth IdP :: Plugins :: OpenID Connect Provider Implementation 3.2.1 API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - org.opensaml.profile.action.AbstractProfileAction
  - - org.opensaml.profile.action.AbstractConditionalProfileAction
    - - net.shibboleth.idp.profile.AbstractProfileAction
      - net.shibboleth.idp.plugin.oidc.op.profile.impl.AbstractOIDCClientMetadataPopulationAction
        
        net.shibboleth.idp.plugin.oidc.op.profile.impl.AddScopeToClientMetadata

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action
```
public class AddScopeToClientMetadata
extends AbstractOIDCClientMetadataPopulationAction
```
Adds the Scope from the input metadata to the output OIDCClientMetadata. If the scope is null or empty, the configurable default Scope is set. By default, its value is 'openid'.

Field Summary

Fields
Modifier and Type	Field	Description
`private com.nimbusds.oauth2.sdk.Scope`	`defaultScope`	The default `Scope` if it was not defined in the request.
`private org.slf4j.Logger`	`log`	Class logger.

Constructor Summary

Constructors
Constructor Description

AddScopeToClientMetadata()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doExecute(ProfileRequestContext profileRequestContext)`
`com.nimbusds.oauth2.sdk.Scope`	`getDefaultScope()`	Get the default `Scope` to be used if it was not defined in the request.
`void`	`setDefaultScope(com.nimbusds.oauth2.sdk.Scope scope)`	Set the default `Scope` to be used if it was not defined in the request.

Methods inherited from class net.shibboleth.idp.plugin.oidc.op.profile.impl.AbstractOIDCClientMetadataPopulationAction
doPreExecute, getInputMetadata, getOutputMetadata, setOidcInputMetadataLookupStrategy, setOidcOutputMetadataLookupStrategy

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction
doExecute, execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction
getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction
doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent
initialize, isInitialized

- Field Detail
  - log
```
@Nonnull
private final org.slf4j.Logger log
```
    Class logger.
  - defaultScope
```
@Nonnull
private com.nimbusds.oauth2.sdk.Scope defaultScope
```
    The default Scope if it was not defined in the request.
- Constructor Detail
  - AddScopeToClientMetadata
```
public AddScopeToClientMetadata()
```
    Constructor.
- Method Detail
  - setDefaultScope
```
public void setDefaultScope(@Nonnull
                            com.nimbusds.oauth2.sdk.Scope scope)
```
    Set the default Scope to be used if it was not defined in the request.
    
    Parameters:
    
    scope - The default Scope to be used if it was not defined in the request.
  - getDefaultScope
```
@Nonnull
public com.nimbusds.oauth2.sdk.Scope getDefaultScope()
```
    Get the default Scope to be used if it was not defined in the request.
    
    Returns:
    
    The default Scope to be used if it was not defined in the request.
  - doExecute
```
protected void doExecute(@Nonnull
                         ProfileRequestContext profileRequestContext)
```
    Overrides:
    
    doExecute in class AbstractProfileAction