org.elasticsearch.action.admin.cluster.node.info

Class PluginInfo

java.lang.Object

org.elasticsearch.action.admin.cluster.node.info.PluginInfo

All Implemented Interfaces:

Serializable, Streamable, ToXContent

public class PluginInfo
extends Object
implements Streamable, Serializable, ToXContent

See Also:

Serialized Form

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	DESCRIPTION_NOT_AVAILABLE
static String	VERSION_NOT_AVAILABLE

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
PluginInfo()
PluginInfo(String name, String description, boolean site, boolean jvm, String version) Information about plugins

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription()
String	getName()
String	getUrl() We compute the URL for sites: "/_plugin/" + name + "/"
String	getVersion()
int	hashCode()
boolean	isJvm()
boolean	isSite()
void	readFrom(StreamInput in)
static PluginInfo	readPluginInfo(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

DESCRIPTION_NOT_AVAILABLE

public static final String DESCRIPTION_NOT_AVAILABLE

See Also:

Constant Field Values

VERSION_NOT_AVAILABLE

public static final String VERSION_NOT_AVAILABLE

See Also:

Constant Field Values

Constructor Detail

PluginInfo

public PluginInfo()

PluginInfo

public PluginInfo(String name,
                  String description,
                  boolean site,
                  boolean jvm,
                  String version)

Information about plugins

Parameters:

name - Its name

description - Its description

site - true if it's a site plugin

jvm - true if it's a jvm plugin

version - Version number is applicable (NA otherwise)

Method Detail

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

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

readPluginInfo

public static PluginInfo readPluginInfo(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