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

Class ConfigurationServiceArchiveService

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.ConfigurationServiceArchiveService

public class ConfigurationServiceArchiveService
extends BaseArchiveService

Provides a Configuration service archive service.

Since:

23.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ConfigurationServiceArchiveService.ImportOption

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	CONFIGURATION_SERVICE_NAME
static final Map<String,String>	CONFIGURATION_SERVICE_VERSION
static final String	CREATE_OR_UPDATE_FLAG

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
ConfigurationServiceArchiveService()

Method Summary

Modifier and Type	Method	Description
protected void	exportAuditLogger(Object object)	Implement abstract method but not used yet in Configuration service.
static String	gerCurrentVersion()	Ger current Configuration Service version string.
protected String	getEntityName()	Gets entity name.
Map<String,String>	getImportMetadata(byte[] importData)	Gets import metadata.
IJMImportOption	getImportOptionEnum()	Return a value from the import option enum, if this service has import options.
protected void	importAuditLogger(ImportAction importAction)	Import audit logger.
protected void	performImport(ImportAction importAction, Set<? extends Enum> importOptions, Map<String,Object> parameters)	Perform import.
protected void	processImportFile(String fileName, byte[] fileData)	Implement abstract method but not used yet in Configuration service.
void	validateImportData(byte[] importData)	Validate import data.
protected void	writeExportData(Object object, ZipOutputStream zos, Map<String,String> additionalHeaders)	Implement abstract method but not supported yet in Configuration service.

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, 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

CREATE_OR_UPDATE_FLAG

public static final String CREATE_OR_UPDATE_FLAG

See Also:

• Constant Field Values

CONFIGURATION_SERVICE_VERSION

public static final Map<String,String> CONFIGURATION_SERVICE_VERSION

CONFIGURATION_SERVICE_NAME

public static final String CONFIGURATION_SERVICE_NAME

See Also:

• Constant Field Values

Constructor Details

ConfigurationServiceArchiveService

public ConfigurationServiceArchiveService()

Method Details

validateImportData

public void validateImportData(byte[] importData)
                        throws Exception

Validate import data.

Specified by:

validateImportData in class BaseArchiveService

Parameters:

importData - the import data

Throws:

Exception - the exception

getImportMetadata

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

Gets import metadata.

Specified by:

getImportMetadata in class BaseArchiveService

Parameters:

importData - the import data

Returns:

the import metadata

Throws:

Exception - the exception

performImport

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

Perform import.

Specified by:

performImport in class BaseArchiveService

Parameters:

importAction - the import action

importOptions - the import options

parameters - the parameters

Throws:

Exception - If an error occurs. The caller is responsible for rolling back the transaction to avoid contaminating the database.

importAuditLogger

protected void importAuditLogger(ImportAction importAction)

Import audit logger.

Specified by:

importAuditLogger in class BaseArchiveService

Parameters:

importAction - the import action

getImportOptionEnum

public IJMImportOption getImportOptionEnum()

Return a value from the import option enum, if this service has import options. Can be used to call IJMImportOption.defaultForImportAction(String)

Overrides:

getImportOptionEnum in class BaseArchiveService

Returns:

one of the import options

getEntityName

protected String getEntityName()

Gets entity name.

Specified by:

getEntityName in class BaseArchiveService

Returns:

the entity name

writeExportData

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

Implement abstract method but not supported yet in Configuration service.

Specified by:

writeExportData in class BaseArchiveService

Parameters:

object - the object

zos - the zos

additionalHeaders - the additional headers

Throws:

Exception - the exception

processImportFile

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

Implement abstract method but not used yet in Configuration service.

Specified by:

processImportFile in class BaseArchiveService

Parameters:

fileName - the file name

fileData - the file data

Throws:

Exception - the exception

exportAuditLogger

protected void exportAuditLogger(Object object)

Implement abstract method but not used yet in Configuration service.

Specified by:

exportAuditLogger in class BaseArchiveService

Parameters:

object - the object

gerCurrentVersion

public static String gerCurrentVersion()

Ger current Configuration Service version string.

Returns:

the string