Package org.alfresco.repo.remotecredentials

Class RemoteCredentialsServiceImpl

java.lang.Object

org.alfresco.repo.remotecredentials.RemoteCredentialsServiceImpl

All Implemented Interfaces:

RemoteCredentialsService

public class RemoteCredentialsServiceImpl
extends Object
implements RemoteCredentialsService

An Implementation of the RemoteCredentialsService

Since:

Odin

Author:

Nick Burch

Constructor Summary

Constructors

Constructor	Description
RemoteCredentialsServiceImpl()

Method Summary

Modifier and Type	Method	Description
BaseCredentialsInfo	createPersonCredentials(String remoteSystem, BaseCredentialsInfo credentials)	Stores a new BaseCredentialsInfo for the current user
BaseCredentialsInfo	createSharedCredentials(String remoteSystem, BaseCredentialsInfo credentials)	Stores a new BaseCredentialsInfo for shared use.
void	deleteCredentials(BaseCredentialsInfo credentialsInfo)	Deletes an existing BaseCredentialsInfo from the repository
protected Map<org.alfresco.service.namespace.QName,RemoteCredentialsInfoFactory>	getCredentialsFactories()	Provides a read only copy of the credentials factories, useful in unit tests
BaseCredentialsInfo	getPersonCredentials(String remoteSystem)	Fetches the credentials for the current user for the specified System.
protected org.alfresco.service.cmr.repository.NodeRef	getSharedContainerNodeRef(boolean required)	Gets the NodeRef of the holder of shared credentials remote systems.
protected static String	getSharedCredentialsSystemContainerName()	Unit testing use only!
protected static org.alfresco.service.namespace.QName	getSharedCredentialsSystemContainerQName()
org.alfresco.query.PagingResults<? extends BaseCredentialsInfo>	listAllCredentials(String remoteSystem, org.alfresco.service.namespace.QName credentialsType, org.alfresco.query.PagingRequest paging)	Lists all Credentials that the user has access to for the given Remote System
org.alfresco.query.PagingResults<String>	listAllRemoteSystems(org.alfresco.query.PagingRequest paging)	Lists all the Remote Systems for which the user has credentials, either personal ones or shared ones
org.alfresco.query.PagingResults<? extends BaseCredentialsInfo>	listPersonCredentials(String remoteSystem, org.alfresco.service.namespace.QName credentialsType, org.alfresco.query.PagingRequest paging)	Lists all Credentials for the current user for the given Remote System
org.alfresco.query.PagingResults<String>	listPersonRemoteSystems(org.alfresco.query.PagingRequest paging)	Lists all Remote Systems for which credentials are stored for the current user
org.alfresco.query.PagingResults<? extends BaseCredentialsInfo>	listSharedCredentials(String remoteSystem, org.alfresco.service.namespace.QName credentialsType, org.alfresco.query.PagingRequest paging)	Lists all Credentials that are shared with the current user for the given Remote System
org.alfresco.query.PagingResults<String>	listSharedRemoteSystems(org.alfresco.query.PagingRequest paging)	Lists all Remote Systems for which the user has access to shared credentials
void	registerCredentialsFactory(org.alfresco.service.namespace.QName credentialsType, RemoteCredentialsInfoFactory factory)	Registers a new Factory to produce BaseCredentialsInfo objects for a given data type.
void	setCredentialsFactories(Map<String,RemoteCredentialsInfoFactory> factories)	Registers a number of new factories
void	setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)
void	setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)
void	setRepositoryHelper(Repository repositoryHelper)
protected static void	setSharedCredentialsSystemContainerName(String container)	Unit testing use only! Used to avoid tests affecting the real system container
BaseCredentialsInfo	updateCredentials(BaseCredentialsInfo credentials)	Updates an existing BaseCredentialsInfo.
BaseCredentialsInfo	updateCredentialsAuthenticationSucceeded(boolean succeeded, BaseCredentialsInfo credentials)	Records if the most recent Authentication attempt with a given set of credentials worked or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteCredentialsServiceImpl

public RemoteCredentialsServiceImpl()

Method Detail

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setNamespaceService

public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)

setPermissionService

public void setPermissionService(org.alfresco.service.cmr.security.PermissionService permissionService)

setDictionaryService

public void setDictionaryService(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)

setRepositoryHelper

public void setRepositoryHelper(Repository repositoryHelper)

setCredentialsFactories

public void setCredentialsFactories(Map<String,RemoteCredentialsInfoFactory> factories)

Registers a number of new factories

registerCredentialsFactory

public void registerCredentialsFactory(org.alfresco.service.namespace.QName credentialsType,
                                       RemoteCredentialsInfoFactory factory)

Registers a new Factory to produce BaseCredentialsInfo objects for a given data type. This provides an alternative to setCredentialsFactories(Map) to allow the registering of a new type without overriding all of them.

Parameters:

credentialsType - The object type

factory - The Factory to use to create this type with

getCredentialsFactories

protected Map<org.alfresco.service.namespace.QName,RemoteCredentialsInfoFactory> getCredentialsFactories()

Provides a read only copy of the credentials factories, useful in unit tests

getSharedContainerNodeRef

protected org.alfresco.service.cmr.repository.NodeRef getSharedContainerNodeRef(boolean required)

Gets the NodeRef of the holder of shared credentials remote systems. This is stored under system Protected, so that unit tests can make use of it

deleteCredentials

public void deleteCredentials(BaseCredentialsInfo credentialsInfo)

Description copied from interface: RemoteCredentialsService

Deletes an existing BaseCredentialsInfo from the repository

Specified by:

deleteCredentials in interface RemoteCredentialsService

createPersonCredentials

public BaseCredentialsInfo createPersonCredentials(String remoteSystem,
                                                   BaseCredentialsInfo credentials)

Description copied from interface: RemoteCredentialsService

Stores a new BaseCredentialsInfo for the current user

Specified by:

createPersonCredentials in interface RemoteCredentialsService

createSharedCredentials

public BaseCredentialsInfo createSharedCredentials(String remoteSystem,
                                                   BaseCredentialsInfo credentials)

Description copied from interface: RemoteCredentialsService

Stores a new BaseCredentialsInfo for shared use. Permissions should then be set to control access to these.

Specified by:

createSharedCredentials in interface RemoteCredentialsService

getPersonCredentials

public BaseCredentialsInfo getPersonCredentials(String remoteSystem)

Description copied from interface: RemoteCredentialsService

Fetches the credentials for the current user for the specified System. If multiple credentials exist, the first is returned, so this should only be used for systems where a user is restricted to only one set of credentials per system.

Specified by:

getPersonCredentials in interface RemoteCredentialsService

Returns:

The Credentials, or Null if none exist for the current user

updateCredentials

public BaseCredentialsInfo updateCredentials(BaseCredentialsInfo credentials)

Description copied from interface: RemoteCredentialsService

Updates an existing BaseCredentialsInfo. The type must not change.

Specified by:

updateCredentials in interface RemoteCredentialsService

updateCredentialsAuthenticationSucceeded

public BaseCredentialsInfo updateCredentialsAuthenticationSucceeded(boolean succeeded,
                                                                    BaseCredentialsInfo credentials)

Description copied from interface: RemoteCredentialsService

Records if the most recent Authentication attempt with a given set of credentials worked or not.

Specified by:

updateCredentialsAuthenticationSucceeded in interface RemoteCredentialsService

listAllRemoteSystems

public org.alfresco.query.PagingResults<String> listAllRemoteSystems(org.alfresco.query.PagingRequest paging)

Description copied from interface: RemoteCredentialsService

Lists all the Remote Systems for which the user has credentials, either personal ones or shared ones

Specified by:

listAllRemoteSystems in interface RemoteCredentialsService

listPersonRemoteSystems

public org.alfresco.query.PagingResults<String> listPersonRemoteSystems(org.alfresco.query.PagingRequest paging)

Description copied from interface: RemoteCredentialsService

Lists all Remote Systems for which credentials are stored for the current user

Specified by:

listPersonRemoteSystems in interface RemoteCredentialsService

listSharedRemoteSystems

public org.alfresco.query.PagingResults<String> listSharedRemoteSystems(org.alfresco.query.PagingRequest paging)

Description copied from interface: RemoteCredentialsService

Lists all Remote Systems for which the user has access to shared credentials

Specified by:

listSharedRemoteSystems in interface RemoteCredentialsService

listSharedCredentials

public org.alfresco.query.PagingResults<? extends BaseCredentialsInfo> listSharedCredentials(String remoteSystem,
                                                                                             org.alfresco.service.namespace.QName credentialsType,
                                                                                             org.alfresco.query.PagingRequest paging)

Description copied from interface: RemoteCredentialsService

Lists all Credentials that are shared with the current user for the given Remote System

Specified by:

listSharedCredentials in interface RemoteCredentialsService

Parameters:

remoteSystem - The Remote System to return credentials for

credentialsType - Optional type (including child subtypes) of the credentials to filter by

listPersonCredentials

public org.alfresco.query.PagingResults<? extends BaseCredentialsInfo> listPersonCredentials(String remoteSystem,
                                                                                             org.alfresco.service.namespace.QName credentialsType,
                                                                                             org.alfresco.query.PagingRequest paging)

Description copied from interface: RemoteCredentialsService

Lists all Credentials for the current user for the given Remote System

Specified by:

listPersonCredentials in interface RemoteCredentialsService

Parameters:

remoteSystem - The Remote System to return credentials for

credentialsType - Optional type (including child subtypes) of the credentials to filter by

listAllCredentials

public org.alfresco.query.PagingResults<? extends BaseCredentialsInfo> listAllCredentials(String remoteSystem,
                                                                                          org.alfresco.service.namespace.QName credentialsType,
                                                                                          org.alfresco.query.PagingRequest paging)

Description copied from interface: RemoteCredentialsService

Lists all Credentials that the user has access to for the given Remote System

Specified by:

listAllCredentials in interface RemoteCredentialsService

Parameters:

remoteSystem - The Remote System to return credentials for

credentialsType - Optional type (including child subtypes) of the credentials to filter by

getSharedCredentialsSystemContainerName

protected static String getSharedCredentialsSystemContainerName()

Unit testing use only!

getSharedCredentialsSystemContainerQName

protected static org.alfresco.service.namespace.QName getSharedCredentialsSystemContainerQName()

setSharedCredentialsSystemContainerName

protected static void setSharedCredentialsSystemContainerName(String container)

Unit testing use only! Used to avoid tests affecting the real system container