Package com.atlassian.plugin

Class JarPluginArtifact

java.lang.Object

com.atlassian.plugin.JarPluginArtifact

All Implemented Interfaces:

PluginArtifact, PluginArtifact.HasExtraModuleDescriptors

public final class JarPluginArtifact
extends Object
implements PluginArtifact, PluginArtifact.HasExtraModuleDescriptors

The implementation of PluginArtifact that is backed by a jar file.

Since:

2.0.0

See Also:

• PluginArtifact

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.plugin.PluginArtifact

PluginArtifact.HasExtraModuleDescriptors

Constructor Summary

Constructors

Constructor	Description
JarPluginArtifact(File jarFile)	Construct a PluginArtifact for a jar file which does not allow reference installation.
JarPluginArtifact(File jarFile, ReferenceMode referenceMode)	Construct a PluginArtifact for a jar file and specify whether reference installation is supported.

Method Summary

Modifier and Type	Method	Description
boolean	containsJavaExecutableCode()
boolean	containsSpringContext()
boolean	doesResourceExist(String name)
Set<String>	extraModuleDescriptorFiles(String rootFolder)
InputStream	getInputStream()
String	getName()
ReferenceMode	getReferenceMode()
InputStream	getResourceAsStream(String fileName)
File	toFile()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

JarPluginArtifact

public JarPluginArtifact(File jarFile)

Construct a PluginArtifact for a jar file which does not allow reference installation.

Parameters:

jarFile - the jar file comprising the artifact.

JarPluginArtifact

public JarPluginArtifact(File jarFile,
 ReferenceMode referenceMode)

Construct a PluginArtifact for a jar file and specify whether reference installation is supported.

Parameters:

jarFile - the jar file comprising the artifact.

referenceMode - specifies whether this artifact may be installed by reference.

Method Details

doesResourceExist

public boolean doesResourceExist(String name)

Specified by:

doesResourceExist in interface PluginArtifact

getResourceAsStream

public InputStream getResourceAsStream(String fileName)

Specified by:

getResourceAsStream in interface PluginArtifact

Returns:

an input stream for the this file in the jar. Closing this stream also closes the jar file this stream comes from.

getName

public String getName()

Specified by:

getName in interface PluginArtifact

toString

public String toString()

Overrides:

toString in class Object

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface PluginArtifact

Returns:

a buffered file input stream of the file on disk. This input stream is not resettable.

toFile

public File toFile()

Specified by:

toFile in interface PluginArtifact

containsJavaExecutableCode

public boolean containsJavaExecutableCode()

Specified by:

containsJavaExecutableCode in interface PluginArtifact

containsSpringContext

public boolean containsSpringContext()

Specified by:

containsSpringContext in interface PluginArtifact

extraModuleDescriptorFiles

public Set<String> extraModuleDescriptorFiles(String rootFolder)

Specified by:

extraModuleDescriptorFiles in interface PluginArtifact.HasExtraModuleDescriptors

getReferenceMode

public ReferenceMode getReferenceMode()

Specified by:

getReferenceMode in interface PluginArtifact