flexagon.fd.core.plugin

Class FlexBuildArtifacts

java.lang.Object

flexagon.fd.core.plugin.FlexBuildArtifacts

public class FlexBuildArtifacts
extends java.lang.Object

Utility class to help build artifact zip file for partial deploy operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected WorkflowExecutionContext	mContext
protected static java.lang.String	MISSING_FILE_MESSAGE_PREFIX

Constructor Summary

Constructors

Constructor and Description
FlexBuildArtifacts(WorkflowExecutionContext pWorkflowExecutionContext)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	calculateDirectoryHash(java.io.File dirToHash) This is not common but during build all files in a folder are used to calculate hash of entire folder.
protected java.lang.String	calculateFileHash(java.io.File pFile) This is most commonly used during build as most partial deployment project work with individual files.
protected java.lang.String	calculateHash(ProjectObject projectObject) If isMetaDataOnlyProjectObject then we do not have enough details to calculate hash, so just use System.currentTimeMillis in this case.
java.io.File	checkFileInSource(java.lang.String pFile, boolean pThrowException)
protected java.io.File	checkFolder(java.lang.String pTargetFolder)
java.util.List<PackageObject>	finalizePackageObjects(java.util.List<PackageObject> pPackageObjects, boolean pZipObjects)
java.util.List<PackageObject>	generateZIPArtifact(java.util.List<PackageObject> pPackageObjects) Utility for Partial Deployments.
WorkflowExecutionContext	getContext()
protected java.io.File	getFile(java.lang.String pSourceFolder, java.lang.String pFile)
java.util.List<java.lang.String>	getSourceDirectories()
java.lang.String	getTargetDirectory()
java.lang.String	getZipFileName()
protected boolean	includeObjectInZip(ProjectObject projectObject) This is used by classes that extend it to determine if files should be included in the zip.
protected boolean	isMetaDataOnlyProjectObject(ProjectObject pProjectObject)
protected void	prepareTempFileCollectionFolder(java.io.File pTempFileCollectionFolder) Overridden by subclasses to add any files to the collection folder which should be part of the zip even if they are not included in package.

Methods inherited from class java.lang.Object

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

Field Detail

MISSING_FILE_MESSAGE_PREFIX

protected static final java.lang.String MISSING_FILE_MESSAGE_PREFIX

See Also:

Constant Field Values

mContext

protected WorkflowExecutionContext mContext

Constructor Detail

FlexBuildArtifacts

public FlexBuildArtifacts(WorkflowExecutionContext pWorkflowExecutionContext)

Method Detail

getContext

public WorkflowExecutionContext getContext()

getTargetDirectory

public java.lang.String getTargetDirectory()

getZipFileName

public java.lang.String getZipFileName()

getSourceDirectories

public java.util.List<java.lang.String> getSourceDirectories()

generateZIPArtifact

public java.util.List<PackageObject> generateZIPArtifact(java.util.List<PackageObject> pPackageObjects)
                                                  throws FlexCheckedException

Utility for Partial Deployments. Generates ZIP artifact for ProjectObjects. This utility adds the Hash to the Object and returns ProjectObjects back as IN-Out parameter.

Throws:

FlexCheckedException

finalizePackageObjects

public java.util.List<PackageObject> finalizePackageObjects(java.util.List<PackageObject> pPackageObjects,
                                                            boolean pZipObjects)
                                                     throws FlexCheckedException

Throws:

FlexCheckedException

includeObjectInZip

protected boolean includeObjectInZip(ProjectObject projectObject)

This is used by classes that extend it to determine if files should be included in the zip.

Returns:

boolean, whether to include a project object in the zip file

checkFolder

protected java.io.File checkFolder(java.lang.String pTargetFolder)

Parameters:

pTargetFolder - the folder to check if it's a real folder

Returns:

File if it's a real folder, otherwise a FlexInvalidArgumentException is thrown.

getFile

protected java.io.File getFile(java.lang.String pSourceFolder,
                               java.lang.String pFile)

calculateDirectoryHash

protected java.lang.String calculateDirectoryHash(java.io.File dirToHash)
                                           throws FlexCheckedException

This is not common but during build all files in a folder are used to calculate hash of entire folder.

Returns:

hash string of the directory

Throws:

FlexCheckedException

calculateFileHash

protected java.lang.String calculateFileHash(java.io.File pFile)
                                      throws FlexCheckedException

This is most commonly used during build as most partial deployment project work with individual files.

Returns:

hash string of the file

Throws:

FlexCheckedException

calculateHash

protected java.lang.String calculateHash(ProjectObject projectObject)

If isMetaDataOnlyProjectObject then we do not have enough details to calculate hash, so just use System.currentTimeMillis in this case.

Returns:

hash string of a metadata only Project Object

checkFileInSource

public java.io.File checkFileInSource(java.lang.String pFile,
                                      boolean pThrowException)

isMetaDataOnlyProjectObject

protected boolean isMetaDataOnlyProjectObject(ProjectObject pProjectObject)

prepareTempFileCollectionFolder

protected void prepareTempFileCollectionFolder(java.io.File pTempFileCollectionFolder)
                                        throws FlexCheckedException

Overridden by subclasses to add any files to the collection folder which should be part of the zip even if they are not included in package. This is used if there are other supported files needed on the deploy side.

Throws:

FlexCheckedException