com.google.gerrit.server.plugins

Class JarPluginProvider

java.lang.Object

com.google.gerrit.server.plugins.JarPluginProvider

All Implemented Interfaces:

ServerPluginProvider

public class JarPluginProvider
extends java.lang.Object
implements ServerPluginProvider

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gerrit.server.plugins.ServerPluginProvider

ServerPluginProvider.PluginDescription

Method Summary

Modifier and Type	Method and Description
ServerPlugin	get(java.nio.file.Path srcPath, org.eclipse.jgit.internal.storage.file.FileSnapshot snapshot, ServerPluginProvider.PluginDescription description) Loads an external file or directory into a Server plugin.
static java.lang.String	getJarPluginName(java.nio.file.Path srcPath)
java.lang.String	getPluginName(java.nio.file.Path srcPath) Returns the plugin name of an external file or directory
java.lang.String	getProviderPluginName() Returns the plugin name of this provider.
boolean	handles(java.nio.file.Path srcPath) Declares the availability to manage an external file or directory
static java.nio.file.Path	storeInTemp(java.lang.String pluginName, java.io.InputStream in, SitePaths sitePaths)

Methods inherited from class java.lang.Object

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

Method Detail

handles

public boolean handles(java.nio.file.Path srcPath)

Description copied from interface: ServerPluginProvider

Declares the availability to manage an external file or directory

Specified by:

handles in interface ServerPluginProvider

Parameters:

srcPath - the external file or directory

Returns:

true if file or directory can be loaded into a Server Plugin

getPluginName

public java.lang.String getPluginName(java.nio.file.Path srcPath)

Description copied from interface: ServerPluginProvider

Returns the plugin name of an external file or directory

Should be called only if handles(srcFile) returns true and thus srcFile is a supported plugin format. An IllegalArgumentException is thrown otherwise as srcFile is not a valid file format for extracting its plugin name.

Specified by:

getPluginName in interface ServerPluginProvider

Parameters:

srcPath - external file or directory

Returns:

plugin name

getJarPluginName

public static java.lang.String getJarPluginName(java.nio.file.Path srcPath)
                                         throws java.io.IOException

Throws:

java.io.IOException

get

public ServerPlugin get(java.nio.file.Path srcPath,
                        org.eclipse.jgit.internal.storage.file.FileSnapshot snapshot,
                        ServerPluginProvider.PluginDescription description)
                 throws InvalidPluginException

Description copied from interface: ServerPluginProvider

Loads an external file or directory into a Server plugin.

Should be called only if handles(srcFile) returns true and thus srcFile is a supported plugin format. An IllegalArgumentException is thrown otherwise as srcFile is not a valid file format for extracting its plugin name.

Specified by:

get in interface ServerPluginProvider

Parameters:

srcPath - external file or directory

snapshot - snapshot of the external file

description - descriptor of the ServerPlugin to load

Throws:

InvalidPluginException - if plugin is supposed to be handled but cannot be loaded for any other reason

getProviderPluginName

public java.lang.String getProviderPluginName()

Description copied from interface: ServerPluginProvider

Returns the plugin name of this provider.

Allows to identify which plugin provided the current ServerPluginProvider by returning the plugin name. Helpful for troubleshooting plugin loading problems.

Specified by:

getProviderPluginName in interface ServerPluginProvider

Returns:

plugin name of this provider

storeInTemp

public static java.nio.file.Path storeInTemp(java.lang.String pluginName,
                                             java.io.InputStream in,
                                             SitePaths sitePaths)
                                      throws java.io.IOException

Throws:

java.io.IOException