Package com.avoka.fc.core.service.archive

Class ScheduledServiceJobArchiveService

java.lang.Object

com.avoka.fc.core.service.BaseService

com.avoka.fc.core.service.CayenneService

com.avoka.fc.core.service.archive.BaseArchiveService

com.avoka.fc.core.service.archive.ScheduledServiceJobArchiveService

public class ScheduledServiceJobArchiveService
extends BaseArchiveService

Provides a scheduled service archive export and import service.

Since:

23.10.1

Nested Class Summary

Nested classes/interfaces inherited from class com.avoka.fc.core.service.archive.BaseArchiveService

BaseArchiveService.FormData

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METADATA_SCHEDULED_SERVICE_JOB_NAME	The constant METADATA_SCHEDULED_SERVICE_JOB_NAME.
static final String	SCHEDULED_JOB_CONFIG_FILENAME	The constant SCHEDULED_JOB_CONFIG_FILENAME.
static final String	SCHEDULED_SERVICE_JOB_NAME_PROPERTY	The constant SCHEDULED_SERVICE_JOB_NAME_PROPERTY.

Fields inherited from class com.avoka.fc.core.service.archive.BaseArchiveService

ATTRIBUTE_BUILD_NUMBER, ATTRIBUTE_DB_VERSION, ATTRIBUTE_ENVIRONMENT_NAME, ATTRIBUTE_EXPORT_DATE, ATTRIBUTE_FORM_PORTAL_ANONYMOUS, ATTRIBUTE_FORM_PORTAL_AUTHENTICATED, ATTRIBUTE_SFM_VERSION, DIR_FAR, DIR_FORM, DIR_RECEIPT, DIR_SCHEMA_SEED, DIR_XML_PREFILL, ELEMENT_APPLICATION_PACKAGE, ELEMENT_APPLICATION_PACKAGES, ELEMENT_AUTHENTICATION_MODE, ELEMENT_CATEGORY_NAME, ELEMENT_CLIENT, ELEMENT_CLIENT_CODE, ELEMENT_DOCUMENT_TYPE_CLIENT, ELEMENT_DOCUMENT_TYPE_NAME, ELEMENT_FORM_ABANDON_DELIVERY, ELEMENT_FORM_DELIVERY_PROD, ELEMENT_FORM_DELIVERY_TEST, ELEMENT_FORM_FUNCTION, ELEMENT_FORM_FUNCTIONS, ELEMENT_FORM_GROUP, ELEMENT_FORM_GROUPS, ELEMENT_FORM_PORTAL, ELEMENT_FORM_PORTAL_PORTAL_NAME, ELEMENT_FORM_PORTALS, ELEMENT_FORM_STATUS, ELEMENT_FORM_VALIDATION_DELIVERY, ELEMENT_METADATA_TAG_CLIENT, ELEMENT_METADATA_TAG_NAME, ELEMENT_PARAMETER_PREFILL_MAPPING, ELEMENT_PARAMETER_PREFILL_MAPPINGS, ELEMENT_PROPERTY_PREFILL_MAPPING, ELEMENT_PROPERTY_PREFILL_MAPPINGS, ELEMENT_PROPERTY_TYPE_CLIENT, ELEMENT_PROPERTY_TYPE_NAME, ELEMENT_PROPERTY_TYPE_SCOPE, ELEMENT_SCHEMA_CONFIG_MAPPING, ELEMENT_SCHEMA_CONFIG_MAPPINGS, ELEMENT_SCHEMA_EXTRACT_MAPPING, ELEMENT_SCHEMA_EXTRACT_MAPPINGS, ELEMENT_SCHEMA_SEED, ELEMENT_SERVICE, ELEMENT_SERVICE_CLIENT_CODE, ELEMENT_SERVICE_CONNECTION, ELEMENT_SERVICE_CONNECTIONS, ELEMENT_SERVICE_NAME, ELEMENT_SERVICE_PARAMETER, ELEMENT_SERVICE_PARAMETER_GROOVY_DEBUG_LOGGING, ELEMENT_SERVICE_PARAMETERS, ELEMENT_SERVICE_TYPE, ELEMENT_SERVICE_VERSION, ELEMENT_SERVICES, ELEMENT_TEMPLATE_VERSION, ELEMENT_TEMPLATE_VERSION_DEPLOYMENT, ELEMENT_TEMPLATE_VERSION_DEPLOYMENTS, ELEMENT_TEMPLATE_VERSIONS, ELEMENT_VERSION_ATTACHMENT, ELEMENT_VERSION_ATTACHMENTS, ELEMENT_VERSION_CATEGORIES, ELEMENT_VERSION_CATEGORY, ELEMENT_VERSION_METADATA_VALUE, ELEMENT_VERSION_METADATA_VALUES, ELEMENT_VERSION_PROPERTY_VALUE, ELEMENT_VERSION_PROPERTY_VALUES, ELEMENT_XML_PREFILL_MAPPING, ELEMENT_XML_PREFILL_MAPPINGS, ELEMENT_XML_PREFILL_VERSION, ENCODING, FILE_FAR_DEFAULT, FILE_SCHEMA_SEED_DEFAULT, FILE_XML_PREFILL_DEFAULT, groovySecureAPI, METADATA_ENVIRONMENT_NAME, METADATA_ENVIRONMENT_TYPE, METADATA_ENVIRONMENT_TYPE_MAESTRO, METADATA_EXPORT_DATE, METADATA_EXPORT_DB_VERSION, METADATA_EXPORT_REVISION, METADATA_EXPORT_VERSION, METADATA_IMPORT_ACTION, METADATA_IMPORT_ACTION_CONFLICT, METADATA_IMPORT_ACTION_CREATE, METADATA_IMPORT_ACTION_ERROR, METADATA_IMPORT_ACTION_MESSAGE, METADATA_IMPORT_ACTION_UPDATE, METADATA_JAVA_EE_WARNING, oldCurrentServiceVersions, PORTAL_AUTHENTICATION_DB_VERSION, SERVICE_TYPE_CARD_PAYMENT_OBSOLETE, TRANSFORMER_SERVICE_NAME, updatedTemplateVersionIds

Constructor Summary

Constructors

Constructor	Description
ScheduledServiceJobArchiveService()

Method Summary

Modifier and Type	Method	Description
protected void	exportAuditLogger(Object object)	Implement abstract method but not supported in this class since there is no entity
protected String	getEntityName()	Get entity name
Map<String,String>	getImportMetadata(byte[] importData)	Gets import metadata.
protected void	importAuditLogger(ImportAction importAction)	Import audit logger.
protected void	performImport(ImportAction importAction, Set<? extends Enum> importOptions, Map<String,Object> parameters)	Performs import.
protected void	processImportFile(String fileName, byte[] fileData)	Process import file
void	validateImportData(byte[] importData)	Validates import data.
protected void	writeExportData(Object object, ZipOutputStream zos, Map<String,String> additionalHeaders)	Exports archive

Methods inherited from class com.avoka.fc.core.service.archive.BaseArchiveService

addDeploymentSchedule, addForm, addFormFunctions, addFormGroups, addFormPortals, addParameterPrefillMaps, addPropertyPrefillMaps, addSchemaExtractMaps, addSchemaSeed, addService, addServiceConnection, addTemplateVersion, addTemplateVersionData, addVersionAttachments, addVersionCategories, addVersionMetadataValues, addVersionPropertyValues, addXmlPrefillMaps, copyFromElementToEntity, copyFromElementToEntity, createChildProperty, createChildValue, exportData, exportData, findFileInArchive, getByteArrayForElement, getByteArrayForZipEntry, getDefaultImportOptions, getElementForByteArray, getFormData, getFormVersionKey, getFormVersionKey, getImportOptionEnum, getTransformerServiceInstalled, importApplicationPackages, importApplicationPackages, importArchive, importArchive, importDeploymentPlan, importFormFunctions, importFormGroups, importFormPortals, importOldSchemaConfigMaps, importParameterPrefillMaps, importPropertyPrefillMaps, importSchemaExtractMaps, importSchemaSeed, importServiceConnection, importServiceDefinition, importServiceParameters, importTemplateVersionData, importTemplateVersions, importTemplateVersions, importVersionAttachments, importVersionCategories, importVersionMetadata, importVersionProperties, importXmlPrefillMaps, isGroovySecureAPI, postExport, postImport, readApplicationPackageReference, readClientCodeReference, readMetadataAttributes, readServiceName, readServiceReference, setGroovySecureAPI, transform, updateUnifiedAppFlagAndDoc, writeApplicationPackageReference, writeClientCodeReference, writeHeaderAttributes, writeServiceReference

Methods inherited from class com.avoka.fc.core.service.CayenneService

commitChanges, deleteObject, deleteObjects, findObject, getDataContext, getDataDomain, getObjectForPK, getObjectStore, newObject, performNamedQuery, performNamedQuery, performNamedQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performQuery, performQuery, refetchEntity, refetchObject, registerNewObject, rollbackChanges, toMap, toMap

Methods inherited from class com.avoka.fc.core.service.BaseService

getLogger

Methods inherited from class java.lang.Object

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

Field Details

SCHEDULED_JOB_CONFIG_FILENAME

public static final String SCHEDULED_JOB_CONFIG_FILENAME

The constant SCHEDULED_JOB_CONFIG_FILENAME.

See Also:

• Constant Field Values

METADATA_SCHEDULED_SERVICE_JOB_NAME

public static final String METADATA_SCHEDULED_SERVICE_JOB_NAME

The constant METADATA_SCHEDULED_SERVICE_JOB_NAME.

See Also:

• Constant Field Values

SCHEDULED_SERVICE_JOB_NAME_PROPERTY

public static final String SCHEDULED_SERVICE_JOB_NAME_PROPERTY

The constant SCHEDULED_SERVICE_JOB_NAME_PROPERTY.

See Also:

• Constant Field Values

Constructor Details

ScheduledServiceJobArchiveService

public ScheduledServiceJobArchiveService()

Method Details

validateImportData

public void validateImportData(byte[] importData)
                        throws ImportValidationException,
IOException

Validates import data.

Specified by:

validateImportData in class BaseArchiveService

Parameters:

importData - the import archive as a byte array

Throws:

ImportValidationException

IOException

getImportMetadata

public Map<String,String> getImportMetadata(byte[] importData)
                                     throws ImportValidationException,
IOException

Gets import metadata.

Specified by:

getImportMetadata in class BaseArchiveService

Parameters:

importData - the import archive as a byte array

Returns:

the import metadata

Throws:

ImportValidationException

IOException

writeExportData

protected void writeExportData(Object object,
 ZipOutputStream zos,
 Map<String,String> additionalHeaders)
                        throws IOException,
ParserConfigurationException

Exports archive

Specified by:

writeExportData in class BaseArchiveService

Parameters:

object - the non-null object to be exported

zos - the stream to be written to

additionalHeaders - the map of additional headers to be included in metadata

Throws:

IOException

ParserConfigurationException

processImportFile

protected void processImportFile(String fileName,
 byte[] fileData)
                          throws UnsupportedEncodingException

Process import file

Specified by:

processImportFile in class BaseArchiveService

Parameters:

fileName - the full file name of the ZIP file entry (e.g. form/TestForm.pdf)

fileData - the file data of the ZIP file entry

Throws:

UnsupportedEncodingException

performImport

protected void performImport(ImportAction importAction,
 Set<? extends Enum> importOptions,
 Map<String,Object> parameters)

Performs import.

Specified by:

performImport in class BaseArchiveService

Parameters:

importAction - the import action related to this import

importOptions - the set of import options that should be applied

parameters - optional parameters to be used during import

getEntityName

protected String getEntityName()

Get entity name

Specified by:

getEntityName in class BaseArchiveService

Returns:

entityName

exportAuditLogger

protected void exportAuditLogger(Object object)

Implement abstract method but not supported in this class since there is no entity

Specified by:

exportAuditLogger in class BaseArchiveService

Parameters:

object - Object exported (Optional)

importAuditLogger

protected void importAuditLogger(ImportAction importAction)

Import audit logger.

Specified by:

importAuditLogger in class BaseArchiveService

Parameters:

importAction - ImportAction containing action performed (required)