Package org.alfresco.repo.service

Class ServiceDescriptorRegistry

java.lang.Object

org.alfresco.repo.service.ServiceDescriptorRegistry

All Implemented Interfaces:

ServiceRegistry, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware

public class ServiceDescriptorRegistry
extends Object
implements org.springframework.beans.factory.BeanFactoryAware, ServiceRegistry

Implementation of a Service Registry based on the definition of Services contained within a Spring Bean Factory.

Author:

David Caruana

Field Summary

Fields inherited from interface org.alfresco.service.ServiceRegistry

ACTION_SERVICE, ATTRIBUTE_SERVICE, AUDIT_SERVICE, AUTHENTICATION_SERVICE, AUTHORITY_SERVICE, BLOG_SERVICE, CALENDAR_SERVICE, CATEGORY_SERVICE, CMIS_DICTIONARY_SERVICE, CMIS_QUERY_SERVICE, CMIS_SERVICE, COCI_SERVICE, CONTENT_FILTER_LANGUAGES_SERVICE, CONTENT_SERVICE, COPY_SERVICE, DESCRIPTOR_SERVICE, DICTIONARY_SERVICE, DOCUMENT_LINK_SERVICE, EDITION_SERVICE, EXPORTER_SERVICE, FILE_FOLDER_SERVICE, FORM_SERVICE, IMAP_SERVICE, IMPORTER_SERVICE, INVITATION_SERVICE, JOB_LOCK_SERVICE, LOCK_SERVICE, MESSAGE_SERVICE, MIMETYPE_SERVICE, MODULE_SERVICE, MULTILINGUAL_CONTENT_SERVICE, NAMESPACE_SERVICE, NODE_LOCATOR_SERVICE, NODE_SERVICE, NOTIFICATION_SERVICE, OWNABLE_SERVICE, PERMISSIONS_SERVICE, PERSON_SERVICE, POLICY_COMPONENT, PREFERENCE_SERVICE, PUBLIC_SERVICE_ACCESS_SERVICE, RATING_SERVICE, REGISTRY_SERVICE, RENDITION_SERVICE, RENDITION_SERVICE_2, REPO_ADMIN_SERVICE, RETRYING_TRANSACTION_HELPER, RULE_SERVICE, SCRIPT_SERVICE, SEARCH_SERVICE, SERVICE_REGISTRY, SITE_SERVICE, SYNCHRONOUS_TRANSFORM_CLIENT, TAGGING_SERVICE, TEMPLATE_SERVICE, THUMBNAIL_SERVICE, TRANSACTION_SERVICE, VERSION_SERVICE, WEBDAV_SERVICE, WORKFLOW_SERVICE

Constructor Summary

Constructors

Constructor	Description
ServiceDescriptorRegistry()

Method Summary

Modifier and Type	Method	Description
ActionService	getActionService()
AttributeService	getAttributeService()	Get the attribute service (or null if one is not provided)
AuditService	getAuditService()
MutableAuthenticationService	getAuthenticationService()
AuthorityService	getAuthorityService()
BlogService	getBlogService()	Get the blog service (or null if one is not provided)
CalendarService	getCalendarService()	Get the calendar service (or null if one is not provided)
CategoryService	getCategoryService()
CheckOutCheckInService	getCheckOutCheckInService()
CMISDictionaryService	getCMISDictionaryService()	Get the CMIS Dictionary service (or null if one is not provided)
CMISQueryService	getCMISQueryService()	Get the CMIS Query service (or null if one is not provided)
ContentFilterLanguagesService	getContentFilterLanguagesService()
ContentService	getContentService()
CopyService	getCopyService()
DescriptorService	getDescriptorService()
DictionaryService	getDictionaryService()
DocumentLinkService	getDocumentLinkService()	Get the document link service
EditionService	getEditionService()	Get the Edition Service
ExporterService	getExporterService()
FacetLabelDisplayHandlerRegistry	getFacetLabelDisplayHandlerRegistry()	Get the facet label display handler registry bean
FileFolderService	getFileFolderService()
FormService	getFormService()	Get the form service (or null if one is not provided)
ImapService	getImapService()	Get the IMAP service (or null if one is not provided)
ImporterService	getImporterService()
InvitationService	getInvitationService()	Get the invitation service (or null if one is not provided)
JobLockService	getJobLockService()
LockService	getLockService()
MessageService	getMessageService()	Get the Message service bean.
MimetypeService	getMimetypeService()
ModuleService	getModuleService()	Get the module service bean.
MultilingualContentService	getMultilingualContentService()	Get the Multilingual Content Service
NamespaceService	getNamespaceService()
NodeLocatorService	getNodeLocatorService()	Get the node locator service (or null if one is not provided)
NodeService	getNodeService()
NotificationService	getNotificationService()
OwnableService	getOwnableService()	Get the ownable service (or null if one is not provided)
PermissionService	getPermissionService()
PersonService	getPersonService()	Get the person service (or null if one is not provided)
PolicyComponent	getPolicyComponent()	Get the policy component
PublicServiceAccessService	getPublicServiceAccessService()	Get the Public Service Access service (or null if one is not provided)
RatingService	getRatingService()	Get the rating service (or null if one is not provided)
RenditionService	getRenditionService()	Deprecated. The RenditionService is being replace by the simpler async RenditionService2.
RenditionService2	getRenditionService2()	Get the async rendition service component
RepoAdminService	getRepoAdminService()	Get the repo admin service (or null if one is not provided)
RetryingTransactionHelper	getRetryingTransactionHelper()
RuleService	getRuleService()
ScriptService	getScriptService()
SearchService	getSearchService()
Object	getService(QName service)	Get the specified service.
Collection<QName>	getServices()	Get the list of services provided by the Repository
SiteService	getSiteService()	Get the site service (or null if one is not provided)
SolrFacetHelper	getSolrFacetHelper()	Get the Solr facet helper bean
SynchronousTransformClient	getSynchronousTransformClient()
SysAdminParams	getSysAdminParams()	Get the sys admin params helper bean.
TaggingService	getTaggingService()	Get the Tagging Service
TemplateService	getTemplateService()
ThumbnailService	getThumbnailService()	Deprecated. The thumbnails code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.
TransactionService	getTransactionService()
VersionService	getVersionService()
WebDavService	getWebDavService()	Get the webdav service / helper bean.
WorkflowService	getWorkflowService()
boolean	isServiceProvided(QName service)	Is the specified service provided by the Repository?
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
void	setMockSearchService(SearchService mockSearchService)	For use in test classes only that need to mock the searchServices.

Methods inherited from class java.lang.Object

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

Constructor Details

ServiceDescriptorRegistry

public ServiceDescriptorRegistry()

Method Details

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
                    throws org.springframework.beans.BeansException

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

Throws:

org.springframework.beans.BeansException

getServices

public Collection<QName> getServices()

Description copied from interface: ServiceRegistry

Get the list of services provided by the Repository

Specified by:

getServices in interface ServiceRegistry

Returns:

list of provided Services

Throws:

UnsupportedOperationException - always

isServiceProvided

public boolean isServiceProvided(QName service)

Description copied from interface: ServiceRegistry

Is the specified service provided by the Repository?

Specified by:

isServiceProvided in interface ServiceRegistry

Parameters:

service - name of service to test provision of

Returns:

true => provided, false => not provided

Throws:

UnsupportedOperationException - always

getService

public Object getService(QName service)

Description copied from interface: ServiceRegistry

Get the specified service.

Specified by:

getService in interface ServiceRegistry

Parameters:

service - name of service to retrieve

Returns:

the service interface (must cast to interface as described in service meta-data)

getDescriptorService

public DescriptorService getDescriptorService()

Specified by:

getDescriptorService in interface ServiceRegistry

Returns:

the descriptor service

getNodeService

public NodeService getNodeService()

Specified by:

getNodeService in interface ServiceRegistry

Returns:

the node service (or null, if one is not provided)

getAuthenticationService

public MutableAuthenticationService getAuthenticationService()

Specified by:

getAuthenticationService in interface ServiceRegistry

Returns:

the authentication service (or null, if one is not provided)

getContentService

public ContentService getContentService()

Specified by:

getContentService in interface ServiceRegistry

Returns:

the content service (or null, if one is not provided)

getSynchronousTransformClient

public SynchronousTransformClient getSynchronousTransformClient()

Specified by:

getSynchronousTransformClient in interface ServiceRegistry

Returns:

the synchronous transform client (or null, if one is not provided)

getMimetypeService

public MimetypeService getMimetypeService()

Specified by:

getMimetypeService in interface ServiceRegistry

Returns:

the mimetype service (or null, if one is not provided)

getVersionService

public VersionService getVersionService()

Specified by:

getVersionService in interface ServiceRegistry

Returns:

the version service (or null, if one is not provided)

getLockService

public LockService getLockService()

Specified by:

getLockService in interface ServiceRegistry

Returns:

the lock service (or null, if one is not provided)

getJobLockService

public JobLockService getJobLockService()

Specified by:

getJobLockService in interface ServiceRegistry

Returns:

the job lock service (or null, if one is not provided)

getDictionaryService

public DictionaryService getDictionaryService()

Specified by:

getDictionaryService in interface ServiceRegistry

Returns:

the dictionary service (or null, if one is not provided)

getSearchService

public SearchService getSearchService()

Specified by:

getSearchService in interface ServiceRegistry

Returns:

the search service (or null, if one is not provided)

setMockSearchService

public void setMockSearchService(SearchService mockSearchService)

For use in test classes only that need to mock the searchServices.

Parameters:

mockSearchService - to be set. If null the next call to getSearchService() will return the real search service from the context.

getTransactionService

public TransactionService getTransactionService()

Specified by:

getTransactionService in interface ServiceRegistry

Returns:

the transaction service

getRetryingTransactionHelper

public RetryingTransactionHelper getRetryingTransactionHelper()

Specified by:

getRetryingTransactionHelper in interface ServiceRegistry

Returns:

a new instance of the RetryingTransactionHelper

getCopyService

public CopyService getCopyService()

Specified by:

getCopyService in interface ServiceRegistry

Returns:

the copy service (or null, if one is not provided)

getCheckOutCheckInService

public CheckOutCheckInService getCheckOutCheckInService()

Specified by:

getCheckOutCheckInService in interface ServiceRegistry

Returns:

the checkout / checkin service (or null, if one is not provided)

getCategoryService

public CategoryService getCategoryService()

Specified by:

getCategoryService in interface ServiceRegistry

Returns:

the category service (or null, if one is not provided)

getNamespaceService

public NamespaceService getNamespaceService()

Specified by:

getNamespaceService in interface ServiceRegistry

Returns:

the namespace service (or null, if one is not provided)

getImporterService

public ImporterService getImporterService()

Specified by:

getImporterService in interface ServiceRegistry

Returns:

the importer service or null if not present

getExporterService

public ExporterService getExporterService()

Specified by:

getExporterService in interface ServiceRegistry

Returns:

the exporter service or null if not present

getRuleService

public RuleService getRuleService()

Specified by:

getRuleService in interface ServiceRegistry

Returns:

the rule service (or null, if one is not provided)

getActionService

public ActionService getActionService()

Specified by:

getActionService in interface ServiceRegistry

Returns:

the action service (or null if one is not provided)

getPermissionService

public PermissionService getPermissionService()

Specified by:

getPermissionService in interface ServiceRegistry

Returns:

the permission service (or null if one is not provided)

getAuthorityService

public AuthorityService getAuthorityService()

Specified by:

getAuthorityService in interface ServiceRegistry

Returns:

the authority service (or null if one is not provided)

getTemplateService

public TemplateService getTemplateService()

Specified by:

getTemplateService in interface ServiceRegistry

Returns:

the template service (or null if one is not provided)

getFileFolderService

public FileFolderService getFileFolderService()

Specified by:

getFileFolderService in interface ServiceRegistry

Returns:

the file-folder manipulation service (or null if one is not provided)

getScriptService

public ScriptService getScriptService()

Specified by:

getScriptService in interface ServiceRegistry

Returns:

the script execution service (or null if one is not provided)

getWorkflowService

public WorkflowService getWorkflowService()

Specified by:

getWorkflowService in interface ServiceRegistry

Returns:

the workflow service (or null if one is not provided)

getNotificationService

public NotificationService getNotificationService()

Specified by:

getNotificationService in interface ServiceRegistry

Returns:

the notification service (or null if on is not provided)

getAuditService

public AuditService getAuditService()

Specified by:

getAuditService in interface ServiceRegistry

Returns:

the audit service (or null if one is not provided)

getOwnableService

public OwnableService getOwnableService()

Description copied from interface: ServiceRegistry

Get the ownable service (or null if one is not provided)

Specified by:

getOwnableService in interface ServiceRegistry

Returns:

OwnableService

getPersonService

public PersonService getPersonService()

Description copied from interface: ServiceRegistry

Get the person service (or null if one is not provided)

Specified by:

getPersonService in interface ServiceRegistry

getSiteService

public SiteService getSiteService()

Description copied from interface: ServiceRegistry

Get the site service (or null if one is not provided)

Specified by:

getSiteService in interface ServiceRegistry

getAttributeService

public AttributeService getAttributeService()

Description copied from interface: ServiceRegistry

Get the attribute service (or null if one is not provided)

Specified by:

getAttributeService in interface ServiceRegistry

getContentFilterLanguagesService

public ContentFilterLanguagesService getContentFilterLanguagesService()

Specified by:

getContentFilterLanguagesService in interface ServiceRegistry

Returns:

the content filter languages service (or null, if one is not provided)

getEditionService

public EditionService getEditionService()

Description copied from interface: ServiceRegistry

Get the Edition Service

Specified by:

getEditionService in interface ServiceRegistry

getMultilingualContentService

public MultilingualContentService getMultilingualContentService()

Description copied from interface: ServiceRegistry

Get the Multilingual Content Service

Specified by:

getMultilingualContentService in interface ServiceRegistry

getThumbnailService

@Deprecated
public ThumbnailService getThumbnailService()

Deprecated.

The thumbnails code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.

Specified by:

getThumbnailService in interface ServiceRegistry

getTaggingService

public TaggingService getTaggingService()

Description copied from interface: ServiceRegistry

Get the Tagging Service

Specified by:

getTaggingService in interface ServiceRegistry

getFormService

public FormService getFormService()

Description copied from interface: ServiceRegistry

Get the form service (or null if one is not provided)

Specified by:

getFormService in interface ServiceRegistry

getRenditionService

@Deprecated
public RenditionService getRenditionService()

Deprecated.

The RenditionService is being replace by the simpler async RenditionService2.

Description copied from interface: ServiceRegistry

Get the rendition service (or null if one is not provided)

Specified by:

getRenditionService in interface ServiceRegistry

getRatingService

public RatingService getRatingService()

Description copied from interface: ServiceRegistry

Get the rating service (or null if one is not provided)

Specified by:

getRatingService in interface ServiceRegistry

getNodeLocatorService

public NodeLocatorService getNodeLocatorService()

Description copied from interface: ServiceRegistry

Get the node locator service (or null if one is not provided)

Specified by:

getNodeLocatorService in interface ServiceRegistry

getBlogService

public BlogService getBlogService()

Description copied from interface: ServiceRegistry

Get the blog service (or null if one is not provided)

Specified by:

getBlogService in interface ServiceRegistry

getCalendarService

public CalendarService getCalendarService()

Description copied from interface: ServiceRegistry

Get the calendar service (or null if one is not provided)

Specified by:

getCalendarService in interface ServiceRegistry

getInvitationService

public InvitationService getInvitationService()

Description copied from interface: ServiceRegistry

Get the invitation service (or null if one is not provided)

Specified by:

getInvitationService in interface ServiceRegistry

Returns:

the invitation service

getCMISDictionaryService

public CMISDictionaryService getCMISDictionaryService()

Description copied from interface: ServiceRegistry

Get the CMIS Dictionary service (or null if one is not provided)

Specified by:

getCMISDictionaryService in interface ServiceRegistry

Returns:

the CMIS Dictionary service

getCMISQueryService

public CMISQueryService getCMISQueryService()

Description copied from interface: ServiceRegistry

Get the CMIS Query service (or null if one is not provided)

Specified by:

getCMISQueryService in interface ServiceRegistry

Returns:

the CMIS Query service

getImapService

public ImapService getImapService()

Description copied from interface: ServiceRegistry

Get the IMAP service (or null if one is not provided)

Specified by:

getImapService in interface ServiceRegistry

Returns:

the IMAP service

getPublicServiceAccessService

public PublicServiceAccessService getPublicServiceAccessService()

Description copied from interface: ServiceRegistry

Get the Public Service Access service (or null if one is not provided)

Specified by:

getPublicServiceAccessService in interface ServiceRegistry

Returns:

the Public Service Access service

getRepoAdminService

public RepoAdminService getRepoAdminService()

Description copied from interface: ServiceRegistry

Get the repo admin service (or null if one is not provided)

Specified by:

getRepoAdminService in interface ServiceRegistry

Returns:

the repo admin service

getSysAdminParams

public SysAdminParams getSysAdminParams()

Description copied from interface: ServiceRegistry

Get the sys admin params helper bean.

Specified by:

getSysAdminParams in interface ServiceRegistry

Returns:

the sys admin params bean.

getWebDavService

public WebDavService getWebDavService()

Description copied from interface: ServiceRegistry

Get the webdav service / helper bean.

Specified by:

getWebDavService in interface ServiceRegistry

Returns:

the webdav service / helper bean

getModuleService

public ModuleService getModuleService()

Description copied from interface: ServiceRegistry

Get the module service bean.

Specified by:

getModuleService in interface ServiceRegistry

Returns:

the module service bean

getSolrFacetHelper

public SolrFacetHelper getSolrFacetHelper()

Description copied from interface: ServiceRegistry

Get the Solr facet helper bean

Specified by:

getSolrFacetHelper in interface ServiceRegistry

Returns:

the Solr facet helper bean

getFacetLabelDisplayHandlerRegistry

public FacetLabelDisplayHandlerRegistry getFacetLabelDisplayHandlerRegistry()

Description copied from interface: ServiceRegistry

Get the facet label display handler registry bean

Specified by:

getFacetLabelDisplayHandlerRegistry in interface ServiceRegistry

Returns:

the Facet label display handler registry bean

getMessageService

public MessageService getMessageService()

Description copied from interface: ServiceRegistry

Get the Message service bean.

Specified by:

getMessageService in interface ServiceRegistry

Returns:

the Message service bean

getDocumentLinkService

public DocumentLinkService getDocumentLinkService()

Description copied from interface: ServiceRegistry

Get the document link service

Specified by:

getDocumentLinkService in interface ServiceRegistry

Returns:

the document link service

getPolicyComponent

public PolicyComponent getPolicyComponent()

Description copied from interface: ServiceRegistry

Get the policy component

Specified by:

getPolicyComponent in interface ServiceRegistry

Returns:

The policy component

getRenditionService2

public RenditionService2 getRenditionService2()

Description copied from interface: ServiceRegistry

Get the async rendition service component

Specified by:

getRenditionService2 in interface ServiceRegistry

Returns:

The async rendition component