Package com.avoka.fc.core.entity

Class ServiceDefinition

java.lang.Object
org.apache.cayenne.PersistentObject
org.apache.cayenne.BaseDataObject
org.apache.cayenne.CayenneDataObject
com.avoka.core.entity.BaseEntity
com.avoka.fc.core.entity.auto._ServiceDefinition
com.avoka.fc.core.entity.ServiceDefinition
All Implemented Interfaces:
IEntity, Auditable, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating
@CacheGroups("CONFIG") public class ServiceDefinition extends _ServiceDefinition implements Auditable
Provides an entity describing a service definition. Service definitions provide functionality described by an interface. Multiple implementations (or multiple copies of the same implementation) may exist as service definitions, and can be configured at runtime.
See Also:

  • Field Details

    • NAME_AND_VERSION_STRING_PROPERTY

      public static final String NAME_AND_VERSION_STRING_PROPERTY
      An auxiliary property for displaying both name and version number
      See Also:

    • SERVICE_TYPE_ABANDONED_DELIVERY_PROCESS

      public static final String SERVICE_TYPE_ABANDONED_DELIVERY_PROCESS
      The service type for services delivering abandoned submissions to an Adobe LiveCycle process
      See Also:

    • SERVICE_TYPE_DATABASE_INTEGRITY_CHECKER_SERVICE

      public static final String SERVICE_TYPE_DATABASE_INTEGRITY_CHECKER_SERVICE
      The service type for event database integrity checker
      See Also:

    • SERVICE_TYPE_DATA_RETENTION_MANAGEMENT

      public static final String SERVICE_TYPE_DATA_RETENTION_MANAGEMENT
      The service type for services purging data and logs
      See Also:

    • SERVICE_TYPE_DELIVERY_FUNCTION

      public static final String SERVICE_TYPE_DELIVERY_FUNCTION
      The service type for Delivery Functions.
      See Also:

    • SERVICE_TYPE_DELIVERY_PROCESS

      public static final String SERVICE_TYPE_DELIVERY_PROCESS
      The service type for services delivering submissions to an Adobe LiveCycle process
      See Also:

    • SERVICE_TYPE_DYNAMIC_DATA

      public static final String SERVICE_TYPE_DYNAMIC_DATA
      The service type for services providing lookup data requested by forms, based on parameters provided by the form
      See Also:

    • SERVICE_TYPE_EMAIL_QUEUE

      public static final String SERVICE_TYPE_EMAIL_QUEUE
      The service type for services managing an email queue
      See Also:

    • SERVICE_TYPE_EVENT_CONFIGURATION

      public static final String SERVICE_TYPE_EVENT_CONFIGURATION
      The service type for Event Configuration service
      See Also:

    • SERVICE_TYPE_EVENT_LISTENER_CONFIGURATION

      public static final String SERVICE_TYPE_EVENT_LISTENER_CONFIGURATION
      The service type for Event Listener Configuration service
      See Also:

    • SERVICE_TYPE_FIND_DELIVERY_PROCESS_ID

      public static final String SERVICE_TYPE_FIND_DELIVERY_PROCESS_ID
      The service type for services finding the delivery process ID
      See Also:

    • SERVICE_TYPE_FLUENT_FUNCTION

      public static final String SERVICE_TYPE_FLUENT_FUNCTION
      The service type for Fluent Functions.
      See Also:

    • SERVICE_TYPE_FORM_META_DATA

      public static final String SERVICE_TYPE_FORM_META_DATA
      The service type for services providing formatted meta data
      See Also:

    • SERVICE_TYPE_FORM_PDF_PRE_RENDER

      public static final String SERVICE_TYPE_FORM_PDF_PRE_RENDER
      The service type for services pre-rendering PDF forms.
      See Also:

    • SERVICE_TYPE_FORM_PREFILL

      public static final String SERVICE_TYPE_FORM_PREFILL
      The service type for form prefill services
      See Also:

    • SERVICE_TYPE_FORM_SAVED_PROCESSOR

      public static final String SERVICE_TYPE_FORM_SAVED_PROCESSOR
      The service type for form saved processor services
      See Also:

    • SERVICE_TYPE_FORM_SECURITY_FILTER

      public static final String SERVICE_TYPE_FORM_SECURITY_FILTER
      The service type for form security filter services
      See Also:

    • SERVICE_TYPE_FORM_VERSION_SELECTOR

      public static final String SERVICE_TYPE_FORM_VERSION_SELECTOR
      The service type for services selecting the appropriate version of a form to render at request time
      See Also:

    • SERVICE_TYPE_FORM_SUBMISSION_ACCESS_CONTROLLER

      public static final String SERVICE_TYPE_FORM_SUBMISSION_ACCESS_CONTROLLER
      The service type for services selecting the appropriate version of a form to render at request time
      See Also:

    • SERVICE_TYPE_EMAIL_SERVICE

      public static final String SERVICE_TYPE_EMAIL_SERVICE
      The service type for generic Email Service
      See Also:

    • SERVICE_TYPE_GROOVY_SERVICE

      public static final String SERVICE_TYPE_GROOVY_SERVICE
      The service type for generic Groovy Service
      See Also:

    • SERVICE_TYPE_INBOX_PROCESSOR

      public static final String SERVICE_TYPE_INBOX_PROCESSOR
      The service type for event inbox processor
      See Also:

    • SERVICE_TYPE_JOB_ACTION

      public static final String SERVICE_TYPE_JOB_ACTION
      The service type for Job Action service
      See Also:

    • SERVICE_TYPE_JOB_ACTION_WAIT

      public static final String SERVICE_TYPE_JOB_ACTION_WAIT
      The service type for Job Action service
      See Also:

    • SERVICE_TYPE_JOB_CONTROLLER

      public static final String SERVICE_TYPE_JOB_CONTROLLER
      The service type for Job Controller service
      See Also:

    • SERVICE_TYPE_JOB_DELIVERY

      public static final String SERVICE_TYPE_JOB_DELIVERY
      The service type for Job Delivery Wait service
      See Also:

    • SERVICE_TYPE_JOB_DELIVERY_WAIT

      public static final String SERVICE_TYPE_JOB_DELIVERY_WAIT
      The service type for Job Delivery Wait service
      See Also:

    • SERVICE_TYPE_JOB_EXPIRY

      public static final String SERVICE_TYPE_JOB_EXPIRY
      The service type for Job Expiry service
      See Also:

    • SERVICE_TYPE_JOB_FORM_START

      public static final String SERVICE_TYPE_JOB_FORM_START
      The service type for Job Form Start service
      See Also:

    • SERVICE_TYPE_JOB_PROCESS_MESSAGE

      public static final String SERVICE_TYPE_JOB_PROCESS_MESSAGE
      The service type for Job Process Message service
      See Also:

    • SERVICE_TYPE_JOB_RECEIPT_WAIT

      public static final String SERVICE_TYPE_JOB_RECEIPT_WAIT
      The service type for Job Receipt Wait service
      See Also:

    • SERVICE_TYPE_JOB_TASK_ASSIGN

      public static final String SERVICE_TYPE_JOB_TASK_ASSIGN
      The service type for Job Task Assign service
      See Also:

    • SERVICE_TYPE_JOB_TASK_WAIT

      public static final String SERVICE_TYPE_JOB_TASK_WAIT
      The service type for Job Task Wait service
      See Also:

    • SERVICE_TYPE_LIVECYCLE_SERVICE

      public static final String SERVICE_TYPE_LIVECYCLE_SERVICE
      The service type for a arbitrary LiveCycle service
      See Also:

    • SERVICE_TYPE_MEDIA_TYPE_SCAN

      public static final String SERVICE_TYPE_MEDIA_TYPE_SCAN
      The service type for media type scan services
      See Also:

    • SERVICE_TYPE_OUTBOX_PROCESSOR

      public static final String SERVICE_TYPE_OUTBOX_PROCESSOR
      The service type for event outbox processor
      See Also:

    • SERVICE_TYPE_TWO_FACTOR_AUTHENTICATION

      public static final String SERVICE_TYPE_TWO_FACTOR_AUTHENTICATION
      The service type for services performing two authentication
      See Also:

    • SERVICE_TYPE_PAYMENT_GATEWAY

      public static final String SERVICE_TYPE_PAYMENT_GATEWAY
      The service type for payment gateway services
      See Also:

    • SERVICE_TYPE_PAYMENT_REMINDER_ALERT

      public static final String SERVICE_TYPE_PAYMENT_REMINDER_ALERT
      The service type for services payment reminder alert
      See Also:

    • SERVICE_TYPE_RECEIPT_NUMBER

      public static final String SERVICE_TYPE_RECEIPT_NUMBER
      The service type for services assigning receipt numbers to submissions
      See Also:

    • SERVICE_TYPE_RENDER_COMPOSER_HTML_FORM

      public static final String SERVICE_TYPE_RENDER_COMPOSER_HTML_FORM
      The service type for Composer HTML form rendering services
      See Also:

    • SERVICE_TYPE_RENDER_OFFLINE_SUBMISSION_FORM

      public static final String SERVICE_TYPE_RENDER_OFFLINE_SUBMISSION_FORM
      The service type for services rendering offline submission forms
      See Also:

    • SERVICE_TYPE_RENDER_RECEIPT

      public static final String SERVICE_TYPE_RENDER_RECEIPT
      The service type for receipt rendering services
      See Also:

    • SERVICE_TYPE_REPOSITORY_PUBLISH

      public static final String SERVICE_TYPE_REPOSITORY_PUBLISH
      The service type for form template publishing services
      See Also:

    • SERVICE_TYPE_REPOSITORY_SYNCHRONIZE

      public static final String SERVICE_TYPE_REPOSITORY_SYNCHRONIZE
      The service type for template synchronization services
      See Also:

    • SERVICE_TYPE_SALESFORCE_CLIENT

      public static final String SERVICE_TYPE_SALESFORCE_CLIENT
      The service type for SalesForce Client service
      See Also:

    • SERVICE_TYPE_SCHEDULED_SERVICE

      public static final String SERVICE_TYPE_SCHEDULED_SERVICE
      The service type for scheduled service
      See Also:

    • SERVICE_TYPE_SUBMISSION_COMPLETED_PROCESSOR

      public static final String SERVICE_TYPE_SUBMISSION_COMPLETED_PROCESSOR
      The service type for submission completed processor services
      See Also:

    • SERVICE_TYPE_SUBMISSION_DATA_EXTRACTION

      public static final String SERVICE_TYPE_SUBMISSION_DATA_EXTRACTION
      The service type for services extracting XML data from submitted forms
      See Also:

    • SERVICE_TYPE_SUBMISSION_DATA_STORAGE

      public static final String SERVICE_TYPE_SUBMISSION_DATA_STORAGE
      The service type for submission data storage services.
      See Also:

    • SERVICE_TYPE_SUBMISSION_DATA_VALIDATOR

      public static final String SERVICE_TYPE_SUBMISSION_DATA_VALIDATOR
      The service type for submission data validator services.
      See Also:

    • SERVICE_TYPE_SUBMISSION_DELIVERY_CONTROLLER

      public static final String SERVICE_TYPE_SUBMISSION_DELIVERY_CONTROLLER
      The service type for delivery controller services
      See Also:

    • SERVICE_TYPE_SUBMISSION_EMAIL_VERIFICATION

      public static final String SERVICE_TYPE_SUBMISSION_EMAIL_VERIFICATION
      The service type for submission email verification services
      See Also:

    • SERVICE_TYPE_SUBMISSION_PREPROCESSOR

      public static final String SERVICE_TYPE_SUBMISSION_PREPROCESSOR
      The service type for submission preprocessor services
      See Also:

    • SERVICE_TYPE_SUBMISSION_RECEIPT

      public static final String SERVICE_TYPE_SUBMISSION_RECEIPT
      The service type for submission receipt processing services
      See Also:

    • SERVICE_TYPE_SUBMISSION_SERVICE

      public static final String SERVICE_TYPE_SUBMISSION_SERVICE
      The service type for submission service
      See Also:

    • SERVICE_TYPE_SYSTEM_EVENT_PUBLISHER

      public static final String SERVICE_TYPE_SYSTEM_EVENT_PUBLISHER
      The service type for system event publisher
      See Also:

    • SERVICE_TYPE_TASK_EXPIRY_PROCESS

      public static final String SERVICE_TYPE_TASK_EXPIRY_PROCESS
      The service type for Task Expiry Process services
      See Also:

    • SERVICE_TYPE_TEST_SUITE

      public static final String SERVICE_TYPE_TEST_SUITE
      The service type for unit test suite
      See Also:

    • SERVICE_TYPE_TRACKING_NUMBER

      public static final String SERVICE_TYPE_TRACKING_NUMBER
      The service type for services generating transaction tracking numbers
      See Also:

    • SERVICE_TYPE_DWH_TRANSACTION_HISTORY_PUBLISH

      public static final String SERVICE_TYPE_DWH_TRANSACTION_HISTORY_PUBLISH
      The service type for transaction history publishing services.
      See Also:

    • SERVICE_TYPE_TRANSACTION_HISTORY_PUBLISHER

      public static final String SERVICE_TYPE_TRANSACTION_HISTORY_PUBLISHER
      The service type for transaction history publishing services.
      See Also:

    • SERVICE_TYPE_STATUS_MANAGEMENT

      public static final String SERVICE_TYPE_STATUS_MANAGEMENT
      The service type for services doing status management processing.
      See Also:

    • SERVICE_TYPE_TRANSACTION_PROCESSOR

      public static final String SERVICE_TYPE_TRANSACTION_PROCESSOR
      The service type for services doing transaction processing (expiry, abandonment, receipting, delivery).
      See Also:

    • SERVICE_TYPE_VIRUS_SCAN

      public static final String SERVICE_TYPE_VIRUS_SCAN
      The service type for virus scan services
      See Also:

    • CREATION_METHOD_JAVA_CLASSNAME

      public static final String CREATION_METHOD_JAVA_CLASSNAME
      The Definition Java Classname CREATION_METHOD_JAVA_CLASSNAME.
      See Also:

    • CREATION_METHOD_SPRING_BEAN

      public static final String CREATION_METHOD_SPRING_BEAN
      The Definition spring bean name CREATION_METHOD_SPRING_BEAN.
      See Also:

    • CORE_SERVICE_TYPES

      public static final List<String> CORE_SERVICE_TYPES
      Collection of all service types used in FC core For a full list of all service types, please use ServiceDefinitionDao.getAllServiceTypes()

    • GLOBAL_CORE_SERVICE_TYPES

      public static final List<String> GLOBAL_CORE_SERVICE_TYPES
      The list of global core service types.

    • GROOVY_SERVICE_TYPES

      public static final List<String> GROOVY_SERVICE_TYPES
      Collection of Groovy service types.

    • SERVICE_TYPES_FOR_FORM_DEVELOPERS

      public static final List<String> SERVICE_TYPES_FOR_FORM_DEVELOPERS
      Collection of service types used in FC core that should be accessible to form developers

    • SERVICE_TYPES_FOR_FORMS

      public static final List<String> SERVICE_TYPES_FOR_FORMS
      Collection of form service types

    • SERVICE_TYPES_FOR_JOBS

      public static final List<String> SERVICE_TYPES_FOR_JOBS
      Collection of Job service types used in FC core that should be accessible to form developers

    • SERVICE_TYPES_NO_USAGE

      public static final List<String> SERVICE_TYPES_NO_USAGE
      The set of service types for which showing usage doesn't make sense (mostly because TM always uses the default service but also including service types such as Groovy Service and Scheduled Service for which usage calculation is difficult)

    • SERVICE_TYPES_FUNCTIONS

      public static final List<String> SERVICE_TYPES_FUNCTIONS
      The set of Fluent Function Types.

    • SERVICE_CREATION_METHODS

      public static final List<String> SERVICE_CREATION_METHODS
      The Constant SERVICE_CREATION_METHODS String array.

  • Constructor Details

    • ServiceDefinition

      public ServiceDefinition()

  • Method Details

    • isSpringBeanService

      public boolean isSpringBeanService()
      Returns:
      Return true if the service creation method is 'Spring Bean'

    • isDefaultType

      public boolean isDefaultType()
      Return whether the service definition is the default for its type (alias for _ServiceDefinition.isServiceTypeDefaultFlag()
      Returns:
      true if the service definition is the default

    • isCoreServiceType

      public boolean isCoreServiceType()
      Return true if a core service type.
      Returns:
      true if a core service type
      Since:
      4.2.0

    • getServiceParameter

      public ServiceParameter getServiceParameter(String name)
      Return the service parameter for the given name.
      Parameters:
      name - the name of the service parameter
      Returns:
      the service parameter for the given name

    • getServiceParameterProperties

      public Properties getServiceParameterProperties(String serviceParameterName)
      Return the Java properties for the specified service parameter name.
      Parameters:
      serviceParameterName - the service parameter name
      Returns:
      Properties the Java properties for the service parameter

    • getServiceParameterMap

      public Map<String,String> getServiceParameterMap()
      Return a map of service parameter values keyed on service parameter name.

      Service parameters which are test case parameters are not included.

      Returns:
      map of service parameter values keyed on service parameter name.

    • getUnitTestServiceParameterMap

      public Map<String,String> getUnitTestServiceParameterMap()
      Return a map of unit test service parameter values keyed on service parameter name.
      Returns:
      a map of unit test service parameter values keyed on service parameter name.
      Since:
      4.3.0

    • getServiceParameterTypes

      public Map<String,String> getServiceParameterTypes()
      Return a map of service parameter types keyed on service parameter name.
      Returns:
      map of service parameter types keyed on service parameter name.
      Since:
      4.0.0

    • isFormDevAccessible

      public boolean isFormDevAccessible()
      Return whether this service definition is accessible to form developers (users who have the permission
      invalid reference 
      Permission#PERMISSION_FORM_SERVICE_EDIT
      but not
      invalid reference 
      Permission#PERMISSION_SERVICE_EDIT
      ) Note that this decision is based on service type.
      Returns:
      true if this service definition is accessible to form developers

    • hasFormPropertyEditorDefinitionParameter

      public boolean hasFormPropertyEditorDefinitionParameter()
      Returns:
      true if the service has as 'Form Property Editor Definition' property.
      Since:
      4.2.0

    • getNameAndVersionString

      public String getNameAndVersionString()
      Return a string uniquely identifying the service by combining service name with version number.
      Returns:
      a string combining name with version number
      Since:
      4.3.0

    • getNameVersionClientString

      public String getNameVersionClientString()
      Return a string uniquely identifying the service by combining service name with version number. If the service belongs to an organization, the organization code is also added.
      Returns:
      a string combining name with version number and client code (if applicable)
      Since:
      17.10.0

    • getSubmissionList

      @Deprecated public List<Submission> getSubmissionList()
      Deprecated.
      Do not call this method.
      Overrides:
      getSubmissionList in class _ServiceDefinition
      Returns:
      an empty list
      Since:
      4.3.4

    • isFluentApiService

      public boolean isFluentApiService()
      Returns:
      true if a Fluent API Service class.
      Since:
      5.0.0

    • getSecurityContext

      public String getSecurityContext()
      Returns:
      the security execution context
      Since:
      17.10.0