com.atlassian.plugin
Interface PluginJar

All Known Implementing Classes:

FilePluginJar

public interface PluginJar

Allows the retrieval of files or an input stream of a plugin JAR. Implementations must allow multiple calls to getInputStream().

See Also:

PluginController

Method Summary

java.io.InputStream	getFile(java.lang.String fileName)
java.lang.String	getFileName()
java.io.InputStream	getInputStream() Returns an InputStream for the entire plugin JAR.

Method Detail

getFile

java.io.InputStream getFile(java.lang.String fileName)
                            throws PluginParseException

Returns:

an input stream of the file specified inside the JAR.

Throws:

PluginParseException - if the file was not found or could not be read from the JAR.

getFileName

java.lang.String getFileName()

Returns:

the original name of the plugin JAR file. Typically used for persisting it to disk with a meaningful name.

getInputStream

java.io.InputStream getInputStream()

Returns an InputStream for the entire plugin JAR. Calling this multiple times will return a fresh input stream each time.