com.google.gerrit.server.plugins

Interface PluginContentScanner

All Known Implementing Classes:

AbstractPreloadedPluginScanner, JarScanner

public interface PluginContentScanner

Scans the plugin returning classes and resources.

Gerrit uses the scanner to automatically discover the classes and resources exported by the plugin for auto discovery of exported SSH commands, Servlets and listeners.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PluginContentScanner.ExtensionMetaData Plugin class extension meta-data

Field Summary

Fields

Modifier and Type	Field and Description
static PluginContentScanner	EMPTY Scanner without resources.

Method Summary

Modifier and Type	Method and Description
java.util.Enumeration<PluginEntry>	entries() Return all the resources inside a plugin
java.util.Optional<PluginEntry>	getEntry(java.lang.String resourcePath) Return the plugin resource associated to a path
java.io.InputStream	getInputStream(PluginEntry entry) Return the InputStream of the resource entry
java.util.jar.Manifest	getManifest() Return the plugin meta-data manifest
java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.lang.Iterable<PluginContentScanner.ExtensionMetaData>>	scan(java.lang.String pluginName, java.lang.Iterable<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations) Scans the plugin for declared public annotated classes

Field Detail

EMPTY

static final PluginContentScanner EMPTY

Scanner without resources.

Method Detail

getManifest

java.util.jar.Manifest getManifest()
                            throws java.io.IOException

Return the plugin meta-data manifest

Returns:

Manifest of the plugin or null if plugin has no meta-data

Throws:

java.io.IOException - if an I/O problem occurred whilst accessing the Manifest

scan

java.util.Map<java.lang.Class<? extends java.lang.annotation.Annotation>,java.lang.Iterable<PluginContentScanner.ExtensionMetaData>> scan(java.lang.String pluginName,
                                                                                                                                          java.lang.Iterable<java.lang.Class<? extends java.lang.annotation.Annotation>> annotations)
                                                                                                                                   throws InvalidPluginException

Scans the plugin for declared public annotated classes

Parameters:

pluginName - the plugin name

annotations - annotations declared by the plugin classes

Returns:

map of annotations and associated plugin classes found

Throws:

InvalidPluginException - if the plugin is not valid or corrupted

getEntry

java.util.Optional<PluginEntry> getEntry(java.lang.String resourcePath)
                                  throws java.io.IOException

Return the plugin resource associated to a path

Parameters:

resourcePath - full path of the resource inside the plugin package

Returns:

the resource object or Optional.absent() if the resource was not found

Throws:

java.io.IOException - if there was a problem retrieving the resource

getInputStream

java.io.InputStream getInputStream(PluginEntry entry)
                            throws java.io.IOException

Return the InputStream of the resource entry

Parameters:

entry - resource entry inside the plugin package

Returns:

the resource input stream

Throws:

java.io.IOException - if there was an I/O problem accessing the resource

entries

java.util.Enumeration<PluginEntry> entries()

Return all the resources inside a plugin

Returns:

the enumeration of all resources found