Package com.google.gerrit.server.plugins

Class Plugin

java.lang.Object

com.google.gerrit.server.plugins.Plugin

Direct Known Subclasses:

ServerPlugin

public abstract class Plugin
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Plugin.ApiType
static final class	Plugin.CacheKey	Unique key that changes whenever a plugin reloads.

Field Summary

Fields

Modifier and Type	Field	Description
protected com.google.gerrit.lifecycle.LifecycleManager	manager
protected List<ReloadableRegistrationHandle<?>>	reloadableHandles

Constructor Summary

Constructors

Constructor	Description
Plugin(String name, Path srcPath, PluginUser pluginUser, org.eclipse.jgit.internal.storage.file.FileSnapshot snapshot, Plugin.ApiType apiType)

Method Summary

Modifier and Type	Method	Description
void	add(RegistrationHandle handle)
protected abstract boolean	canReload()
abstract com.google.inject.Injector	getApiInjector()
Optional<com.google.inject.Module>	getApiModule()
Plugin.ApiType	getApiType()
String	getApiVersion()
Plugin.CacheKey	getCacheKey()
com.google.gerrit.server.plugins.CleanupHandle	getCleanupHandle()
abstract PluginContentScanner	getContentScanner()
abstract com.google.inject.Injector	getHttpInjector()
String	getName()
Path	getSrcFile()
abstract com.google.inject.Injector	getSshInjector()
abstract com.google.inject.Injector	getSysInjector()
abstract String	getVersion()
boolean	isDisabled()
void	setCleanupHandle(com.google.gerrit.server.plugins.CleanupHandle cleanupHandle)
protected abstract void	start(PluginGuiceEnvironment env)
protected abstract void	stop(PluginGuiceEnvironment env)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

manager

protected com.google.gerrit.lifecycle.LifecycleManager manager

reloadableHandles

protected List<ReloadableRegistrationHandle<?>> reloadableHandles

Constructor Details

Plugin

public Plugin(String name,
 Path srcPath,
 PluginUser pluginUser,
 org.eclipse.jgit.internal.storage.file.FileSnapshot snapshot,
 Plugin.ApiType apiType)

Method Details

getCleanupHandle

public com.google.gerrit.server.plugins.CleanupHandle getCleanupHandle()

setCleanupHandle

public void setCleanupHandle(com.google.gerrit.server.plugins.CleanupHandle cleanupHandle)

getSrcFile

public Path getSrcFile()

getName

public String getName()

getVersion

public abstract String getVersion()

getApiType

public Plugin.ApiType getApiType()

getApiVersion

public String getApiVersion()

getCacheKey

public Plugin.CacheKey getCacheKey()

isDisabled

public boolean isDisabled()

start

protected abstract void start(PluginGuiceEnvironment env)
                       throws Exception

Throws:

Exception

stop

protected abstract void stop(PluginGuiceEnvironment env)

getContentScanner

public abstract PluginContentScanner getContentScanner()

getSysInjector

public abstract com.google.inject.Injector getSysInjector()

getSshInjector

public abstract com.google.inject.Injector getSshInjector()

getHttpInjector

public abstract com.google.inject.Injector getHttpInjector()

getApiInjector

public abstract com.google.inject.Injector getApiInjector()

add

public void add(RegistrationHandle handle)

toString

public String toString()

Overrides:

toString in class Object

canReload

protected abstract boolean canReload()

getApiModule

public Optional<com.google.inject.Module> getApiModule()