org.mule.tools.api.packager

Class PackageBuilder

java.lang.Object

org.mule.tools.api.packager.PackageBuilder

public class PackageBuilder
extends Object

Builder for Mule Application archives.

Constructor Summary

Constructors

Constructor and Description
PackageBuilder()

Method Summary

Modifier and Type	Method and Description
void	createDeployableFile() Creates the application package.
void	createMuleApp(File destinationFile, String originFolder, PackagingType packagingType, boolean onlyMuleSources, boolean lightweightPackage, boolean attachMuleSources) Creates a mule app package based on the contents of the origin folder, writing them to the destination jar file.
PackageBuilder	fromWorkingDirectory(Path workingDirectory) It wires all the possible folders that should be properly name from the workingDirectory to the package.
MuleArchiver	getMuleArchiver()
PackageBuilder	withArchiver(MuleArchiver archiver)
PackageBuilder	withClasses(File folder)
PackageBuilder	withDestinationFile(File file)
PackageBuilder	withMaven(File folder)
PackageBuilder	withMuleArtifact(File folder)
PackageBuilder	withMuleSrc(File folder)
PackageBuilder	withRepository(File folder)
PackageBuilder	withRootResource(File resource)

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageBuilder

public PackageBuilder()

Method Detail

getMuleArchiver

public MuleArchiver getMuleArchiver()

withArchiver

public PackageBuilder withArchiver(MuleArchiver archiver)

Parameters:

archiver -

Returns:

builder

withClasses

public PackageBuilder withClasses(File folder)

Parameters:

folder - folder with all the configuration files of the application

Returns:

builder

withMaven

public PackageBuilder withMaven(File folder)

withMuleSrc

public PackageBuilder withMuleSrc(File folder)

withMuleArtifact

public PackageBuilder withMuleArtifact(File folder)

withRepository

public PackageBuilder withRepository(File folder)

withRootResource

public PackageBuilder withRootResource(File resource)

withDestinationFile

public PackageBuilder withDestinationFile(File file)

Parameters:

file - file to be created with the content of the app

Returns:

fromWorkingDirectory

public PackageBuilder fromWorkingDirectory(Path workingDirectory)

It wires all the possible folders that should be properly name from the workingDirectory to the package.

Parameters:

workingDirectory - a directory containing all the folders properly named

Returns:

a PackageBuilder

createDeployableFile

public void createDeployableFile()
                          throws IOException

Creates the application package. It does so using the provided directories. If a directory does not exits or a directory path is not an actual directory then such element will not be added to the final package.

Throws:

IOException

createMuleApp

public void createMuleApp(File destinationFile,
                          String originFolder,
                          PackagingType packagingType,
                          boolean onlyMuleSources,
                          boolean lightweightPackage,
                          boolean attachMuleSources)
                   throws org.codehaus.plexus.archiver.ArchiverException,
                          IOException

Creates a mule app package based on the contents of the origin folder, writing them to the destination jar file. The target file is supposed to have more or less the structure of the example below:

 ├── log4j2.xml
 ├── org
 │   └── MyClass.class
 ├── mule
 │   ├── package
 │   └── mule-configuration(s).xml
 ├── api
 │   └── *.raml
 └── wsdl
 │   └── *.wsdl
 ├── META-INF
 │   ├── mule-src
 │   │   └── application-name
 │   ├── maven
 │   │   ├── group-id
 │   │   └── artifact-id
 │   │       ├── pom.xml
 │   │       └── pom.properties
 │   └── mule-artifact
 │       ├── classloader-model.json
 │       └── mule-artifact.json
 └── repository
     ├── org
     └── mule
         ├── munit
         └── munit-common
             ├── 1.1.0
             │   ├── *.jar
             │   └── pom.xml
             └── 2.0.0
                 ├── *.jar
                 └── pom.xml
 

Parameters:

destinationFile - file that represents the resource that is going to represent the final package.

originFolder - folder containing the source files.

packagingType - packaging type of the app that is being built.

onlyMuleSources - when set to true, generates a package that is restricted to contain only mule sources.

lightweightPackage - when set to true, generates a package with an empty repository folder.

attachMuleSources - when set to true, adds the mule source files to final package.

Throws:

org.codehaus.plexus.archiver.ArchiverException

IOException