com.flowcentraltech.flowcentral.codegeneration.generators

Class AbstractStaticModuleArtifactGenerator

java.lang.Object

com.tcdng.unify.core.AbstractUnifyComponent

com.flowcentraltech.flowcentral.common.AbstractFlowCentralComponent

com.flowcentraltech.flowcentral.codegeneration.generators.AbstractStaticModuleArtifactGenerator

All Implemented Interfaces:

StaticModuleArtifactGenerator, FlowCentralComponent, com.tcdng.unify.core.UnifyComponent

Direct Known Subclasses:

AbstractJavaArtifactGenerator, AbstractResourcesArtifactGenerator, ChartsXmlGenerator, DashboardsXmlGenerator

@Singleton(value=false)
public abstract class AbstractStaticModuleArtifactGenerator
extends AbstractFlowCentralComponent
implements StaticModuleArtifactGenerator

Convenient abstract base class for module static artifact generator.

Since:

1.0

Author:

FlowCentral Technologies Limited

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStaticModuleArtifactGenerator()
protected	AbstractStaticModuleArtifactGenerator(String zipDir)
protected	AbstractStaticModuleArtifactGenerator(String zipDir, String snapshotZipDir)

Method Summary

Modifier and Type	Method and Description
protected AppletUtilities	au()
protected boolean	checkGeneration(ExtensionModuleStaticFileBuilderContext ctx, String entityName)
protected void	closeEntry(ZipOutputStream zos)
protected abstract void	doGenerate(ExtensionModuleStaticFileBuilderContext ctx, String name, ZipOutputStream zos)
void	generate(ExtensionModuleStaticFileBuilderContext ctx, String entityName, ZipOutputStream zos) Generates static module artifact.
protected String	getDescriptionKey(String applicationName, String category, String description)
protected void	onInitialize()
protected void	onTerminate()
protected void	openEntry(ExtensionModuleStaticFileBuilderContext ctx, String filename, ZipOutputStream zos)

Methods inherited from class com.flowcentraltech.flowcentral.common.AbstractFlowCentralComponent

getRequestContextUtil, isEnterprise, postJsonObject, setCommandResponsePath, setCommandResultMapping

Methods inherited from class com.tcdng.unify.core.AbstractUnifyComponent

addTaskMessage, asJson, broadcastToOtherSessions, broadcastToSession, convert, convert, createArrayValueStore, createListValueStore, createParamConfig, createValueStore, createValueStore, createValueStore, findComponentType, fromJson, getAnnotatedClasses, getAnnotatedClassesExcluded, getApplicationAttribute, getApplicationAttribute, getApplicationBanner, getApplicationCode, getApplicationLocale, getApplicationLocaleFormatter, getApplicationMessage, getApplicationMessages, getApplicationName, getApplicationTimeZone, getAuxiliaryVersion, getComponent, getComponent, getComponent, getComponent, getComponent, getComponentConfig, getComponentConfig, getComponentConfigs, getComponentNames, getComponentParamConfigs, getComponents, getComponentType, getComponentType, getContainerInfo, getContainerSetting, getContainerSetting, getCurrentRolePrivilegeCodes, getCurrentUserRoleStepCodes, getDeploymentVersion, getErrorMessage, getExceptionMessage, getExceptionMessage, getLineSeparator, getList, getList, getListItemByDescription, getListItemByKey, getListMap, getListMap, getMessage, getName, getNodeId, getPreferredPort, getPrintableStackTrace, getPrintableStackTraceWithMessageHeader, getRequestAttribute, getRequestAttribute, getRequestContext, getRolePrivilegeCodes, getRuntimeId, getSessionAttribute, getSessionAttribute, getSessionContext, getSessionFormatter, getSessionLocale, getSessionLocaleFormatter, getSessionMessage, getSessionMessages, getStaticSettings, getUnifyComponentContext, getUplComponent, getUplComponent, getUserTenantId, getUserToken, getViewDirective, getWidgetDateFormatOverrideFormatter, getWorkingPathFilename, grabLock, grabLock, initialize, isApplicationAttribute, isApplicationIgnoreViewDirective, isClusterMode, isComponent, isCurrentRolePrivilege, isDeploymentMode, isGlobalAccounting, isInitialized, isInterfacesOpen, isLocked, isProductionMode, isRequestAttribute, isRoleAttributes, isSessionAttribute, isTenancyEnabled, isUserLoggedIn, isWidgetDateFormatOverride, logDebug, logDebug, logError, logError, logError, logError, logError, logInfo, logInfo, logSevere, logSevere, logWarn, logWarn, pause, prettyJson, prettyJsonOnDebug, prettyJsonOnError, prettyJsonOnInfo, prettyJsonOnSevere, prettyJsonOnWarn, releaseLock, removeApplicationAttribute, removeRequestAttribute, removeSessionAttribute, removeSessionAttributes, resolveApplicationMessage, resolveMessage, resolveSessionMessage, resolveUTC, sendCommand, setApplicationAttribute, setRequestAttribute, setRoleAttributes, setSessionAttribute, setSessionStickyAttribute, setUserTokenTenantId, terminate, throwOperationErrorException, throwUnsupportedOperationException, tryGrabLock

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tcdng.unify.core.UnifyComponent

getName, getNodeId, getUnifyComponentContext, initialize, isInitialized, terminate

Constructor Detail

AbstractStaticModuleArtifactGenerator

protected AbstractStaticModuleArtifactGenerator(String zipDir,
                                                String snapshotZipDir)

AbstractStaticModuleArtifactGenerator

protected AbstractStaticModuleArtifactGenerator(String zipDir)

AbstractStaticModuleArtifactGenerator

protected AbstractStaticModuleArtifactGenerator()

Method Detail

generate

public final void generate(ExtensionModuleStaticFileBuilderContext ctx,
                           String entityName,
                           ZipOutputStream zos)
                    throws com.tcdng.unify.core.UnifyException

Description copied from interface: StaticModuleArtifactGenerator

Generates static module artifact.

Specified by:

generate in interface StaticModuleArtifactGenerator

Parameters:

ctx - the module context

entityName - the entity name

zos - the zip output stream

Throws:

com.tcdng.unify.core.UnifyException - if an error occurs

au

protected AppletUtilities au()

doGenerate

protected abstract void doGenerate(ExtensionModuleStaticFileBuilderContext ctx,
                                   String name,
                                   ZipOutputStream zos)
                            throws com.tcdng.unify.core.UnifyException

Throws:

com.tcdng.unify.core.UnifyException

onInitialize

protected void onInitialize()
                     throws com.tcdng.unify.core.UnifyException

Specified by:

onInitialize in class com.tcdng.unify.core.AbstractUnifyComponent

Throws:

com.tcdng.unify.core.UnifyException

onTerminate

protected void onTerminate()
                    throws com.tcdng.unify.core.UnifyException

Specified by:

onTerminate in class com.tcdng.unify.core.AbstractUnifyComponent

Throws:

com.tcdng.unify.core.UnifyException

checkGeneration

protected boolean checkGeneration(ExtensionModuleStaticFileBuilderContext ctx,
                                  String entityName)
                           throws com.tcdng.unify.core.UnifyException

Throws:

com.tcdng.unify.core.UnifyException

openEntry

protected void openEntry(ExtensionModuleStaticFileBuilderContext ctx,
                         String filename,
                         ZipOutputStream zos)
                  throws com.tcdng.unify.core.UnifyException

Throws:

com.tcdng.unify.core.UnifyException

closeEntry

protected void closeEntry(ZipOutputStream zos)
                   throws com.tcdng.unify.core.UnifyException

Throws:

com.tcdng.unify.core.UnifyException

getDescriptionKey

protected String getDescriptionKey(String applicationName,
                                   String category,
                                   String description)