Class ServiceFactory


  • public class ServiceFactory
    extends Object
    Provides a service factory which creates all kinds of service objects.
    • Constructor Detail

      • ServiceFactory

        public ServiceFactory()
    • Method Detail

      • getAbandonmentService

        public static AbandonmentService getAbandonmentService()
        Return the abandonment service.
        Returns:
        the abandonment service
        Since:
        4.0.0
      • getApplicationPackageService

        public static ApplicationPackageService getApplicationPackageService()
        Return an ApplicationPackageService instance.
        Returns:
        a new ApplicationPackageService instance
        Since:
        4.0.0
      • getAsyncMessageService

        public static AsyncMessageService getAsyncMessageService()
        Returns:
        AsyncMessageService instance
        Since:
        4.3.2
      • getAttachmentService

        public static AttachmentService getAttachmentService()
        Return AttachmentService instance.
        Returns:
        AttachmentService instance
      • getAuditLogService

        public static AuditLogService getAuditLogService()
        Return AuditLogService instance.
        Returns:
        AuditLogService instance
      • getAuthenticationManager

        public static org.springframework.security.authentication.AuthenticationManager getAuthenticationManager()
        Return the Spring Security Authentication Provider manager.
        Returns:
        the Spring Security Authentication Provider manager
      • getAuthenticationManager

        public static org.springframework.security.authentication.AuthenticationManager getAuthenticationManager​(Portal portal)
        Return the Spring Security Authentication Provider manager for the portal.
        Parameters:
        portal - the portal entity
        Returns:
        the Spring Security Authentication Provider manager for the portal
        Since:
        19.5.0
      • getAuthenticationService

        public static IAuthenticationService getAuthenticationService()
        Gets the authentication service.
        Returns:
        the authentication service
      • getClientService

        public static ClientService getClientService()
        Return ClientService instance.
        Returns:
        ClientService instance
      • getEmailService

        public static EmailService getEmailService()
        Deprecated.
        use ServiceLocator.getEmailService() instead
        Return the Email Service instance. Note this may not be the default email service, please use ServiceLocator.getEmailService() instead.
        Returns:
        EmailService instance
      • getErrorLogService

        @Deprecated
        public static ErrorLogService getErrorLogService()
        Deprecated.
        use getErrorLogService(String errorType) method instead
        Return ErrorLogService instance.
        Returns:
        ErrorLogService instance
      • getErrorLogService

        public static ErrorLogService getErrorLogService​(String errorType)
        Return ErrorLogService instance.
        Parameters:
        errorType - the error type
        Returns:
        ErrorLogService instance
        Since:
        4.3.4
      • getEventLogService

        public static EventLogService getEventLogService()
        Return EventLogService instance.
        Returns:
        EventLogService instance
      • getFormService

        public static FormService getFormService()
        Return FormService instance.
        Returns:
        FormService instance
      • getFormDataService

        public static FormDataService getFormDataService()
        Gets the authentication service.
        Returns:
        the authentication service
        Since:
        4.1.0
      • getGroovyLogService

        public static GroovyLogService getGroovyLogService()
        Return GroovyLogService instance.
        Returns:
        GroovyLogService instance
        Since:
        4.2.0
      • getGroovyLogService

        public static GroovyLogService getGroovyLogService​(boolean commitChanges)
        Return GroovyLogService instance.
        Parameters:
        commitChanges - commit database changes
        Returns:
        GroovyLogService instance
        Since:
        4.3.3.1
      • getImportActionService

        public static ImportActionService getImportActionService()
        Return ImportActionService instance.
        Returns:
        ImportActionService instance
      • getJobEventLogService

        public static JobEventLogService getJobEventLogService()
        Return JobEventLogService instance.
        Returns:
        JobEventLogService instance
        Since:
        4.0.0
      • getPaymentService

        public static PaymentLogService getPaymentService()
        Return PaymentService instance.
        Returns:
        PaymentService instance
      • getOfflineSyncLogService

        public static OfflineSyncLogService getOfflineSyncLogService()
        Return OfflineSyncLogService instance.
        Returns:
        OfflineSyncLogService instance
      • getReceiptDataService

        public static ReceiptDataService getReceiptDataService()
        Return ReceiptDataService instance.
        Returns:
        ReceiptDataService instance
      • getRequestLogService

        public static RequestLogService getRequestLogService()
        Return a RequestLogService instance. Note that a Spring bean named requestLogService is loaded first; if this does not succeed, a new RequestLogService instance is returned
        Returns:
        a RequestLogService instance
      • getSecurityManagerService

        public static ISecurityManagerService getSecurityManagerService​(Portal portal)
                                                                 throws ApplicationException
        Return a SecurityManagerService instance for the given portal.
        Parameters:
        portal - the associated portal (required)
        Returns:
        SecurityManagerService instance for the given portal.
        Throws:
        ApplicationException - if no security manager is defined for the portal (implying that no default security manager is set)
      • getSalesForceClient

        public static SalesForceClient getSalesForceClient()
        Return SalesForceClient instance.
        Returns:
        SalesForceClient instance
        Since:
        4.2.0
      • getSchemaSeedService

        public static SchemaSeedService getSchemaSeedService()
        Return an instance of the SchemaSeedService.
        Returns:
        a SchemaSeedService instance
      • getSubmissionAcknowledgementService

        public static SubmissionAcknowledgementService getSubmissionAcknowledgementService()
        Return SubmissionAcknowledgementService instance.
        Returns:
        SubmissionAcknowledgementService instance
      • getSubmissionDeliveryService

        public static ISubmissionDeliveryController getSubmissionDeliveryService()
        Return SubmissionDeliveryService instance.
        Returns:
        SubmissionDeliveryService instance
      • getSubmissionExtractDataService

        public static SubmissionExtractDataService getSubmissionExtractDataService()
        Return a SubmissionExtractDataService instance.
        Returns:
        SubmissionExtractDataService instance
      • getSubmissionReceiptService

        public static ISubmissionReceiptService getSubmissionReceiptService()
        Return ISubmissionReceiptService instance.
        Returns:
        ISubmissionReceiptService instance
      • getSubmissionStatusService

        public static SubmissionStatusService getSubmissionStatusService()
        Return SubmissionStatusService instance.
        Returns:
        SubmissionStatusService instance
      • getSubmissionTaskService

        public static SubmissionTaskService getSubmissionTaskService()
        Return SubmissionTaskService instance.
        Returns:
        SubmissionTaskService instance
        Since:
        4.1.0
      • getSystemAlertService

        public static SystemAlertService getSystemAlertService()
        Return SystemAlertService instance.
        Returns:
        SystemAlertService instance.
        Since:
        4.1.0
      • getTaskService

        public static TaskService getTaskService()
        Return TaskService instance.
        Returns:
        TaskService instance
      • getFormSubmissionAccessController

        public static IFormSubmissionAccessController getFormSubmissionAccessController()
        Gets the form submission access controller.
        Returns:
        the form submission access controller
      • getFormSubmissionAccessController

        public static IFormSubmissionAccessController getFormSubmissionAccessController​(boolean enableLogging)
        Gets the form submission access controller.
        Parameters:
        enableLogging - enable security event logging
        Returns:
        the form submission access controller
        Since:
        4.3.1
      • getScheduledJobHistoryService

        public static ScheduledJobHistoryService getScheduledJobHistoryService()
        Return the ScheduledJobHistoryService instance.
        Returns:
        the ScheduledJobHistoryService instance
        Since:
        4.3.0
      • getSubmissionService

        public static SubmissionService getSubmissionService()
        Return the SubmissionService instance.
        Returns:
        the SubmissionService instance
      • getSubmissionDataService

        public static SubmissionDataService getSubmissionDataService()
        Return the SubmissionDataService instance.
        Returns:
        the SubmissionDataService instance
        Since:
        4.1.0
      • getSubmissionTargetResolver

        public static SubmissionTargetResolver getSubmissionTargetResolver()
        Return the SubmissionTargetResolver instance.
        Returns:
        the SubmissionTargetResolver instance
        Since:
        4.1.0
      • getTransactionHistoryCreationService

        public static ITransactionHistoryCreationService getTransactionHistoryCreationService()
        Return a new Transaction History Creation service.
        Returns:
        a new Transaction History Creation service
        Since:
        4.3.3
      • getAdminUserService

        public static UserService getAdminUserService()
        Return the Admin Console UserService instance.
        Returns:
        UserService instance
      • getUserService

        public static UserService getUserService​(Portal portal)
        Return UserService instance.
        Parameters:
        portal - the portal to initialize the user service with
        Returns:
        UserService instance