ServerPlugin (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.plugins.Plugin
- - com.google.gerrit.server.plugins.ServerPlugin

public class ServerPlugin
extends Plugin

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.gerrit.server.plugins.Plugin
  Plugin.ApiType, Plugin.CacheKey

Field Summary
- Fields inherited from class com.google.gerrit.server.plugins.Plugin
  manager

Constructor Summary

Constructors
Constructor and Description
`ServerPlugin(java.lang.String name, java.lang.String pluginCanonicalWebUrl, PluginUser pluginUser, java.nio.file.Path srcJar, org.eclipse.jgit.internal.storage.file.FileSnapshot snapshot, PluginContentScanner scanner, java.nio.file.Path dataDir, java.lang.ClassLoader classLoader)`
`ServerPlugin(java.lang.String name, java.lang.String pluginCanonicalWebUrl, PluginUser pluginUser, java.nio.file.Path srcJar, org.eclipse.jgit.internal.storage.file.FileSnapshot snapshot, PluginContentScanner scanner, java.nio.file.Path dataDir, java.lang.ClassLoader classLoader, java.lang.String metricsPrefix)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(com.google.gerrit.extensions.registration.RegistrationHandle handle)`
`protected boolean`	`canReload()`
`PluginContentScanner`	`getContentScanner()`
`com.google.inject.Injector`	`getHttpInjector()`
`com.google.inject.Injector`	`getSshInjector()`
`com.google.inject.Injector`	`getSysInjector()`
`java.lang.String`	`getVersion()`
`protected void`	`start(PluginGuiceEnvironment env)`
`protected void`	`stop(PluginGuiceEnvironment env)`

Methods inherited from class com.google.gerrit.server.plugins.Plugin
getApiType, getCacheKey, getCleanupHandle, getName, getSrcFile, isDisabled, setCleanupHandle, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ServerPlugin

public ServerPlugin(java.lang.String name,
            java.lang.String pluginCanonicalWebUrl,
            PluginUser pluginUser,
            java.nio.file.Path srcJar,
            org.eclipse.jgit.internal.storage.file.FileSnapshot snapshot,
            PluginContentScanner scanner,
            java.nio.file.Path dataDir,
            java.lang.ClassLoader classLoader,
            java.lang.String metricsPrefix)
             throws InvalidPluginException

Throws:: InvalidPluginException

ServerPlugin

public ServerPlugin(java.lang.String name,
            java.lang.String pluginCanonicalWebUrl,
            PluginUser pluginUser,
            java.nio.file.Path srcJar,
            org.eclipse.jgit.internal.storage.file.FileSnapshot snapshot,
            PluginContentScanner scanner,
            java.nio.file.Path dataDir,
            java.lang.ClassLoader classLoader)
             throws InvalidPluginException

Throws:: InvalidPluginException

Method Detail

getVersion
```
public java.lang.String getVersion()
```
Specified by:

getVersion in class Plugin

canReload
```
protected boolean canReload()
```
Specified by:

canReload in class Plugin

start

protected void start(PluginGuiceEnvironment env)
              throws java.lang.Exception

Specified by:: start in class Plugin
Throws:: java.lang.Exception

stop

protected void stop(PluginGuiceEnvironment env)

Specified by:: stop in class Plugin

getSysInjector
```
public com.google.inject.Injector getSysInjector()
```
Specified by:

getSysInjector in class Plugin

getSshInjector
```
public com.google.inject.Injector getSshInjector()
```
Specified by:

getSshInjector in class Plugin

getHttpInjector
```
public com.google.inject.Injector getHttpInjector()
```
Specified by:

getHttpInjector in class Plugin

add

public void add(com.google.gerrit.extensions.registration.RegistrationHandle handle)

Overrides:: add in class Plugin

getContentScanner
```
public PluginContentScanner getContentScanner()
```
Specified by:

getContentScanner in class Plugin

Class ServerPlugin

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gerrit.server.plugins.Plugin

Field Summary

Fields inherited from class com.google.gerrit.server.plugins.Plugin

Constructor Summary

Method Summary

Methods inherited from class com.google.gerrit.server.plugins.Plugin

Methods inherited from class java.lang.Object

Constructor Detail

ServerPlugin

ServerPlugin

Method Detail

getVersion

canReload

start

stop

getSysInjector

getSshInjector

getHttpInjector

add

getContentScanner