inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-10-15 15:02:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

ACE-4598: ServiceRegistry exposes services that are not part of the public API

Browse Source 
Updated the deprecated message wording to make it clearer it's just the method on ServiceRegistry that's deprecated and not the service/object being returned.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@118420 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Gavin Cornwell
2015-11-24 12:01:01 +00:00
parent 2ecad935cf
commit 620e4d37d5
1 changed files with 54 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
source/java/org/alfresco/service/ServiceRegistry.java
View File

@@ -187,14 +187,16 @@ public interface ServiceRegistry
/** /**
* @return the descriptor service * @return the descriptor service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
DescriptorService getDescriptorService(); DescriptorService getDescriptorService();
/** /**
* @return the transaction service * @return the transaction service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
TransactionService getTransactionService(); TransactionService getTransactionService();
@@ -237,7 +239,8 @@ public interface ServiceRegistry
/** /**
* @return the content filter languages service (or null, if one is not provided) * @return the content filter languages service (or null, if one is not provided)
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
ContentFilterLanguagesService getContentFilterLanguagesService(); ContentFilterLanguagesService getContentFilterLanguagesService();
@@ -292,21 +295,24 @@ public interface ServiceRegistry
/** /**
* @return the importer service or null if not present * @return the importer service or null if not present
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
ImporterService getImporterService(); ImporterService getImporterService();
/** /**
* @return the exporter service or null if not present * @return the exporter service or null if not present
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
ExporterService getExporterService(); ExporterService getExporterService();
/** /**
* @return the rule service (or null, if one is not provided) * @return the rule service (or null, if one is not provided)
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
RuleService getRuleService(); RuleService getRuleService();
@@ -343,7 +349,8 @@ public interface ServiceRegistry
/** /**
* @return the script execution service (or null if one is not provided) * @return the script execution service (or null if one is not provided)
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
ScriptService getScriptService(); ScriptService getScriptService();
@@ -356,14 +363,16 @@ public interface ServiceRegistry
/** /**
* @return the notification service (or null if on is not provided) * @return the notification service (or null if on is not provided)
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
NotificationService getNotificationService(); NotificationService getNotificationService();
/** /**
* @return the audit service (or null if one is not provided) * @return the audit service (or null if one is not provided)
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
AuditService getAuditService(); AuditService getAuditService();
@@ -371,7 +380,8 @@ public interface ServiceRegistry
/** /**
* Get the ownable service (or null if one is not provided) * Get the ownable service (or null if one is not provided)
* @return OwnableService * @return OwnableService
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
OwnableService getOwnableService(); OwnableService getOwnableService();
@@ -396,21 +406,24 @@ public interface ServiceRegistry
/** /**
* Get the Multilingual Content Service * Get the Multilingual Content Service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
MultilingualContentService getMultilingualContentService(); MultilingualContentService getMultilingualContentService();
/** /**
* Get the Edition Service * Get the Edition Service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
EditionService getEditionService(); EditionService getEditionService();
/** /**
* Get the Thumbnail Service * Get the Thumbnail Service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
ThumbnailService getThumbnailService(); ThumbnailService getThumbnailService();
@@ -423,7 +436,8 @@ public interface ServiceRegistry
/** /**
* Get the form service (or null if one is not provided) * Get the form service (or null if one is not provided)
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
FormService getFormService(); FormService getFormService();
@@ -450,7 +464,8 @@ public interface ServiceRegistry
* Get the blog service (or null if one is not provided) * Get the blog service (or null if one is not provided)
* *
* @since 4.0 * @since 4.0
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
BlogService getBlogService(); BlogService getBlogService();
@@ -459,7 +474,8 @@ public interface ServiceRegistry
* Get the calendar service (or null if one is not provided) * Get the calendar service (or null if one is not provided)
* *
* @since 4.0 * @since 4.0
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
CalendarService getCalendarService(); CalendarService getCalendarService();
@@ -467,7 +483,8 @@ public interface ServiceRegistry
/** /**
* Get the invitation service (or null if one is not provided) * Get the invitation service (or null if one is not provided)
* @return the invitation service * @return the invitation service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
InvitationService getInvitationService(); InvitationService getInvitationService();
@@ -475,7 +492,8 @@ public interface ServiceRegistry
/** /**
* Get the CMIS Dictionary service (or null if one is not provided) * Get the CMIS Dictionary service (or null if one is not provided)
* @return the CMIS Dictionary service * @return the CMIS Dictionary service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
CMISDictionaryService getCMISDictionaryService(); CMISDictionaryService getCMISDictionaryService();
@@ -483,7 +501,8 @@ public interface ServiceRegistry
/** /**
* Get the CMIS Query service (or null if one is not provided) * Get the CMIS Query service (or null if one is not provided)
* @return the CMIS Query service * @return the CMIS Query service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
CMISQueryService getCMISQueryService(); CMISQueryService getCMISQueryService();
@@ -491,7 +510,8 @@ public interface ServiceRegistry
/** /**
* Get the IMAP service (or null if one is not provided) * Get the IMAP service (or null if one is not provided)
* @return the IMAP service * @return the IMAP service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
ImapService getImapService(); ImapService getImapService();
@@ -499,7 +519,8 @@ public interface ServiceRegistry
/** /**
* Get the Public Service Access service (or null if one is not provided) * Get the Public Service Access service (or null if one is not provided)
* @return the Public Service Access service * @return the Public Service Access service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
PublicServiceAccessService getPublicServiceAccessService(); PublicServiceAccessService getPublicServiceAccessService();
@@ -507,7 +528,8 @@ public interface ServiceRegistry
/** /**
* Get the repo admin service (or null if one is not provided) * Get the repo admin service (or null if one is not provided)
* @return the repo admin service * @return the repo admin service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
RepoAdminService getRepoAdminService(); RepoAdminService getRepoAdminService();
@@ -515,7 +537,8 @@ public interface ServiceRegistry
/** /**
* Get the sys admin params helper bean. * Get the sys admin params helper bean.
* @return the sys admin params bean. * @return the sys admin params bean.
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
SysAdminParams getSysAdminParams(); SysAdminParams getSysAdminParams();
@@ -523,7 +546,8 @@ public interface ServiceRegistry
/** /**
* Get the webdav service / helper bean. * Get the webdav service / helper bean.
* @return the webdav service / helper bean * @return the webdav service / helper bean
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
WebDavService getWebDavService(); WebDavService getWebDavService();
@@ -538,7 +562,8 @@ public interface ServiceRegistry
/** /**
* Get the Solr facet helper bean * Get the Solr facet helper bean
* @return the Solr facet helper bean * @return the Solr facet helper bean
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
SolrFacetHelper getSolrFacetHelper(); SolrFacetHelper getSolrFacetHelper();
@@ -546,7 +571,8 @@ public interface ServiceRegistry
/** /**
* Get the facet label display handler registry bean * Get the facet label display handler registry bean
* @return the Facet label display handler registry bean * @return the Facet label display handler registry bean
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
FacetLabelDisplayHandlerRegistry getFacetLabelDisplayHandlerRegistry(); FacetLabelDisplayHandlerRegistry getFacetLabelDisplayHandlerRegistry();
@@ -561,7 +587,8 @@ public interface ServiceRegistry
/** /**
* Get the document link service * Get the document link service
* @return the document link service * @return the document link service
* @deprecated This method returns a service that is not part of the public Java API. * @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.
*/ */
@NotAuditable @NotAuditable
DocumentLinkService getDocumentLinkService(); DocumentLinkService getDocumentLinkService();