com.xebialabs.deployit.packager
Interface ManifestWriter

All Known Implementing Classes:
ManifestXmlWriter

public interface ManifestWriter

Writes a manifest file for inclusion in a Deployment Package (Dar file).


Nested Class Summary
static interface ManifestWriter.ManifestCiWriter
           
 
Method Summary
 void endManifest()
          Finishes writing the manifest.
 java.lang.String getManifestFileName()
           
 ManifestWriter.ManifestCiWriter writeCi(java.lang.String name, com.xebialabs.deployit.plugin.api.reflect.Type type)
          Add a Deployable configuration item to the manifest.
 ManifestWriter.ManifestCiWriter writeCi(java.lang.String name, com.xebialabs.deployit.plugin.api.reflect.Type type, java.lang.String fileArtifact)
          Add a Deployable configuration item to the manifest.
 ManifestWriter.ManifestCiWriter writeVersion(com.xebialabs.deployit.plugin.api.reflect.Type type, java.lang.String version, java.lang.String application)
          Writes the deployment package information to the manifest file.
 

Method Detail

getManifestFileName

java.lang.String getManifestFileName()

writeVersion

ManifestWriter.ManifestCiWriter writeVersion(com.xebialabs.deployit.plugin.api.reflect.Type type,
                                             java.lang.String version,
                                             java.lang.String application)
Writes the deployment package information to the manifest file.

Parameters:
type - The type of the deployment package
version - The version of the application that this package comprises.
application - The application name.

endManifest

void endManifest()
Finishes writing the manifest.


writeCi

ManifestWriter.ManifestCiWriter writeCi(java.lang.String name,
                                        com.xebialabs.deployit.plugin.api.reflect.Type type)
Add a Deployable configuration item to the manifest.

Parameters:
name - the name of the CI
type - the type of the CI
Returns:
A new ManifestWriter.ManifestCiWriter that can be used to write the properties to the manifest.

writeCi

ManifestWriter.ManifestCiWriter writeCi(java.lang.String name,
                                        com.xebialabs.deployit.plugin.api.reflect.Type type,
                                        java.lang.String fileArtifact)
Add a Deployable configuration item to the manifest.

Parameters:
name - the name of the CI
type - the type of the CI
fileArtifact - the file associated with the artifact
Returns:
A new ManifestWriter.ManifestCiWriter that can be used to write the properties to the manifest.