org.elasticsearch.plugins

Class PluginInfo

java.lang.Object

org.elasticsearch.plugins.PluginInfo

All Implemented Interfaces:

Streamable, ToXContent

Direct Known Subclasses:

DummyPluginInfo

public class PluginInfo
extends Object
implements Streamable, ToXContent

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static String	ES_PLUGIN_POLICY
static String	ES_PLUGIN_PROPERTIES

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
PluginInfo()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getClassname()
String	getDescription()
String	getName()
String	getUrl() We compute the URL for sites: "/_plugin/" + name + "/"
String	getVersion()
int	hashCode()
boolean	isIsolated()
boolean	isJvm()
boolean	isSite()
void	readFrom(StreamInput in)
static PluginInfo	readFromProperties(Path dir) reads (and validates) plugin metadata descriptor file
static PluginInfo	readFromStream(StreamInput in)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ES_PLUGIN_PROPERTIES

public static final String ES_PLUGIN_PROPERTIES

See Also:

Constant Field Values

ES_PLUGIN_POLICY

public static final String ES_PLUGIN_POLICY

See Also:

Constant Field Values

Constructor Detail

PluginInfo

public PluginInfo()

Method Detail

readFromProperties

public static PluginInfo readFromProperties(Path dir)
                                     throws IOException

reads (and validates) plugin metadata descriptor file

Throws:

IOException

getName

public String getName()

Returns:

Plugin's name

getDescription

public String getDescription()

Returns:

Plugin's description if any

isSite

public boolean isSite()

Returns:

true if it's a site plugin

isJvm

public boolean isJvm()

Returns:

true if it's a plugin running in the jvm

isIsolated

public boolean isIsolated()

Returns:

true if jvm plugin has isolated classloader

getClassname

public String getClassname()

Returns:

jvm plugin's classname

getUrl

public String getUrl()

We compute the URL for sites: "/_plugin/" + name + "/"

Returns:

relative URL for site plugin

getVersion

public String getVersion()

Returns:

Version number for the plugin

readFromStream

public static PluginInfo readFromStream(StreamInput in)
                                 throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object