Package org.nuxeo.ecm.platform.oauth2.providers

Class OAuth2ServiceProviderDescriptor

java.lang.Object

org.nuxeo.ecm.platform.oauth2.providers.OAuth2ServiceProviderDescriptor

All Implemented Interfaces:

Descriptor

public class OAuth2ServiceProviderDescriptor
extends Object
implements Descriptor

Since:

7.3

Field Summary

Fields

Modifier and Type	Field	Description
protected String	accessTokenKey
protected String	authorizationServerURL
protected String	clientId
protected String	clientSecret
static final String	DEFAULT_ACCESS_TOKEN_KEY
static final Class<? extends OAuth2ServiceProvider>	DEFAULT_PROVIDER_CLASS
protected String	description
protected boolean	enabled
protected String	icon
protected String	label
protected String	name
protected Class<? extends OAuth2ServiceProvider>	providerClass
protected String[]	scopes
protected String	tokenServerURL
protected String	userInfoURL

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

UNIQUE_DESCRIPTOR_ID

Constructor Summary

Constructors

Constructor	Description
OAuth2ServiceProviderDescriptor()

Method Summary

Modifier and Type	Method	Description
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 OAuth2ServiceProvider>	getProviderClass()
String[]	getScopes()
String	getTokenServerURL()
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 Details

DEFAULT_ACCESS_TOKEN_KEY

public static final String DEFAULT_ACCESS_TOKEN_KEY

See Also:

• Constant Field Values

DEFAULT_PROVIDER_CLASS

public static final Class<? extends OAuth2ServiceProvider> DEFAULT_PROVIDER_CLASS

name

protected String name

enabled

protected boolean enabled

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

providerClass

protected Class<? extends OAuth2ServiceProvider> providerClass

Constructor Details

OAuth2ServiceProviderDescriptor

public OAuth2ServiceProviderDescriptor()

Method Details

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()

isEnabled

public boolean isEnabled()

getTokenServerURL

public String getTokenServerURL()

getAuthorizationServerURL

public String getAuthorizationServerURL()

getClientId

public String getClientId()

getClientSecret

public String getClientSecret()

getScopes

public String[] getScopes()

getIcon

public String getIcon()

setEnabled

public void setEnabled(boolean enabled)

getLabel

public String getLabel()

getDescription

public String getDescription()

getProviderClass

public Class<? extends OAuth2ServiceProvider> getProviderClass()

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