com.alipay.sofa.ark.tools

Class Repackager

java.lang.Object

com.alipay.sofa.ark.tools.Repackager

public class Repackager
extends Object

Utility class that can be used to repackage an archive so that it can be executed using java -jar

Since:

0.1.0

Author:

qilong.zql

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Repackager.MainClassTimeoutWarningListener Callback interface used to present a warning when finding the main class takes too long.

Constructor Summary

Constructors

Constructor and Description
Repackager(File source)

Method Summary

Modifier and Type	Method and Description
void	addMainClassTimeoutWarningListener(Repackager.MainClassTimeoutWarningListener listener) Add a listener that will be triggered to display a warning if searching for the main class takes too long.
Manifest	buildModuleManifest(JarFile source)
String	findMainMethodWithTimeoutWarning(JarFile source)
File	getModuleTargetFile()
boolean	isDeclaredMode()
boolean	isPackageProvided()
static boolean	isZip(File file)
static boolean	isZip(InputStream inputStream)
void	prepareDeclaredLibraries(Collection<ArtifactItem> artifactItems)
void	repackage(File appDestination, File moduleDestination, Libraries libraries) Repackage to the given destination so that it can be launched using ' java -jar'.
void	setArkVersion(String arkVersion)
void	setBaseDir(File baseDir)
void	setBizName(String bizName) Set the ark-biz name that represents a unique id during runtime, it can be bind uniquely to a ark-biz
void	setBizVersion(String bizVersion)
void	setDeclaredMode(boolean declaredMode)
void	setDenyImportClasses(LinkedHashSet<String> denyImportClasses)
void	setDenyImportPackages(LinkedHashSet<String> denyImportPackages)
void	setDenyImportResources(LinkedHashSet<String> denyImportResources)
void	setGitDirectory(File gitDirectory)
void	setInjectPluginDependencies(LinkedHashSet<String> injectPluginDependencies)
void	setInjectPluginExportPackages(LinkedHashSet<String> injectPluginExportPackages)
void	setKeepArkBizJar(boolean keepArkBizJar)
void	setMainClass(String mainClass) Set the main class that should be run.
void	setPackageProvided(boolean packageProvided)
void	setPriority(String priority)
void	setSkipArkExecutable(boolean skipArkExecutable)
static String	setToStr(Set<ArtifactItem> artifactItemSet, String delimiter)
void	setWebContextPath(String webContextPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

Repackager

public Repackager(File source)

Method Detail

addMainClassTimeoutWarningListener

public void addMainClassTimeoutWarningListener(Repackager.MainClassTimeoutWarningListener listener)

Add a listener that will be triggered to display a warning if searching for the main class takes too long.

Parameters:

listener - the listener to add

setMainClass

public void setMainClass(String mainClass)

Set the main class that should be run. If not specified the value from the MANIFEST will be used, or if no manifest entry is found the archive will be searched for a suitable class.

Parameters:

mainClass -

setBizName

public void setBizName(String bizName)

Set the ark-biz name that represents a unique id during runtime, it can be bind uniquely to a ark-biz

Parameters:

bizName -

setBizVersion

public void setBizVersion(String bizVersion)

setArkVersion

public void setArkVersion(String arkVersion)

setPriority

public void setPriority(String priority)

setDenyImportPackages

public void setDenyImportPackages(LinkedHashSet<String> denyImportPackages)

setDenyImportClasses

public void setDenyImportClasses(LinkedHashSet<String> denyImportClasses)

setDenyImportResources

public void setDenyImportResources(LinkedHashSet<String> denyImportResources)

setInjectPluginExportPackages

public void setInjectPluginExportPackages(LinkedHashSet<String> injectPluginExportPackages)

setInjectPluginDependencies

public void setInjectPluginDependencies(LinkedHashSet<String> injectPluginDependencies)

setGitDirectory

public void setGitDirectory(File gitDirectory)

prepareDeclaredLibraries

public void prepareDeclaredLibraries(Collection<ArtifactItem> artifactItems)

repackage

public void repackage(File appDestination,
                      File moduleDestination,
                      Libraries libraries)
               throws IOException

Repackage to the given destination so that it can be launched using ' java -jar'.

Parameters:

appDestination - the executable fat jar's destination

moduleDestination - the 'plug-in' module jar's destination

libraries - the libraries required to run the archive

Throws:

IOException - if the file cannot be repackaged

isZip

public static boolean isZip(File file)

isZip

public static boolean isZip(InputStream inputStream)
                     throws IOException

Throws:

IOException

buildModuleManifest

public Manifest buildModuleManifest(JarFile source)
                             throws IOException

Throws:

IOException

setToStr

public static String setToStr(Set<ArtifactItem> artifactItemSet,
                              String delimiter)

findMainMethodWithTimeoutWarning

public String findMainMethodWithTimeoutWarning(JarFile source)
                                        throws IOException

Throws:

IOException

getModuleTargetFile

public final File getModuleTargetFile()

isPackageProvided

public boolean isPackageProvided()

setPackageProvided

public void setPackageProvided(boolean packageProvided)

setSkipArkExecutable

public void setSkipArkExecutable(boolean skipArkExecutable)

setKeepArkBizJar

public void setKeepArkBizJar(boolean keepArkBizJar)

setBaseDir

public void setBaseDir(File baseDir)

setWebContextPath

public void setWebContextPath(String webContextPath)

setDeclaredMode

public void setDeclaredMode(boolean declaredMode)

isDeclaredMode

public boolean isDeclaredMode()