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.

@Deprecated
public class ServiceLocator
extends java.lang.Object
implements ServiceName

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.

ServiceLocator.getXService(serviceContext)
ServiceLocator.getXService( HttpServlet, HttpSession)
ServiceLocator.getXService( User )

Out of the above two getXService( HttpServlet, HttpSession) and getXService( User ) are deprecated. The recommended method is to use ServiceLocator.getXService(serviceContext)
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

Fields

Modifier and Type	Field and Description
static java.lang.String	ADMIN_USERNAME Deprecated. Use ServiceContextFactory.ADMIN_USERNAME instead
static java.lang.String	ANONYMOUS_USERNAME 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

Constructors

Constructor and Description
ServiceLocator() Deprecated.

Method Summary

Modifier and Type	Method and Description
static void	addServices(java.lang.String serviceConfig) Deprecated. This API is being phased out and will be removed in a future release.
static AdministrationService	getAdministrationConsoleService(ServiceContext sc_) Deprecated. This service pertains to the legacy admin console, which will be replaced by the Appian Administration Console over the coming releases.
static ServiceContext	getAdministratorServiceContext() Deprecated. Use ServiceContextFactory.getAdministratorServiceContext() instead
static User	getAdministratorUser() Deprecated. Use ServiceContextFactory.getAdministratorUser() instead
static ServiceContext	getAnonymousServiceContext() Deprecated. This API is being phased out and will be removed in a future release.
static User	getAnonymousUser() Deprecated. This API is being phased out and will be removed in a future release.
static ApplicationService	getApplicationService(ServiceContext sc) Deprecated. Use services injected by the Appian plug-in framework instead.
static CalendarService	getCalendarService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static AdministrationService	getCollabAdministrationService(ServiceContext sc_) Deprecated. Use the class ContentService instead.
static CommunityService	getCollabCommunityService(ServiceContext sc_) Deprecated. Use the class ContentService instead.
static CollaborationSearchService	getCollaborationSearchService(ServiceContext sc_) Deprecated. Use the class ContentService instead.
static CollaborationUserService	getCollaborationUserService(ServiceContext sc_) Deprecated. Use the class ContentService insteadad.
static CommunityService	getCommunityService(ServiceContext sc_) Deprecated. Use the class ContentService insteadad.
static com.appiancorp.kougar.driver.ConnectionManager	getConnectionManager() Deprecated. This API is being phased out and will be removed in a future release.
static ContentService	getContentService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static ContentStatisticsService	getContentStatisticsService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static ExpressionService	getDesignExpressionService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static DiscussionBodyService	getDiscussionBodyService(ServiceContext sc_) 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.
static DiscussionMetadataConvenienceService	getDiscussionMetadataConvenienceService(ServiceContext sc_) 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.
static DiscussionMetadataCoreService	getDiscussionMetadataCoreService(ServiceContext sc_) 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.
static DiscussionPortletService	getDiscussionPortletService(ServiceContext sc_) Deprecated. The Portal functionality will be removed in a future release.
static DocumentService	getDocumentService(ServiceContext sc) Deprecated. Use the class ContentService instead.
static ExceptionHandlerService	getExceptionHandlerService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static ExpressionService	getExecutionExpressionService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static ExpressionService	getExpressionService(ServiceContext sc_) Deprecated. Use getExecutionExpressionService or getDesignExpressionService
static FolderService	getFolderService(ServiceContext sc) Deprecated. Use the class ContentService instead.
static ForumsSearchService	getForumsSearchService(ServiceContext sc_) 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.
static GlobalizationService	getGlobalizationService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static GroupMessageService	getGroupMessageService(ServiceContext sc_) Deprecated. the Group Message channel and code will be removed in a future release.
static GroupService	getGroupService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static GroupTypeService	getGroupTypeService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static JmsConnectionFactory	getJmsConnectionFactory() Deprecated. Use getJmsConnectionFactory(ServiceContext).
static JmsConnectionFactory	getJmsConnectionFactory(ServiceContext sc) Deprecated. This API is being phased out and will be removed in a future release.
static KnowledgeCenterService	getKnowledgeCenterService(ServiceContext sc_) Deprecated. Use the class ContentService instead.
static LeaderMessageService	getLeaderMessageService(ServiceContext sc) Deprecated. the Group Message channel and code will be removed in a future release.
static LinksService	getLinksService(ServiceContext sc_) Deprecated. The Portal functionality will be removed in a future release.
static MessagePublisherService	getMessagePublisherService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static MiniBodyService	getMiniBodyService(ServiceContext sc_) Deprecated. The Portal functionality will be removed in a future release.
static MiniMetadataService	getMiniMetadataService(ServiceContext sc_) Deprecated. The Portal functionality will be removed in a future release.
static NavigationService	getNavigationService(ServiceContext sc) Deprecated. The Portal functionality will be removed in a future release.
static NotesContentService	getNoteContentsService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static NotificationService	getNotificationService(ServiceContext sc_) Deprecated. The Notification functionality will be removed in a future release. Use the Tempo Interface for similar functionality.
static PageNavigationService	getPageNavigationService(ServiceContext sc) Deprecated. The Portal functionality will be removed in a future release.
static PageService	getPageService(ServiceContext sc_) Deprecated. The Portal functionality will be removed in a future release.
static PersonalizationSearchService	getPersonalizationSearchService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static AdministrationService	getPortalAdministrationService(ServiceContext sc_) Deprecated. The Portal functionality will be removed in a future release.
static PortalNotificationService	getPortalNotificationService(ServiceContext sc_) Deprecated. The Portal functionality will be removed in a future release.
static PortletService	getPortletService(ServiceContext sc_) Deprecated. The Portal functionality will be removed in a future release.
static com.appiancorp.naming.ServiceConnections	getPrimary() Deprecated. This API is being phased out and will be removed in a future release.
static ProcessAdministrationService	getProcessAdministrationService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static ProcessAnalyticsService	getProcessAnalyticsService2(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static ProcessDesignService	getProcessDesignService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static ProcessExecutionService	getProcessExecutionService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static ReportingService	getReportingService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static java.lang.Object	getService(ServiceContext ctx, java.lang.String serviceName) Deprecated. Use one of the get*Service methods instead.
static java.lang.Object	getService(java.lang.String serviceName) Deprecated. Use one of the get*Service methods instead.
static com.appiancorp.services.ServiceManager	getServiceManager() Deprecated. This API is being phased out and will be removed in a future release.
static java.lang.String[]	getServiceNames() Deprecated. This API is being phased out and will be removed in a future release.
static java.lang.Object[]	getServicesAsArray(ServiceContext sc_, java.lang.String[] serviceNames_) Deprecated. Use the get*Service methods instead.
static java.util.Map<java.lang.String,java.lang.Object>	getServicesAsMap(ServiceContext sc_, java.lang.String[] serviceNames_) Deprecated. Use the get*Service methods instead.
static StatisticsService	getStatisticsService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static SynchronizationService	getSyncronizationService(ServiceContext sc_) 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.
static TypeService	getTypeService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static User	getUser(java.lang.String userName_) Deprecated. Use ServiceContextFactory.getUser() instead
static UserProfileService	getUserProfileService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static UserService	getUserService(ServiceContext sc_) Deprecated. Use services injected by the Appian plug-in framework instead.
static void	recreateConnections(java.lang.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	reloadConnectionManagerConfiguration() Deprecated. This API is being phased out and will be removed in a future release.
static void	reloadServiceManagerConfiguration() Deprecated. This API is being phased out and will be removed in a future release.
static void	waitForExecutionServers() Deprecated. see waitForServers(), preferred, or waitForServers(List connections) instead to wait on just the given connections. Code should not wait on just execution servers.
static void	waitForServer(java.lang.String id_) Deprecated. This API is being phased out and will be removed in a future release.
static void	waitForServers() Deprecated. This API is being phased out and will be removed in a future release.
static void	waitForServers(java.util.List<com.appiancorp.kougar.driver.KougarConnection> connections) Deprecated. This API is being phased out and will be removed in a future release.

Methods inherited from class java.lang.Object

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

Field Detail

ADMIN_USERNAME

@Deprecated
public static final java.lang.String ADMIN_USERNAME

Deprecated. Use ServiceContextFactory.ADMIN_USERNAME instead

See Also:

Constant Field Values

ANONYMOUS_USERNAME

@Deprecated
public static final java.lang.String ANONYMOUS_USERNAME

Deprecated. This API is being phased out and will be removed in a future release.

See Also:

Constant Field Values

Constructor Detail

ServiceLocator

public ServiceLocator()

Deprecated.

Method Detail

getPrimary

@Deprecated
public static com.appiancorp.naming.ServiceConnections 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
public static void recreateConnections(java.lang.String kougarConfig)

Deprecated. This API is being phased out and will be removed in a future release.

addServices

@Deprecated
public static void addServices(java.lang.String serviceConfig)

Deprecated. This API is being phased out and will be removed in a future release.

reloadConnectionManagerConfiguration

@Deprecated
public static void reloadConnectionManagerConfiguration()

Deprecated. This API is being phased out and will be removed in a future release.

reloadServiceManagerConfiguration

@Deprecated
public static void reloadServiceManagerConfiguration()

Deprecated. This API is being phased out and will be removed in a future release.

getAdministratorUser

@Deprecated
public static User getAdministratorUser()

Deprecated. Use ServiceContextFactory.getAdministratorUser() instead

Retrieves 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
public static ServiceContext getAdministratorServiceContext()

Deprecated. Use ServiceContextFactory.getAdministratorServiceContext() instead

Retrieves 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
public static User 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
public static ServiceContext 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
public static User getUser(java.lang.String userName_)

Deprecated. Use ServiceContextFactory.getUser() instead

Creates a user object whose username is the given name. This object can then be used to obtain a ServiceContext.

Parameters:

userName_ - the username to use

Returns:

a User with the given username

getConnectionManager

@Deprecated
public static com.appiancorp.kougar.driver.ConnectionManager getConnectionManager()

Deprecated. This API is being phased out and will be removed in a future release.

getServiceManager

@Deprecated
public static com.appiancorp.services.ServiceManager getServiceManager()

Deprecated. This API is being phased out and will be removed in a future release.

Returns the service manager.

getService

@Deprecated
public static java.lang.Object getService(java.lang.String serviceName)
                                               throws ServiceException

Deprecated. Use one of the get*Service methods instead.

Gets an instance of the service referenced by serviceName_ 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 the X_SERVICE constants defined in this class

Returns:

an instance of the service bound to serviceName_.

Throws:

ServiceException

getService

@Deprecated
public static java.lang.Object getService(ServiceContext ctx,
                                                      java.lang.String serviceName)
                                               throws ServiceException

Deprecated. Use one of the get*Service methods instead.

Gets an instance of the service referenced by serviceName_.

Parameters:

sc_ - a context with which to obtain the service

serviceName_ - one of the X_SERVICE constants defined in this class

Returns:

an instance of the service bound to serviceName_ whose context is sc_.

Throws:

ServiceException

getServicesAsMap

@Deprecated
public static java.util.Map<java.lang.String,java.lang.Object> getServicesAsMap(ServiceContext sc_,
                                                                                            java.lang.String[] serviceNames_)
                                                                                     throws ServiceException

Deprecated. Use the get*Service methods instead.

Gets multiple services and returns them as a map

Parameters:

sc_ - a context with which to obtain the services

serviceNames_ - References to the services you want to retrieve. Valid values are the X_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 java.lang.Object[] getServicesAsArray(ServiceContext sc_,
                                                                java.lang.String[] serviceNames_)
                                                         throws ServiceException

Deprecated. Use the get*Service methods instead.

Gets multiple services and returns them in an object array

Parameters:

sc_ - a context with which to obtain the services

serviceNames_ - References to the services you want to retrieve. Valid values are the X_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
public static void releaseServiceSafe(com.appiancorp.services.ReleasableService serv_)

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
public static java.lang.String[] 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
public static void waitForServer(java.lang.String id_)

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
public static void 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(java.util.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
public static void waitForExecutionServers()

Deprecated. see waitForServers(), preferred, or waitForServers(List connections) 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 the ApplicationService.

Parameters:

sc - a context with which to obtain the service

Returns:

a ApplicationService

Throws:

ServiceException

getLeaderMessageService

@Deprecated
public static LeaderMessageService getLeaderMessageService(ServiceContext sc)

Deprecated. the Group Message channel and code will be removed in a future release.

Gets an instance of the LeaderMessageService.

Parameters:

sc - a context with which to obtain the service

Returns:

a LeaderMessageService

getPageNavigationService

@Deprecated
public static PageNavigationService getPageNavigationService(ServiceContext sc)

Deprecated. The Portal functionality will be removed in a future release.

Gets an instance of the PageNavigationService.

Parameters:

sc - a context with which to obtain the service

Returns:

a PageNavigationService

getNavigationService

@Deprecated
public static NavigationService getNavigationService(ServiceContext sc)

Deprecated. The Portal functionality will be removed in a future release.

Gets an instance of the NavigationService.

Parameters:

sc - a context with which to obtain the service

Returns:

a NavigationService

getFolderService

@Deprecated
public static FolderService getFolderService(ServiceContext sc)

Deprecated. Use the class ContentService instead.

Gets an instance of the FolderService.

Parameters:

sc - a context with which to obtain the service

Returns:

a FolderService

getDocumentService

@Deprecated
public static DocumentService getDocumentService(ServiceContext sc)

Deprecated. Use the class ContentService instead.

Gets an instance of the DocumentService.

Parameters:

sc - a context with which to obtain the service

Returns:

a DocumentService

getPageService

@Deprecated
public static PageService getPageService(ServiceContext sc_)

Deprecated. The Portal functionality will be removed in a future release.

Gets an instance of the PageService.

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 the ProcessAnalyticsService.

Parameters:

sc_ - a context with which to obtain the service

Returns:

a ProcessAnalyticsService

Throws:

ServiceException

getCalendarService

@Deprecated
public static CalendarService getCalendarService(ServiceContext sc_)

Deprecated. Use services injected by the Appian plug-in framework instead.

Gets an instance of the CalendarService

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 class ContentService instead.

Gets an instance of the AdministrationService.

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 class ContentService instead.

Gets an instance of the CommunityService.

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 the DiscussionBodyService.

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 the DiscussionMetadataConvenienceService.

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 the DiscussionMetadataCoreService.

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 the ForumsSearchService

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
public static GroupService getGroupService(ServiceContext sc_)
                                                throws ServiceException

Deprecated. Use services injected by the Appian plug-in framework instead.

Gets an instance of the GroupService.

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 the GroupTypeService.

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 class ContentService instead.

Gets an instance of the KnowledgeCenterService.

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 the AdministrationService.

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 the PortalNotificationService.

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 the NotificationService.

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 the PortletService.

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 the ProcessAdministrationService.

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 the ProcessDesignService.

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 the ProcessExecutionService.

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 the ExceptionHandlerService.

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 the ReportingService.

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 the StatisticsService.

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 class ContentService instead.

Gets an instance of the CollaborationSearchService.

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 the ContentService.

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 the ContentStatisticsService.

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 the SynchronizationService.

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 the UserProfileService.

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 the GroupMessageService.

Parameters:

sc_ - a context with which to obtain the service

Returns:

a GroupMessageService

Throws:

ServiceException

getUserService

@Deprecated
public static UserService getUserService(ServiceContext sc_)
                                              throws ServiceException

Deprecated. Use services injected by the Appian plug-in framework instead.

Gets an instance of the UserService.

Parameters:

sc_ - a context with which to obtain the service

Returns:

a UserService

Throws:

ServiceException

getLinksService

@Deprecated
public static LinksService getLinksService(ServiceContext sc_)
                                                throws ServiceException

Deprecated. The Portal functionality will be removed in a future release.

Gets an instance of the LinksService.

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 getDesignExpressionService

Gets an instance of the ExpressionService.

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 the NotesContentService.

Parameters:

sc_ - a context with which to obtain the service

Returns:

a NotesContentService

Throws:

ServiceException

getTypeService

@Deprecated
public static TypeService getTypeService(ServiceContext sc_)
                                              throws ServiceException

Deprecated. Use services injected by the Appian plug-in framework instead.

Gets an instance of the TypeService.

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 the AdministrationService.

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 class ContentService insteadad.

Gets an instance of the CommunityService.

Parameters:

sc_ - a context with which to obtain the service

Returns:

a CommunityService

Throws:

ServiceException

getDiscussionPortletService

@Deprecated
public static DiscussionPortletService getDiscussionPortletService(ServiceContext sc_)

Deprecated. The Portal functionality will be removed in a future release.

Gets an instance of the DiscussionPortletService.

Parameters:

sc_ - a context with which to obtain the service

Returns:

a DiscussionPortletService

getMiniMetadataService

@Deprecated
public static MiniMetadataService getMiniMetadataService(ServiceContext sc_)

Deprecated. The Portal functionality will be removed in a future release.

Gets an instance of the MiniMetadataService.

Parameters:

sc_ - a context with which to obtain the service

Returns:

a MiniMetadataService

getMiniBodyService

@Deprecated
public static MiniBodyService getMiniBodyService(ServiceContext sc_)

Deprecated. The Portal functionality will be removed in a future release.

Gets an instance of the MiniBodyService.

Parameters:

sc_ - a context with which to obtain the service

Returns:

a MiniBodyService

getCollaborationUserService

@Deprecated
public static CollaborationUserService getCollaborationUserService(ServiceContext sc_)

Deprecated. Use the class ContentService insteadad.

Gets an instance of the CollaborationUserService.

Parameters:

sc_ - a context with which to obtain the service

Returns:

a CollaborationUserService

getMessagePublisherService

@Deprecated
public static MessagePublisherService getMessagePublisherService(ServiceContext sc_)

Deprecated. Use services injected by the Appian plug-in framework instead.

Gets an instance of the MessagePublisherService.

Parameters:

sc_ - a context with which to obtain the service

Returns:

a MessagePublisherService

getJmsConnectionFactory

@Deprecated
public static JmsConnectionFactory getJmsConnectionFactory(ServiceContext sc)

Deprecated. This API is being phased out and will be removed in a future release.

Gets an instance of the JmsConnectionFactory.

Returns:

a JmsConnectionFactory

getJmsConnectionFactory

@Deprecated
public static JmsConnectionFactory getJmsConnectionFactory()

Deprecated. Use getJmsConnectionFactory(ServiceContext).