Package org.alfresco.service

Interface ServiceRegistry

All Known Implementing Classes:
ServiceDescriptorRegistry
@AlfrescoPublicApi public interface ServiceRegistry
This interface represents the registry of public Repository Services. The registry provides meta-data about each service and provides access to the service interface.
Author:
David Caruana

  • Field Details

    • SERVICE_REGISTRY

      static final String SERVICE_REGISTRY
      See Also:

    • REGISTRY_SERVICE

      static final QName REGISTRY_SERVICE

    • DESCRIPTOR_SERVICE

      static final QName DESCRIPTOR_SERVICE

    • TRANSACTION_SERVICE

      static final QName TRANSACTION_SERVICE

    • RETRYING_TRANSACTION_HELPER

      static final QName RETRYING_TRANSACTION_HELPER

    • AUTHENTICATION_SERVICE

      static final QName AUTHENTICATION_SERVICE

    • NAMESPACE_SERVICE

      static final QName NAMESPACE_SERVICE

    • DICTIONARY_SERVICE

      static final QName DICTIONARY_SERVICE

    • NODE_SERVICE

      static final QName NODE_SERVICE

    • CONTENT_SERVICE

      static final QName CONTENT_SERVICE

    • SYNCHRONOUS_TRANSFORM_CLIENT

      static final QName SYNCHRONOUS_TRANSFORM_CLIENT

    • MIMETYPE_SERVICE

      static final QName MIMETYPE_SERVICE

    • CONTENT_FILTER_LANGUAGES_SERVICE

      static final QName CONTENT_FILTER_LANGUAGES_SERVICE

    • MULTILINGUAL_CONTENT_SERVICE

      static final QName MULTILINGUAL_CONTENT_SERVICE

    • EDITION_SERVICE

      static final QName EDITION_SERVICE

    • SEARCH_SERVICE

      static final QName SEARCH_SERVICE

    • CATEGORY_SERVICE

      static final QName CATEGORY_SERVICE

    • COPY_SERVICE

      static final QName COPY_SERVICE

    • LOCK_SERVICE

      static final QName LOCK_SERVICE

    • JOB_LOCK_SERVICE

      static final QName JOB_LOCK_SERVICE

    • VERSION_SERVICE

      static final QName VERSION_SERVICE

    • COCI_SERVICE

      static final QName COCI_SERVICE

    • RULE_SERVICE

      static final QName RULE_SERVICE

    • IMPORTER_SERVICE

      static final QName IMPORTER_SERVICE

    • EXPORTER_SERVICE

      static final QName EXPORTER_SERVICE

    • ACTION_SERVICE

      static final QName ACTION_SERVICE

    • PERMISSIONS_SERVICE

      static final QName PERMISSIONS_SERVICE

    • AUTHORITY_SERVICE

      static final QName AUTHORITY_SERVICE

    • TEMPLATE_SERVICE

      static final QName TEMPLATE_SERVICE

    • FILE_FOLDER_SERVICE

      static final QName FILE_FOLDER_SERVICE

    • SCRIPT_SERVICE

      static final QName SCRIPT_SERVICE

    • WORKFLOW_SERVICE

      static final QName WORKFLOW_SERVICE

    • AUDIT_SERVICE

      static final QName AUDIT_SERVICE

    • OWNABLE_SERVICE

      static final QName OWNABLE_SERVICE

    • PERSON_SERVICE

      static final QName PERSON_SERVICE

    • SITE_SERVICE

      static final QName SITE_SERVICE

    • ATTRIBUTE_SERVICE

      static final QName ATTRIBUTE_SERVICE

    • THUMBNAIL_SERVICE

      static final QName THUMBNAIL_SERVICE

    • TAGGING_SERVICE

      static final QName TAGGING_SERVICE

    • FORM_SERVICE

      static final QName FORM_SERVICE

    • INVITATION_SERVICE

      static final QName INVITATION_SERVICE

    • PREFERENCE_SERVICE

      static final QName PREFERENCE_SERVICE

    • RENDITION_SERVICE

      static final QName RENDITION_SERVICE

    • RATING_SERVICE

      static final QName RATING_SERVICE

    • REPO_ADMIN_SERVICE

      static final QName REPO_ADMIN_SERVICE

    • NODE_LOCATOR_SERVICE

      static final QName NODE_LOCATOR_SERVICE

    • BLOG_SERVICE

      static final QName BLOG_SERVICE

    • CALENDAR_SERVICE

      static final QName CALENDAR_SERVICE

    • NOTIFICATION_SERVICE

      static final QName NOTIFICATION_SERVICE

    • MESSAGE_SERVICE

      static final QName MESSAGE_SERVICE

    • CMIS_SERVICE

      static final QName CMIS_SERVICE

    • CMIS_DICTIONARY_SERVICE

      static final QName CMIS_DICTIONARY_SERVICE

    • CMIS_QUERY_SERVICE

      static final QName CMIS_QUERY_SERVICE

    • IMAP_SERVICE

      static final QName IMAP_SERVICE

    • PUBLIC_SERVICE_ACCESS_SERVICE

      static final QName PUBLIC_SERVICE_ACCESS_SERVICE

    • WEBDAV_SERVICE

      static final QName WEBDAV_SERVICE

    • MODULE_SERVICE

      static final QName MODULE_SERVICE

    • POLICY_COMPONENT

      static final QName POLICY_COMPONENT

    • RENDITION_SERVICE_2

      static final QName RENDITION_SERVICE_2

  • Method Details

    • getServices

      @NotAuditable Collection<QName> getServices()
      Get the list of services provided by the Repository
      Returns:
      list of provided Services

    • isServiceProvided

      @NotAuditable boolean isServiceProvided(QName service)
      Is the specified service provided by the Repository?
      Parameters:
      service - name of service to test provision of
      Returns:
      true => provided, false => not provided

    • getService

      @NotAuditable Object getService(QName service)
      Get the specified service.
      Parameters:
      service - name of service to retrieve
      Returns:
      the service interface (must cast to interface as described in service meta-data)

    • getDescriptorService

      @NotAuditable DescriptorService getDescriptorService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Returns:
      the descriptor service

    • getTransactionService

      @NotAuditable TransactionService getTransactionService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Returns:
      the transaction service

    • getRetryingTransactionHelper

      @NotAuditable RetryingTransactionHelper getRetryingTransactionHelper()
      Returns:
      a new instance of the RetryingTransactionHelper

    • getNamespaceService

      @NotAuditable NamespaceService getNamespaceService()
      Returns:
      the namespace service (or null, if one is not provided)

    • getAuthenticationService

      @NotAuditable MutableAuthenticationService getAuthenticationService()
      Returns:
      the authentication service (or null, if one is not provided)

    • getNodeService

      @NotAuditable NodeService getNodeService()
      Returns:
      the node service (or null, if one is not provided)

    • getContentService

      @NotAuditable ContentService getContentService()
      Returns:
      the content service (or null, if one is not provided)

    • getMimetypeService

      @NotAuditable MimetypeService getMimetypeService()
      Returns:
      the mimetype service (or null, if one is not provided)

    • getContentFilterLanguagesService

      @NotAuditable ContentFilterLanguagesService getContentFilterLanguagesService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Returns:
      the content filter languages service (or null, if one is not provided)

    • getSearchService

      @NotAuditable SearchService getSearchService()
      Returns:
      the search service (or null, if one is not provided)

    • getVersionService

      @NotAuditable VersionService getVersionService()
      Returns:
      the version service (or null, if one is not provided)

    • getLockService

      @NotAuditable LockService getLockService()
      Returns:
      the lock service (or null, if one is not provided)

    • getJobLockService

      @NotAuditable JobLockService getJobLockService()
      Returns:
      the job lock service (or null, if one is not provided)

    • getDictionaryService

      @NotAuditable DictionaryService getDictionaryService()
      Returns:
      the dictionary service (or null, if one is not provided)

    • getCopyService

      @NotAuditable CopyService getCopyService()
      Returns:
      the copy service (or null, if one is not provided)

    • getCheckOutCheckInService

      @NotAuditable CheckOutCheckInService getCheckOutCheckInService()
      Returns:
      the checkout / checkin service (or null, if one is not provided)

    • getCategoryService

      @NotAuditable CategoryService getCategoryService()
      Returns:
      the category service (or null, if one is not provided)

    • getImporterService

      @NotAuditable ImporterService getImporterService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Returns:
      the importer service or null if not present

    • getExporterService

      @NotAuditable ExporterService getExporterService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Returns:
      the exporter service or null if not present

    • getRuleService

      @NotAuditable RuleService getRuleService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Returns:
      the rule service (or null, if one is not provided)

    • getActionService

      @NotAuditable ActionService getActionService()
      Returns:
      the action service (or null if one is not provided)

    • getPermissionService

      @NotAuditable PermissionService getPermissionService()
      Returns:
      the permission service (or null if one is not provided)

    • getAuthorityService

      @NotAuditable AuthorityService getAuthorityService()
      Returns:
      the authority service (or null if one is not provided)

    • getTemplateService

      @NotAuditable TemplateService getTemplateService()
      Returns:
      the template service (or null if one is not provided)

    • getFileFolderService

      @NotAuditable FileFolderService getFileFolderService()
      Returns:
      the file-folder manipulation service (or null if one is not provided)

    • getScriptService

      @NotAuditable ScriptService getScriptService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Returns:
      the script execution service (or null if one is not provided)

    • getWorkflowService

      @NotAuditable WorkflowService getWorkflowService()
      Returns:
      the workflow service (or null if one is not provided)

    • getNotificationService

      @NotAuditable NotificationService getNotificationService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Returns:
      the notification service (or null if on is not provided)

    • getAuditService

      @NotAuditable AuditService getAuditService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Returns:
      the audit service (or null if one is not provided)

    • getOwnableService

      @NotAuditable OwnableService getOwnableService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the ownable service (or null if one is not provided)
      Returns:
      OwnableService

    • getPersonService

      @NotAuditable PersonService getPersonService()
      Get the person service (or null if one is not provided)

    • getSiteService

      @NotAuditable SiteService getSiteService()
      Get the site service (or null if one is not provided)

    • getAttributeService

      @NotAuditable AttributeService getAttributeService()
      Get the attribute service (or null if one is not provided)

    • getMultilingualContentService

      @NotAuditable MultilingualContentService getMultilingualContentService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the Multilingual Content Service

    • getEditionService

      @NotAuditable EditionService getEditionService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the Edition Service

    • getThumbnailService

      @Deprecated @NotAuditable ThumbnailService getThumbnailService()
      Deprecated.
      The thumbnails code is being moved out of the codebase and replaced by the new async RenditionService2 or other external libraries.

    • getTaggingService

      @NotAuditable TaggingService getTaggingService()
      Get the Tagging Service

    • getFormService

      @NotAuditable FormService getFormService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the form service (or null if one is not provided)

    • getRenditionService

      @Deprecated @NotAuditable RenditionService getRenditionService()
      Deprecated.
      The RenditionService is being replace by the simpler async RenditionService2.
      Get the rendition service (or null if one is not provided)

    • getRatingService

      @NotAuditable RatingService getRatingService()
      Get the rating service (or null if one is not provided)

    • getNodeLocatorService

      @NotAuditable NodeLocatorService getNodeLocatorService()
      Get the node locator service (or null if one is not provided)

    • getBlogService

      @NotAuditable BlogService getBlogService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the blog service (or null if one is not provided)
      Since:
      4.0

    • getCalendarService

      @NotAuditable CalendarService getCalendarService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the calendar service (or null if one is not provided)
      Since:
      4.0

    • getInvitationService

      @NotAuditable InvitationService getInvitationService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the invitation service (or null if one is not provided)
      Returns:
      the invitation service

    • getCMISDictionaryService

      @NotAuditable CMISDictionaryService getCMISDictionaryService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the CMIS Dictionary service (or null if one is not provided)
      Returns:
      the CMIS Dictionary service

    • getCMISQueryService

      @NotAuditable CMISQueryService getCMISQueryService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the CMIS Query service (or null if one is not provided)
      Returns:
      the CMIS Query service

    • getImapService

      @NotAuditable ImapService getImapService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the IMAP service (or null if one is not provided)
      Returns:
      the IMAP service

    • getPublicServiceAccessService

      @NotAuditable PublicServiceAccessService getPublicServiceAccessService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the Public Service Access service (or null if one is not provided)
      Returns:
      the Public Service Access service

    • getRepoAdminService

      @NotAuditable RepoAdminService getRepoAdminService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the repo admin service (or null if one is not provided)
      Returns:
      the repo admin service

    • getSysAdminParams

      @NotAuditable SysAdminParams getSysAdminParams()
      Deprecated.
      This method has been deprecated as it would return an object that is not part of the public API. The object itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the sys admin params helper bean.
      Returns:
      the sys admin params bean.

    • getWebDavService

      @NotAuditable WebDavService getWebDavService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the webdav service / helper bean.
      Returns:
      the webdav service / helper bean

    • getModuleService

      @NotAuditable ModuleService getModuleService()
      Get the module service bean.
      Returns:
      the module service bean

    • getSolrFacetHelper

      @NotAuditable SolrFacetHelper getSolrFacetHelper()
      Deprecated.
      This method has been deprecated as it would return an object that is not part of the public API. The object itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the Solr facet helper bean
      Returns:
      the Solr facet helper bean

    • getFacetLabelDisplayHandlerRegistry

      @NotAuditable FacetLabelDisplayHandlerRegistry getFacetLabelDisplayHandlerRegistry()
      Deprecated.
      This method has been deprecated as it would return an object that is not part of the public API. The object itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the facet label display handler registry bean
      Returns:
      the Facet label display handler registry bean

    • getMessageService

      @NotAuditable MessageService getMessageService()
      Get the Message service bean.
      Returns:
      the Message service bean

    • getDocumentLinkService

      @NotAuditable DocumentLinkService getDocumentLinkService()
      Deprecated.
      This method has been deprecated as it would return a service that is not part of the public API. The service itself is not deprecated, but access to it via the ServiceRegistry will be removed in the future.
      Get the document link service
      Returns:
      the document link service

    • getPolicyComponent

      @NotAuditable PolicyComponent getPolicyComponent()
      Get the policy component
      Returns:
      The policy component

    • getRenditionService2

      @NotAuditable RenditionService2 getRenditionService2()
      Get the async rendition service component
      Returns:
      The async rendition component

    • getSynchronousTransformClient

      @NotAuditable default SynchronousTransformClient getSynchronousTransformClient()
      Returns:
      the synchronous transform client (or null, if one is not provided)