org.nuxeo.connect.update.util

Class PackageBuilder

java.lang.Object

org.nuxeo.connect.update.util.PackageBuilder

public class PackageBuilder
extends Object

Build an XML representation of a package.

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
protected List<org.nuxeo.connect.update.PackageDependency>	conflicts
protected org.nuxeo.connect.update.model.PackageDefinition	def
protected List<org.nuxeo.connect.update.PackageDependency>	dependencies
protected LinkedHashMap<String,InputStream>	entries
protected List<FormDefinition>	installForms
protected List<org.nuxeo.connect.update.PackageDependency>	optionalDependencies
protected List<String>	platforms
protected List<org.nuxeo.connect.update.PackageDependency>	provides
protected List<FormDefinition>	uninstallForms
protected List<FormDefinition>	validationForms

Constructor Summary

Constructors

Constructor and Description
PackageBuilder()

Method Summary

Modifier and Type	Method and Description
PackageBuilder	addEntry(String path, InputStream in) The entry content will be copied into the zip at build time and the given input stream will be closed.
protected void	addForms(List<FormDefinition> formDefs, String path, ZipOutputStream zout)
PackageBuilder	addInstallForm(FormDefinition form)
PackageBuilder	addInstallScript(InputStream in)
PackageBuilder	addInstallScript(String content)
PackageBuilder	addLicense(InputStream in)
PackageBuilder	addLicense(String content)
PackageBuilder	addTermsAndConditions(InputStream in)
PackageBuilder	addTermsAndConditions(String content)
PackageBuilder	addUninstallForm(FormDefinition form)
PackageBuilder	addUninstallScript(InputStream in)
PackageBuilder	addUninstallScript(String content)
PackageBuilder	addValidationForm(FormDefinition form)
File	build()
String	buildManifest()
PackageBuilder	classifier(String classifier)
PackageBuilder	conflict(String expr)
PackageBuilder	dependency(String expr)
PackageBuilder	description(String description)
PackageBuilder	homePage(String homePage)
PackageBuilder	hotReloadSupport(boolean hotReloadSupport)
PackageBuilder	installer(String type, boolean restart)
PackageBuilder	installer(org.nuxeo.connect.update.model.TaskDefinition task)
PackageBuilder	name(String name)
PackageBuilder	optionalDependency(String expr)
PackageBuilder	platform(String platform)
PackageBuilder	productionState(org.nuxeo.connect.update.ProductionState productionState)
PackageBuilder	provide(String expr)
PackageBuilder	requireTermsAndConditionsAcceptance(boolean requireTermsAndConditionsAcceptance)
PackageBuilder	supported(boolean supported)
PackageBuilder	title(String title)
PackageBuilder	type(org.nuxeo.connect.update.PackageType type)
PackageBuilder	type(String type)
PackageBuilder	uninstaller(String type, boolean restart)
PackageBuilder	uninstaller(org.nuxeo.connect.update.model.TaskDefinition task)
PackageBuilder	validationState(org.nuxeo.connect.update.NuxeoValidationState validationState)
PackageBuilder	validator(String validator)
PackageBuilder	vendor(String vendor)
PackageBuilder	version(String version)
PackageBuilder	version(org.nuxeo.connect.update.Version version)
PackageBuilder	visibility(org.nuxeo.connect.update.PackageVisibility visibility)
PackageBuilder	visibility(String visibility)

Methods inherited from class java.lang.Object

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

Field Detail

def

protected final org.nuxeo.connect.update.model.PackageDefinition def

installForms

protected final List<FormDefinition> installForms

uninstallForms

protected final List<FormDefinition> uninstallForms

validationForms

protected final List<FormDefinition> validationForms

platforms

protected final List<String> platforms

dependencies

protected final List<org.nuxeo.connect.update.PackageDependency> dependencies

optionalDependencies

protected final List<org.nuxeo.connect.update.PackageDependency> optionalDependencies

conflicts

protected final List<org.nuxeo.connect.update.PackageDependency> conflicts

provides

protected final List<org.nuxeo.connect.update.PackageDependency> provides

entries

protected final LinkedHashMap<String,InputStream> entries

Constructor Detail

PackageBuilder

public PackageBuilder()

Method Detail

name

public PackageBuilder name(String name)

version

public PackageBuilder version(org.nuxeo.connect.update.Version version)

version

public PackageBuilder version(String version)

type

public PackageBuilder type(String type)

type

public PackageBuilder type(org.nuxeo.connect.update.PackageType type)

visibility

public PackageBuilder visibility(String visibility)

Since:

5.6

visibility

public PackageBuilder visibility(org.nuxeo.connect.update.PackageVisibility visibility)

Since:

5.6

title

public PackageBuilder title(String title)

description

public PackageBuilder description(String description)

classifier

public PackageBuilder classifier(String classifier)

vendor

public PackageBuilder vendor(String vendor)

homePage

public PackageBuilder homePage(String homePage)

installer

public PackageBuilder installer(org.nuxeo.connect.update.model.TaskDefinition task)

installer

public PackageBuilder installer(String type,
                                boolean restart)

uninstaller

public PackageBuilder uninstaller(org.nuxeo.connect.update.model.TaskDefinition task)

uninstaller

public PackageBuilder uninstaller(String type,
                                  boolean restart)

validationState

public PackageBuilder validationState(org.nuxeo.connect.update.NuxeoValidationState validationState)

productionState

public PackageBuilder productionState(org.nuxeo.connect.update.ProductionState productionState)

supported

public PackageBuilder supported(boolean supported)

hotReloadSupport

public PackageBuilder hotReloadSupport(boolean hotReloadSupport)

requireTermsAndConditionsAcceptance

public PackageBuilder requireTermsAndConditionsAcceptance(boolean requireTermsAndConditionsAcceptance)

validator

public PackageBuilder validator(String validator)

platform

public PackageBuilder platform(String platform)

dependency

public PackageBuilder dependency(String expr)

optionalDependency

public PackageBuilder optionalDependency(String expr)

Since:

6.0-HF33

conflict

public PackageBuilder conflict(String expr)

provide

public PackageBuilder provide(String expr)

addInstallForm

public PackageBuilder addInstallForm(FormDefinition form)

addUninstallForm

public PackageBuilder addUninstallForm(FormDefinition form)

addValidationForm

public PackageBuilder addValidationForm(FormDefinition form)

addLicense

public PackageBuilder addLicense(String content)

addLicense

public PackageBuilder addLicense(InputStream in)

addInstallScript

public PackageBuilder addInstallScript(String content)

addInstallScript

public PackageBuilder addInstallScript(InputStream in)

addUninstallScript

public PackageBuilder addUninstallScript(String content)

addUninstallScript

public PackageBuilder addUninstallScript(InputStream in)

addTermsAndConditions

public PackageBuilder addTermsAndConditions(String content)

addTermsAndConditions

public PackageBuilder addTermsAndConditions(InputStream in)

addEntry

public PackageBuilder addEntry(String path,
                               InputStream in)

The entry content will be copied into the zip at build time and the given input stream will be closed. (event if an exception occurs) - so you don't need to handle stream closing.

buildManifest

public String buildManifest()

build

public File build()
           throws IOException

Throws:

IOException

addForms

protected void addForms(List<FormDefinition> formDefs,
                        String path,
                        ZipOutputStream zout)
                 throws IOException

Throws:

IOException