com.flowcentraltech.flowcentral.codegeneration.generators

Class AbstractStaticArtifactGenerator

java.lang.Object

com.tcdng.unify.core.AbstractUnifyComponent

com.flowcentraltech.flowcentral.codegeneration.generators.AbstractStaticArtifactGenerator

All Implemented Interfaces:

StaticArtifactGenerator, com.tcdng.unify.core.UnifyComponent

Direct Known Subclasses:

ApplicationXmlGenerator, ChartsXmlGenerator, DashboardsXmlGenerator, ExtensionModuleEntitiesJavaGenerator, ExtensionModuleMessagesGenerator, ExtensionModuleStaticSettingsJavaGenerator, ExtensionModuleXmlGenerator, NotificationsXmlGenerator, ReportsXmlGenerator, WorkflowsXmlGenerator

@Singleton(value=false)
public abstract class AbstractStaticArtifactGenerator
extends com.tcdng.unify.core.AbstractUnifyComponent
implements StaticArtifactGenerator

Convenient abstract base class for static artifact generator.

Since:

1.0

Author:

FlowCentral Technologies Limited

Constructor Summary

Constructors

Constructor and Description
AbstractStaticArtifactGenerator()
AbstractStaticArtifactGenerator(String zipDir)

Method Summary

Modifier and Type	Method and Description
protected void	closeEntry(ZipOutputStream zos)
protected abstract void	doGenerate(ExtensionModuleStaticFileBuilderContext ctx, String name, ZipOutputStream zos)
void	generate(ExtensionModuleStaticFileBuilderContext ctx, String entityName, ZipOutputStream zos)
protected String	getDescriptionKey(String applicationName, String category, String description)
protected void	onInitialize()
protected void	onTerminate()
protected void	openEntry(String filename, ZipOutputStream zos)

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

addTaskMessage, beginClusterLock, broadcastToOtherSessions, broadcastToSession, convert, convert, createArrayValueStore, createListValueStore, createParamConfig, createValueStore, createValueStore, createValueStore, endClusterLock, findComponentType, getAnnotatedClasses, getAnnotatedClassesExcluded, getApplicationAttribute, getApplicationBanner, getApplicationCode, getApplicationLocale, getApplicationLocaleFormatter, getApplicationMessage, getApplicationMessages, getApplicationName, getApplicationTimeZone, getAuxiliaryVersion, getComponent, getComponent, getComponent, 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, getRequestAttribute, getRequestContext, getRolePrivilegeCodes, getSessionAttribute, getSessionContext, getSessionLocale, getSessionLocaleFormatter, getSessionMessage, getSessionMessages, getStaticSettings, getUnifyComponentContext, getUplComponent, getUplComponent, getUserToken, getViewDirective, grabClusterLock, grabClusterMasterLock, initialize, isApplicationAttribute, isApplicationIgnoreViewDirective, isClusterMode, isComponent, isCurrentRolePrivilege, isDeploymentMode, isInitialized, isProductionMode, isRequestAttribute, isRoleAttributes, isSessionAttribute, isUserLoggedIn, isWithClusterLock, logDebug, logDebug, logError, logError, logError, logError, logInfo, logInfo, logSevere, logSevere, logWarn, logWarn, releaseClusterLock, removeApplicationAttribute, removeRequestAttribute, removeSessionAttribute, removeSessionAttributes, resolveApplicationMessage, resolveMessage, resolveSessionMessage, resolveUTC, sendCommand, setApplicationAttribute, setRequestAttribute, setRoleAttributes, setSessionAttribute, setSessionStickyAttribute, terminate, throwOperationErrorException, throwUnsupportedOperationException

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, getUnifyComponentContext, initialize, isInitialized, terminate

Constructor Detail

AbstractStaticArtifactGenerator

public AbstractStaticArtifactGenerator(String zipDir)

AbstractStaticArtifactGenerator

public AbstractStaticArtifactGenerator()

Method Detail

generate

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

Specified by:

generate in interface StaticArtifactGenerator

Throws:

com.tcdng.unify.core.UnifyException

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

openEntry

protected void openEntry(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)