Package com.appiancorp.suiteapi.common
Class ServiceLocator
java.lang.Object
com.appiancorp.suiteapi.common.ServiceLocator
- All Implemented Interfaces:
ServiceName
Deprecated.
Use services injected by the Appian plug-in framework instead.
This Factory class provides the functionality to request and return instances of services
available in the application. Service instances can be requested by calling
ServiceLocator.getXService() method, where X is the name of the Service.
getXService() is overloaded to take 3 types of arguments.
The following example shows the way to access service using
-
ServiceLocator.getXService(serviceContext)
ServiceLocator.getXService( HttpServlet, HttpSession)
ServiceLocator.getXService( User )
The following example shows the way to access service using
ServiceContext
. An instance
of ServiceContext should be created first by using one of the Factory methods provided
in WebServiceContextFactory
. import com.appiancorp.services.WebServiceContextFactory;
ServiceContext context = WebServiceContextFactory.getServiceContext( session );
ServiceContext is created for a specific for a user. WebServiceContextFactory provides multiple methods to generate ServiceContext. These methods are:
-
//Use User object as ASLIdentity parameter
WebServiceContextFactory.getServiceContext(ASLIdentity)
-
//User object is detected from the session. This method will fail if the session does not have
User Object.
WebServiceContextFactory.getServiceContext(HttpServletRequest)
-
//Detects if the a ServiceContext already exists for the user in the Session. If not creates a
new one.
WebServiceContextFactory.getServiceContext(HttpServletRequest, ASLIdentity)
-
//Creates a new ASLIdentity object from the String parameter and calls the method above
WebServiceContextFactory.getServiceContext(HttpServletRequest, String)
-
//Finds the User object from the session and creates a new ServiceContext object.
WebServiceContextFactory.getServiceContext(HttpSession)
-
//Creats a new ASLIdentity object from the String parameter and then creats ServiceContext
object.
WebServiceContextFactory.getServiceContext(String)
Once the ServiceContext object is created, the Service instance can be created by calling the following method.
ProcessExecutionService pes = ServiceLocator.getProcessExecutionService( context );
Note: Use of this class to obtain services for use in plug-ins is not supported. Instead, inject the
services you need by passing the *Service
classes as parameters to the smart service's
constructor.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Deprecated.UseServiceContextFactory.ADMIN_USERNAME
insteadstatic final String
Deprecated.This API is being phased out and will be removed in a future release.Fields inherited from interface com.appiancorp.suiteapi.common.ServiceName
ADMIN_CONSOLE_SERVICE, APPLICATION_SERVICE, BODY_SERVICE, CALENDAR_SERVICE, COLLAB_ADMINISTRATION_SERVICE, COLLAB_COMMUNITY_SERVICE, COLLAB_DOCUMENT_SERVICE, COLLAB_FOLDER_SERVICE, COLLAB_KNOWLEDGECENTER_SERVICE, COLLAB_REPORTING_SERVICE, COLLAB_SEARCH_SERVICE, COLLAB_STATISTICS_SERVICE, COLLAB_USER_SERVICE, CONTENT_SERVICE, CONTENT_STATISTICS_SERVICE, CONVENIENCE_SERVICE, DESIGN_EXPRESSION_SERVICE, DISCUSSION_PORTLET_SERVICE, EXECUTION_EXPRESSION_SERVICE, EXPRESSION_EVALUATION_SERVICE, EXPRESSION_SERVICE, FORUMS_SEARCH_SERVICE, GLOBALIZATION_SERVICE, GROUP_SERVICE, GROUPMESSAGE_SERVICE, GROUPTYPE_SERVICE, JMS_CONNECTION_FACTORY, LEADER_MESSAGE_SERVICE, LINKS_SERVICE, MESSAGE_PUBLISHER_SERVICE, METADATA_SERVICE, MINI_BODY_SERVICE, MINI_METADATA_SERVICE, NAV_SERVICE, NAVIGATION_SERVICE, NOTIFICATION_SERVICE, OBJECT_METADATA_ADMINISTRATION_SERVICE, OBJECT_METADATA_SERVICE, PAGE_SERVICE, PERSONALIZATION_SEARCH_SERVICE, PORTAL_ADMINISTRATION_SERVICE, PORTAL_NOTIFICATION_SERVICE, PORTLET_SERVICE, PROCESS_ADMINISTRATION_SERVICE, PROCESS_ANALYTICS2_SERVICE, PROCESS_DESIGN_SERVICE, PROCESS_EXCEPTION_HANDLER_SERVICE, PROCESS_EXECUTION_SERVICE, PROCESS_NOTES_CONTENT_SERVICE, PROCESS_PORT_SERVICE, SYNCHRONIZATION_SERVICE, TYPE_SERVICE, USER_SERVICE, USERPROFILE_SERVICE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
addServices
(String serviceConfig) Deprecated.This API is being phased out and will be removed in a future release.static AdministrationService
Deprecated.This service pertains to the legacy admin console, which will be replaced by the Appian Administration Console over the coming releases.static ServiceContext
Deprecated.Use {@link ServiceContextFactory.getAdministratorServiceContext()} insteadstatic User
Deprecated.Use {@link ServiceContextFactory.getAdministratorUser()} insteadstatic ServiceContext
Deprecated.This API is being phased out and will be removed in a future release.static User
Deprecated.This API is being phased out and will be removed in a future release.static ApplicationService
Deprecated.Use services injected by the Appian plug-in framework instead.static CalendarService
Deprecated.Use services injected by the Appian plug-in framework instead.static AdministrationService
Deprecated.Use the classContentService
instead.static CommunityService
Deprecated.Use the classContentService
instead.static CollaborationSearchService
Deprecated.Use the classContentService
instead.static CollaborationUserService
Deprecated.Use the classContentService
insteadad.static CommunityService
Deprecated.Use the classContentService
insteadad.static com.appiancorp.kougar.driver.ConnectionManager
Deprecated.This API is being phased out and will be removed in a future release.static ContentService
Deprecated.Use services injected by the Appian plug-in framework instead.static ContentStatisticsService
Deprecated.Use services injected by the Appian plug-in framework instead.static ExpressionService
Deprecated.Use services injected by the Appian plug-in framework instead.static DiscussionBodyService
Deprecated.The Discussion Forums functionality will be removed in a future release.Deprecated.The Discussion Forums functionality will be removed in a future release.Deprecated.The Discussion Forums functionality will be removed in a future release.static DiscussionPortletService
Deprecated.The Portal functionality will be removed in a future release.static DocumentService
Deprecated.Use the classContentService
instead.static ExceptionHandlerService
Deprecated.Use services injected by the Appian plug-in framework instead.static ExpressionService
Deprecated.Use services injected by the Appian plug-in framework instead.static ExpressionService
Deprecated.Use getExecutionExpressionService or getDesignExpressionServicestatic FolderService
Deprecated.Use the classContentService
instead.static ForumsSearchService
Deprecated.The Discussion Forums functionality will be removed in a future release.static GlobalizationService
Deprecated.Use services injected by the Appian plug-in framework instead.static GroupMessageService
Deprecated.the Group Message channel and code will be removed in a future release.static GroupService
Deprecated.Use services injected by the Appian plug-in framework instead.static GroupTypeService
Deprecated.Use services injected by the Appian plug-in framework instead.static JmsConnectionFactory
Deprecated.static JmsConnectionFactory
Deprecated.This API is being phased out and will be removed in a future release.static KnowledgeCenterService
Deprecated.Use the classContentService
instead.static LeaderMessageService
Deprecated.the Group Message channel and code will be removed in a future release.static LinksService
Deprecated.The Portal functionality will be removed in a future release.static MessagePublisherService
Deprecated.Use services injected by the Appian plug-in framework instead.static MiniBodyService
Deprecated.The Portal functionality will be removed in a future release.static MiniMetadataService
Deprecated.The Portal functionality will be removed in a future release.static NavigationService
Deprecated.The Portal functionality will be removed in a future release.static NotesContentService
Deprecated.Use services injected by the Appian plug-in framework instead.static NotificationService
Deprecated.The Notification functionality will be removed in a future release.static PageNavigationService
Deprecated.The Portal functionality will be removed in a future release.static PageService
Deprecated.The Portal functionality will be removed in a future release.static PersonalizationSearchService
Deprecated.Use services injected by the Appian plug-in framework instead.static AdministrationService
Deprecated.The Portal functionality will be removed in a future release.static PortalNotificationService
Deprecated.The Portal functionality will be removed in a future release.static PortletService
Deprecated.The Portal functionality will be removed in a future release.static com.appiancorp.naming.ServiceConnections
Deprecated.This API is being phased out and will be removed in a future release.static ProcessAdministrationService
Deprecated.Use services injected by the Appian plug-in framework instead.static ProcessAnalyticsService
Deprecated.Use services injected by the Appian plug-in framework instead.static ProcessDesignService
Deprecated.Use services injected by the Appian plug-in framework instead.static ProcessExecutionService
Deprecated.Use services injected by the Appian plug-in framework instead.static ReportingService
Deprecated.Use services injected by the Appian plug-in framework instead.static Object
getService
(ServiceContext ctx, String serviceName) Deprecated.Use one of theget*Service
methods instead.static Object
getService
(String serviceName) Deprecated.Use one of theget*Service
methods instead.static com.appiancorp.services.ServiceManager
Deprecated.This API is being phased out and will be removed in a future release.static String[]
Deprecated.This API is being phased out and will be removed in a future release.static Object[]
getServicesAsArray
(ServiceContext sc_, String[] serviceNames_) Deprecated.Use theget*Service
methods instead.getServicesAsMap
(ServiceContext sc_, String[] serviceNames_) Deprecated.Use theget*Service
methods instead.static StatisticsService
Deprecated.Use services injected by the Appian plug-in framework instead.static SynchronizationService
Deprecated.The Discussion Forums functionality will be removed in a future release.static TypeService
Deprecated.Use services injected by the Appian plug-in framework instead.static User
Deprecated.Use {@link ServiceContextFactory.getUser()} insteadstatic UserProfileService
Deprecated.Use services injected by the Appian plug-in framework instead.static UserService
Deprecated.Use services injected by the Appian plug-in framework instead.static void
recreateConnections
(String kougarConfig) Deprecated.This API is being phased out and will be removed in a future release.static void
releaseService
(com.appiancorp.services.ReleasableService serv_) Deprecated.This API is being phased out and will be removed in a future release.static void
releaseServiceSafe
(com.appiancorp.services.ReleasableService serv_) Deprecated.This API is being phased out and will be removed in a future release.static void
Deprecated.This API is being phased out and will be removed in a future release.static void
Deprecated.This API is being phased out and will be removed in a future release.static void
Deprecated.see waitForServers(), preferred, or waitForServers(Listconnections) instead to wait on just the given connections. static void
waitForServer
(String id_) Deprecated.This API is being phased out and will be removed in a future release.static void
Deprecated.This API is being phased out and will be removed in a future release.static void
waitForServers
(List<com.appiancorp.kougar.driver.KougarConnection> connections) Deprecated.This API is being phased out and will be removed in a future release.
-
Field Details
-
ADMIN_USERNAME
Deprecated.UseServiceContextFactory.ADMIN_USERNAME
instead- See Also:
-
ANONYMOUS_USERNAME
Deprecated.This API is being phased out and will be removed in a future release.- See Also:
-
-
Constructor Details
-
ServiceLocator
public ServiceLocator()Deprecated.
-
-
Method Details
-
getPrimary
Deprecated.This API is being phased out and will be removed in a future release.Get the primary ServiceLocator. The primary ServiceLocator corresponds to the static methods.- Returns:
-
recreateConnections
Deprecated.This API is being phased out and will be removed in a future release. -
addServices
Deprecated.This API is being phased out and will be removed in a future release. -
reloadConnectionManagerConfiguration
Deprecated.This API is being phased out and will be removed in a future release. -
reloadServiceManagerConfiguration
Deprecated.This API is being phased out and will be removed in a future release. -
getAdministratorUser
Deprecated.Use {@link ServiceContextFactory.getAdministratorUser()} insteadRetrieves the user that is the system administrator. This method can be used to consume a service as the Administrator. Because the Administrator user bypasses some authorization checks, this method should be used sparingly.- Returns:
- a user who is the system administrator
-
getAdministratorServiceContext
Deprecated.Use {@link ServiceContextFactory.getAdministratorServiceContext()} insteadRetrieves a service context for an anonymous system administrator. This method can be used to consume a service as the Administrator. Because the Administrator user bypasses some authorization checks, this method should be used sparingly.- Returns:
- an anonymous administrator service context
-
getAnonymousUser
Deprecated.This API is being phased out and will be removed in a future release.Retrieves an anonymous User object.- Returns:
- an anonymous user
-
getAnonymousServiceContext
Deprecated.This API is being phased out and will be removed in a future release.Retrieves a service context for an anonymous user.- Returns:
- an anonymous service context
-
getUser
Deprecated.Use {@link ServiceContextFactory.getUser()} insteadCreates a user object whose username is the given name. This object can then be used to obtain aServiceContext
.- Parameters:
userName_
- the username to use- Returns:
- a
User
with the given username
-
getConnectionManager
Deprecated.This API is being phased out and will be removed in a future release. -
getServiceManager
Deprecated.This API is being phased out and will be removed in a future release.Returns the service manager. -
getService
Deprecated.Use one of theget*Service
methods instead.Gets an instance of the service referenced byserviceName_
using the service context for an anonymous system administrator. Used for services that are not context-sensitive. Because the Administrator user bypasses some authorization checks, this method should be used sparingly.- Parameters:
serviceName_
- one of theX_SERVICE
constants defined in this class- Returns:
- an instance of the service bound to
serviceName_
. - Throws:
ServiceException
-
getService
@Deprecated public static Object getService(ServiceContext ctx, String serviceName) throws ServiceException Deprecated.Use one of theget*Service
methods instead.Gets an instance of the service referenced byserviceName_
.- Parameters:
sc_
- a context with which to obtain the serviceserviceName_
- one of theX_SERVICE
constants defined in this class- Returns:
- an instance of the service bound to
serviceName_
whose context issc_
. - Throws:
ServiceException
-
getServicesAsMap
@Deprecated public static Map<String,Object> getServicesAsMap(ServiceContext sc_, String[] serviceNames_) throws ServiceException Deprecated.Use theget*Service
methods instead.Gets multiple services and returns them as a map- Parameters:
sc_
- a context with which to obtain the servicesserviceNames_
- References to the services you want to retrieve. Valid values are theX_SERVICE
constants defined in this class.- Returns:
- a map where each service name is a key to a service. The services are stored as objects.
- Throws:
ServiceException
-
getServicesAsArray
@Deprecated public static Object[] getServicesAsArray(ServiceContext sc_, String[] serviceNames_) throws ServiceException Deprecated.Use theget*Service
methods instead.Gets multiple services and returns them in an object array- Parameters:
sc_
- a context with which to obtain the servicesserviceNames_
- References to the services you want to retrieve. Valid values are theX_SERVICE
constants defined in this class.- Returns:
- an array of services
- Throws:
ServiceException
-
releaseService
@Deprecated public static void releaseService(com.appiancorp.services.ReleasableService serv_) throws ServiceException Deprecated.This API is being phased out and will be removed in a future release.Releases the given service- Parameters:
serv_
- the service to release- Throws:
ServiceException
-
releaseServiceSafe
Deprecated.This API is being phased out and will be removed in a future release.Releases the given service, trapping and logging any exceptions that are raised. This method is "safe" because it does not throw any exceptions- Parameters:
serv_
- the service to release
-
getServiceNames
Deprecated.This API is being phased out and will be removed in a future release.Gets the names of all configured services. Services are declared across several XML files, and these files are all referenced in /WEB-INF/classes/appian-services.xml- Returns:
- the names of all services
-
waitForServer
Deprecated.This API is being phased out and will be removed in a future release.Causes processing to wait until a given server is up before continuing.- Parameters:
id_
- The name of a connection/service that is exposed by the server you want to restart
-
waitForServers
Deprecated.This API is being phased out and will be removed in a future release.Causes processing to wait until all servers are up before continuing. -
waitForServers
@Deprecated public static void waitForServers(List<com.appiancorp.kougar.driver.KougarConnection> connections) Deprecated.This API is being phased out and will be removed in a future release.Causes processing to wait until all servers' given connections are up before continuing.- Parameters:
connections
-
-
waitForExecutionServers
Deprecated.see waitForServers(), preferred, or waitForServers(Listconnections) instead to wait on just the given connections. Code should not wait on just execution servers. Causes processing to wait until all execution servers are up before continuing. -
getApplicationService
@Deprecated public static ApplicationService getApplicationService(ServiceContext sc) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theApplicationService
.- Parameters:
sc
- a context with which to obtain the service- Returns:
- a
ApplicationService
- Throws:
ServiceException
-
getLeaderMessageService
Deprecated.the Group Message channel and code will be removed in a future release.Gets an instance of theLeaderMessageService
.- Parameters:
sc
- a context with which to obtain the service- Returns:
- a
LeaderMessageService
-
getFolderService
Deprecated.Use the classContentService
instead.Gets an instance of theFolderService
.- Parameters:
sc
- a context with which to obtain the service- Returns:
- a
FolderService
-
getDocumentService
Deprecated.Use the classContentService
instead.Gets an instance of theDocumentService
.- Parameters:
sc
- a context with which to obtain the service- Returns:
- a
DocumentService
-
getPageService
Deprecated.The Portal functionality will be removed in a future release.Gets an instance of thePageService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
PageService
-
getProcessAnalyticsService2
@Deprecated public static ProcessAnalyticsService getProcessAnalyticsService2(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theProcessAnalyticsService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ProcessAnalyticsService
- Throws:
ServiceException
-
getCalendarService
Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theCalendarService
- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
CalendarService
-
getCollabAdministrationService
@Deprecated public static AdministrationService getCollabAdministrationService(ServiceContext sc_) throws ServiceException Deprecated.Use the classContentService
instead.Gets an instance of theAdministrationService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
AdministrationService
- Throws:
ServiceException
-
getCollabCommunityService
@Deprecated public static CommunityService getCollabCommunityService(ServiceContext sc_) throws ServiceException Deprecated.Use the classContentService
instead.Gets an instance of theCommunityService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
CommunityService
- Throws:
ServiceException
-
getDiscussionBodyService
@Deprecated public static DiscussionBodyService getDiscussionBodyService(ServiceContext sc_) throws ServiceException Deprecated.The Discussion Forums functionality will be removed in a future release. Use the News feed and related smart services to build applications with similar functionality.Gets an instance of theDiscussionBodyService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
DiscussionBodyService
- Throws:
ServiceException
-
getDiscussionMetadataConvenienceService
@Deprecated public static DiscussionMetadataConvenienceService getDiscussionMetadataConvenienceService(ServiceContext sc_) throws ServiceException Deprecated.The Discussion Forums functionality will be removed in a future release. Use the News feed and related smart services to build applications with similar functionality.Gets an instance of theDiscussionMetadataConvenienceService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
DiscussionMetadataConvenienceService
- Throws:
ServiceException
-
getDiscussionMetadataCoreService
@Deprecated public static DiscussionMetadataCoreService getDiscussionMetadataCoreService(ServiceContext sc_) throws ServiceException Deprecated.The Discussion Forums functionality will be removed in a future release. Use the News feed and related smart services to build applications with similar functionality.Gets an instance of theDiscussionMetadataCoreService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
DiscussionMetadataCoreService
- Throws:
ServiceException
-
getForumsSearchService
@Deprecated public static ForumsSearchService getForumsSearchService(ServiceContext sc_) throws ServiceException Deprecated.The Discussion Forums functionality will be removed in a future release. Use the News feed and related smart services to build applications with similar functionality.Gets an instance of theForumsSearchService
- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ForumsSearchService
- Throws:
ServiceException
-
getPersonalizationSearchService
@Deprecated public static PersonalizationSearchService getPersonalizationSearchService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.- Throws:
ServiceException
-
getGroupService
Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theGroupService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
GroupService
- Throws:
ServiceException
-
getGlobalizationService
@Deprecated public static GlobalizationService getGlobalizationService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of the (@link GlobalizationService)- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
GlobalizationService
- Throws:
ServiceException
-
getGroupTypeService
@Deprecated public static GroupTypeService getGroupTypeService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theGroupTypeService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
GroupTypeService
- Throws:
ServiceException
-
getKnowledgeCenterService
@Deprecated public static KnowledgeCenterService getKnowledgeCenterService(ServiceContext sc_) throws ServiceException Deprecated.Use the classContentService
instead.Gets an instance of theKnowledgeCenterService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
KnowledgeCenterService
- Throws:
ServiceException
-
getPortalAdministrationService
@Deprecated public static AdministrationService getPortalAdministrationService(ServiceContext sc_) throws ServiceException Deprecated.The Portal functionality will be removed in a future release.Gets an instance of theAdministrationService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
AdministrationService
- Throws:
ServiceException
-
getPortalNotificationService
@Deprecated public static PortalNotificationService getPortalNotificationService(ServiceContext sc_) throws ServiceException Deprecated.The Portal functionality will be removed in a future release.Gets an instance of thePortalNotificationService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
PortalNotificationService
- Throws:
ServiceException
-
getNotificationService
@Deprecated public static NotificationService getNotificationService(ServiceContext sc_) throws ServiceException Deprecated.The Notification functionality will be removed in a future release. Use the Tempo Interface for similar functionality.Gets an instance of theNotificationService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
NotificationService
- Throws:
ServiceException
-
getPortletService
@Deprecated public static PortletService getPortletService(ServiceContext sc_) throws ServiceException Deprecated.The Portal functionality will be removed in a future release.Gets an instance of thePortletService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
PortletService
- Throws:
ServiceException
-
getProcessAdministrationService
@Deprecated public static ProcessAdministrationService getProcessAdministrationService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theProcessAdministrationService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ProcessAdministrationService
- Throws:
ServiceException
-
getProcessDesignService
@Deprecated public static ProcessDesignService getProcessDesignService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theProcessDesignService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ProcessDesignService
- Throws:
ServiceException
-
getProcessExecutionService
@Deprecated public static ProcessExecutionService getProcessExecutionService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theProcessExecutionService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ProcessExecutionService
- Throws:
ServiceException
-
getExceptionHandlerService
@Deprecated public static ExceptionHandlerService getExceptionHandlerService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theExceptionHandlerService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ExceptionHandlerService
- Throws:
ServiceException
-
getReportingService
@Deprecated public static ReportingService getReportingService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theReportingService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ReportingService
- Throws:
ServiceException
-
getStatisticsService
@Deprecated public static StatisticsService getStatisticsService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theStatisticsService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
StatisticsService
- Throws:
ServiceException
-
getCollaborationSearchService
@Deprecated public static CollaborationSearchService getCollaborationSearchService(ServiceContext sc_) throws ServiceException Deprecated.Use the classContentService
instead.Gets an instance of theCollaborationSearchService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
CollaborationSearchService
- Throws:
ServiceException
-
getContentService
@Deprecated public static ContentService getContentService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theContentService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ContentService
- Throws:
ServiceException
-
getContentStatisticsService
@Deprecated public static ContentStatisticsService getContentStatisticsService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theContentStatisticsService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ContentService
- Throws:
ServiceException
-
getSyncronizationService
@Deprecated public static SynchronizationService getSyncronizationService(ServiceContext sc_) throws ServiceException Deprecated.The Discussion Forums functionality will be removed in a future release. Use the News feed and related smart services to build applications with similar functionality.Gets an instance of theSynchronizationService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
SynchronizationService
- Throws:
ServiceException
-
getUserProfileService
@Deprecated public static UserProfileService getUserProfileService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theUserProfileService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
UserProfileService
- Throws:
ServiceException
-
getGroupMessageService
@Deprecated public static GroupMessageService getGroupMessageService(ServiceContext sc_) throws ServiceException Deprecated.the Group Message channel and code will be removed in a future release.Gets an instance of theGroupMessageService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
GroupMessageService
- Throws:
ServiceException
-
getUserService
Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theUserService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
UserService
- Throws:
ServiceException
-
getLinksService
Deprecated.The Portal functionality will be removed in a future release.Gets an instance of theLinksService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
LinksService
- Throws:
ServiceException
-
getExpressionService
@Deprecated public static ExpressionService getExpressionService(ServiceContext sc_) throws ServiceException Deprecated.Use getExecutionExpressionService or getDesignExpressionServiceGets an instance of theExpressionService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ExpressionService
- Throws:
ServiceException
-
getExecutionExpressionService
@Deprecated public static ExpressionService getExecutionExpressionService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of the ExpressionService on Execution ServerExpressionService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ExpressionService
- Throws:
ServiceException
-
getDesignExpressionService
@Deprecated public static ExpressionService getDesignExpressionService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of the ExpressionService on Design ServerExpressionService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
ExpressionService
- Throws:
ServiceException
-
getNoteContentsService
@Deprecated public static NotesContentService getNoteContentsService(ServiceContext sc_) throws ServiceException Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theNotesContentService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
NotesContentService
- Throws:
ServiceException
-
getTypeService
Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theTypeService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
TypeService
- Throws:
ServiceException
-
getAdministrationConsoleService
@Deprecated public static AdministrationService getAdministrationConsoleService(ServiceContext sc_) throws ServiceException Deprecated.This service pertains to the legacy admin console, which will be replaced by the Appian Administration Console over the coming releases.Gets an instance of theAdministrationService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
AdministrationService
- Throws:
ServiceException
-
getCommunityService
@Deprecated public static CommunityService getCommunityService(ServiceContext sc_) throws ServiceException Deprecated.Use the classContentService
insteadad.Gets an instance of theCommunityService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
CommunityService
- Throws:
ServiceException
-
getDiscussionPortletService
Deprecated.The Portal functionality will be removed in a future release.Gets an instance of theDiscussionPortletService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
DiscussionPortletService
-
getMiniMetadataService
Deprecated.The Portal functionality will be removed in a future release.Gets an instance of theMiniMetadataService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
MiniMetadataService
-
getMiniBodyService
Deprecated.The Portal functionality will be removed in a future release.Gets an instance of theMiniBodyService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
MiniBodyService
-
getCollaborationUserService
Deprecated.Use the classContentService
insteadad.Gets an instance of theCollaborationUserService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
CollaborationUserService
-
getMessagePublisherService
Deprecated.Use services injected by the Appian plug-in framework instead.Gets an instance of theMessagePublisherService
.- Parameters:
sc_
- a context with which to obtain the service- Returns:
- a
MessagePublisherService
-
getJmsConnectionFactory
Deprecated.This API is being phased out and will be removed in a future release.Gets an instance of theJmsConnectionFactory
.- Returns:
- a
JmsConnectionFactory
-
getJmsConnectionFactory
Deprecated.
-