java.lang.Object
- org.nuxeo.ecm.platform.oauth2.openid.OpenIDConnectProviderDescriptor

All Implemented Interfaces:: Descriptor

public class OpenIDConnectProviderDescriptor
extends Object
implements Descriptor

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`accessTokenKey`
`protected String`	`authenticationMethod`
`protected String`	`authorizationServerURL`
`static String`	`BEARER_AUTHENTICATION_METHOD`
`protected String`	`clientId`
`protected String`	`clientSecret`
`static String`	`DEFAULT_ACCESS_TOKEN_KEY`
`static String`	`DEFAULT_AUTHENTICATION_METHOD`
`static Class<? extends RedirectUriResolver>`	`DEFAULT_REDIRECT_URI_RESOLVER_CLASS`
`static Class<? extends OpenIDUserInfo>`	`DEFAULT_USER_INFO_CLASS`
`static Class<? extends UserResolver>`	`DEFAULT_USER_RESOLVER_CLASS`
`protected String`	`description`
`protected boolean`	`enabled`
`protected String`	`icon`
`protected String`	`label`
`protected String`	`name`
`protected Class<? extends RedirectUriResolver>`	`redirectUriResolver`
`protected String[]`	`scopes`
`protected String`	`tokenServerURL`
`static String`	`URL_AUTHENTICATION_METHOD`
`protected Class<? extends OpenIDUserInfo>`	`userInfoClass`
`protected String`	`userInfoURL`
`protected String`	`userMapper`
`protected Class<? extends UserResolver>`	`userResolverClass`

Fields inherited from interface org.nuxeo.runtime.model.Descriptor
UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors
Constructor Description

OpenIDConnectProviderDescriptor()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getAccessTokenKey()`
`String`	`getAuthenticationMethod()`
`String`	`getAuthorizationServerURL()`
`String`	`getClientId()`
`String`	`getClientSecret()`
`String`	`getDescription()`
`String`	`getIcon()`
`String`	`getId()`	The descriptor id, descriptors with same id are merged.
`String`	`getLabel()`
`String`	`getName()`
`Class<? extends RedirectUriResolver>`	`getRedirectUriResolver()`
`String[]`	`getScopes()`
`String`	`getTokenServerURL()`
`Class<? extends OpenIDUserInfo>`	`getUserInfoClass()`
`String`	`getUserInfoURL()`
`String`	`getUserMapper()`
`Class<? extends UserResolver>`	`getUserResolverClass()`
`boolean`	`isEnabled()`
`Descriptor`	`merge(Descriptor o)`	Returns a descriptor representing `other` merged into `this`
`void`	`setEnabled(boolean enabled)`

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

Methods inherited from interface org.nuxeo.runtime.model.Descriptor
doesRemove

Field Detail

DEFAULT_ACCESS_TOKEN_KEY

public static final String DEFAULT_ACCESS_TOKEN_KEY

See Also:: Constant Field Values

DEFAULT_USER_RESOLVER_CLASS

public static final Class<? extends UserResolver> DEFAULT_USER_RESOLVER_CLASS

DEFAULT_REDIRECT_URI_RESOLVER_CLASS

public static final Class<? extends RedirectUriResolver> DEFAULT_REDIRECT_URI_RESOLVER_CLASS

DEFAULT_USER_INFO_CLASS

public static final Class<? extends OpenIDUserInfo> DEFAULT_USER_INFO_CLASS

URL_AUTHENTICATION_METHOD
```
public static final String URL_AUTHENTICATION_METHOD
```
Since:

11.1

See Also:

Constant Field Values

BEARER_AUTHENTICATION_METHOD
```
public static final String BEARER_AUTHENTICATION_METHOD
```
Since:

11.1

See Also:

Constant Field Values

DEFAULT_AUTHENTICATION_METHOD
```
public static final String DEFAULT_AUTHENTICATION_METHOD
```
Since:

11.1

See Also:

Constant Field Values

enabled
```
protected boolean enabled
```

name
```
protected String name
```

tokenServerURL
```
protected String tokenServerURL
```

authorizationServerURL

protected String authorizationServerURL

userInfoURL
```
protected String userInfoURL
```

accessTokenKey
```
protected String accessTokenKey
```

clientId
```
protected String clientId
```

clientSecret
```
protected String clientSecret
```

scopes
```
protected String[] scopes
```

icon
```
protected String icon
```

label
```
protected String label
```

description
```
protected String description
```

userResolverClass

protected Class<? extends UserResolver> userResolverClass

userMapper
```
protected String userMapper
```

redirectUriResolver

protected Class<? extends RedirectUriResolver> redirectUriResolver

userInfoClass

protected Class<? extends OpenIDUserInfo> userInfoClass

authenticationMethod
```
protected String authenticationMethod
```
Since:

11.1

Constructor Detail
- OpenIDConnectProviderDescriptor
```
public OpenIDConnectProviderDescriptor()
```

Method Detail

getId
```
public String getId()
```
Description copied from interface: Descriptor

The descriptor id, descriptors with same id are merged.
To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.
To forbid merge use a unique value, non-overriden toString() for exemple.

Specified by:

getId in interface Descriptor

getName
```
public String getName()
```

getTokenServerURL
```
public String getTokenServerURL()
```

getAuthorizationServerURL

public String getAuthorizationServerURL()

getClientId
```
public String getClientId()
```

getClientSecret
```
public String getClientSecret()
```

getScopes
```
public String[] getScopes()
```

getUserInfoURL
```
public String getUserInfoURL()
```

getAccessTokenKey
```
public String getAccessTokenKey()
```

getIcon
```
public String getIcon()
```

isEnabled
```
public boolean isEnabled()
```

setEnabled

public void setEnabled(boolean enabled)

getLabel
```
public String getLabel()
```

getDescription
```
public String getDescription()
```

getUserMapper
```
public String getUserMapper()
```

getUserResolverClass

public Class<? extends UserResolver> getUserResolverClass()

getRedirectUriResolver

public Class<? extends RedirectUriResolver> getRedirectUriResolver()

getUserInfoClass

public Class<? extends OpenIDUserInfo> getUserInfoClass()

getAuthenticationMethod

public String getAuthenticationMethod()

Since:: 11.1

merge
```
public Descriptor merge(Descriptor o)
```
Description copied from interface: Descriptor

Returns a descriptor representing other merged into this
Default implementation returns other.

Specified by:

merge in interface Descriptor

Returns:

the merged descriptor

Class OpenIDConnectProviderDescriptor

Field Summary

Fields inherited from interface org.nuxeo.runtime.model.Descriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.nuxeo.runtime.model.Descriptor

Field Detail

DEFAULT_ACCESS_TOKEN_KEY

DEFAULT_USER_RESOLVER_CLASS

DEFAULT_REDIRECT_URI_RESOLVER_CLASS

DEFAULT_USER_INFO_CLASS

URL_AUTHENTICATION_METHOD

BEARER_AUTHENTICATION_METHOD

DEFAULT_AUTHENTICATION_METHOD

enabled

name

tokenServerURL

authorizationServerURL

userInfoURL

accessTokenKey

clientId

clientSecret

scopes

icon

label

description

userResolverClass

userMapper

redirectUriResolver

userInfoClass

authenticationMethod

Constructor Detail

OpenIDConnectProviderDescriptor

Method Detail

getId

getName

getTokenServerURL

getAuthorizationServerURL

getClientId

getClientSecret

getScopes

getUserInfoURL

getAccessTokenKey

getIcon

isEnabled

setEnabled

getLabel

getDescription

getUserMapper

getUserResolverClass

getRedirectUriResolver

getUserInfoClass

getAuthenticationMethod

merge