org.nuxeo.ecm.platform.oauth2.providers

Class OAuth2ServiceProviderContributionRegistry

java.lang.Object

org.nuxeo.runtime.model.ContributionFragmentRegistry<OAuth2ServiceProviderDescriptor>

org.nuxeo.ecm.platform.oauth2.providers.OAuth2ServiceProviderContributionRegistry

public class OAuth2ServiceProviderContributionRegistry
extends ContributionFragmentRegistry<OAuth2ServiceProviderDescriptor>

Since:

7.3

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

ContributionFragmentRegistry.Fragment<T>, ContributionFragmentRegistry.FragmentList<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log
protected Map<String,OAuth2ServiceProviderDescriptor>	providers

Fields inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

contribs

Constructor Summary

Constructors

Constructor and Description
OAuth2ServiceProviderContributionRegistry()

Method Summary

Modifier and Type	Method and Description
OAuth2ServiceProviderDescriptor	clone(OAuth2ServiceProviderDescriptor source) CLone the given contribution object
void	contributionRemoved(String name, OAuth2ServiceProviderDescriptor origContrib) All the fragments in the contribution was removed.
void	contributionUpdated(String name, OAuth2ServiceProviderDescriptor contrib, OAuth2ServiceProviderDescriptor newOrigContrib) Adds or updates a contribution.
Collection<OAuth2ServiceProviderDescriptor>	getContribs()
String	getContributionId(OAuth2ServiceProviderDescriptor contrib) Returns the contribution ID given the contribution object
OAuth2ServiceProvider	getProvider(String name)
void	merge(OAuth2ServiceProviderDescriptor src, OAuth2ServiceProviderDescriptor dst) Merge 'src' into 'dst'.

Methods inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

addContribution, addFragment, getContribution, getFragments, isSupportingMerge, removeContribution, removeContribution, removeFragment, toMap

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.apache.commons.logging.Log log

providers

protected final Map<String,OAuth2ServiceProviderDescriptor> providers

Constructor Detail

OAuth2ServiceProviderContributionRegistry

public OAuth2ServiceProviderContributionRegistry()

Method Detail

clone

public OAuth2ServiceProviderDescriptor clone(OAuth2ServiceProviderDescriptor source)

Description copied from class: ContributionFragmentRegistry

CLone the given contribution object

Specified by:

clone in class ContributionFragmentRegistry<OAuth2ServiceProviderDescriptor>

Returns:

contributionRemoved

public void contributionRemoved(String name,
                                OAuth2ServiceProviderDescriptor origContrib)

Description copied from class: ContributionFragmentRegistry

All the fragments in the contribution was removed. Contribution must be unregistered.

The first parameter is the contribution ID that should be remove and the second parameter the original contribution fragment that as unregistered causing the contribution to be removed.

Specified by:

contributionRemoved in class ContributionFragmentRegistry<OAuth2ServiceProviderDescriptor>

contributionUpdated

public void contributionUpdated(String name,
                                OAuth2ServiceProviderDescriptor contrib,
                                OAuth2ServiceProviderDescriptor newOrigContrib)

Description copied from class: ContributionFragmentRegistry

Adds or updates a contribution.

If the contribution doesn't yet exists then it will be added, otherwise the value will be updated. If the given value is null the existing contribution must be removed.

The second parameter is the contribution that should be updated when merging, as well as stored and used. This usually represents a clone of the original contribution or a merge of multiple contribution fragments. Modifications on this object at application level will be lost on next ContributionFragmentRegistry.contributionUpdated(String, Object, Object) call on the same object id: modifications should be done in the ContributionFragmentRegistry.merge(Object, Object) method.

The last parameter is the new contribution object, unchanged (original) which was neither cloned nor merged. This object should never be modified at application level, because it will be used each time a subsequent merge is done. Also, it never should be stored.

Specified by:

contributionUpdated in class ContributionFragmentRegistry<OAuth2ServiceProviderDescriptor>

Parameters:

name - - the id of the contribution that needs to be updated

contrib - the updated contribution object that

newOrigContrib - - the new, unchanged (original) contribution fragment that triggered the update.

getContributionId

public String getContributionId(OAuth2ServiceProviderDescriptor contrib)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<OAuth2ServiceProviderDescriptor>

Returns:

merge

public void merge(OAuth2ServiceProviderDescriptor src,
                  OAuth2ServiceProviderDescriptor dst)

Description copied from class: ContributionFragmentRegistry

Merge 'src' into 'dst'. When merging only the 'dst' object is modified.

Specified by:

merge in class ContributionFragmentRegistry<OAuth2ServiceProviderDescriptor>

Parameters:

src - the object to copy over the 'dst' object

dst - this object is modified

getProvider

public OAuth2ServiceProvider getProvider(String name)

getContribs

public Collection<OAuth2ServiceProviderDescriptor> getContribs()