Class AdminHeader

java.lang.Object

org.jgroups.Header

org.jgroups.admin.AdminHeader

All Implemented Interfaces:

Constructable<Header>, SizeStreamable, Streamable

public class AdminHeader
extends Header

Header for admin messages

Since:

5.6.0

Author:

Bela Ban

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AdminHeader.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected String	command
protected String	key
protected AdminHeader.Type	type

Fields inherited from class Header

prot_id

Constructor Summary

Constructors

Constructor	Description
AdminHeader()
AdminHeader(String k, AdminHeader.Type type)
AdminHeader(String k, AdminHeader.Type t, String cmd)

Method Summary

Modifier and Type	Method	Description
String	command()
void	command(String c)
Supplier<? extends Header>	create()	Creates an instance of the class implementing this interface
short	getMagicId()	Returns the magic-ID.
String	key()
AdminHeader	key(String k)
void	readFrom(DataInput in)	Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
int	serializedSize()	Returns the size (in bytes) of the marshalled object
String	toString()
AdminHeader.Type	type()
AdminHeader	type(AdminHeader.Type t)
void	writeTo(DataOutput out)	Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class Header

getProtId, setProtId

Methods inherited from class Object

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

Field Details

key

protected String key

type

protected AdminHeader.Type type

command

protected String command

Constructor Details

AdminHeader

public AdminHeader()

AdminHeader

public AdminHeader(String k,
 AdminHeader.Type type)

AdminHeader

public AdminHeader(String k,
 AdminHeader.Type t,
 String cmd)

Method Details

key

public String key()

key

public AdminHeader key(String k)

type

public AdminHeader.Type type()

type

public AdminHeader type(AdminHeader.Type t)

command

public String command()

command

public void command(String c)

getMagicId

public short getMagicId()

Description copied from class: Header

Returns the magic-ID. If defined in jg-magic-map.xml, the IDs need to be the same

Specified by:

getMagicId in class Header

create

public Supplier<? extends Header> create()

Description copied from interface: Constructable

Creates an instance of the class implementing this interface

Returns:

Supplier

serializedSize

public int serializedSize()

Description copied from interface: SizeStreamable

Returns the size (in bytes) of the marshalled object

writeTo

public void writeTo(DataOutput out)
             throws IOException

Description copied from interface: Streamable

Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed

Throws:

IOException

readFrom

public void readFrom(DataInput in)
              throws IOException,
ClassNotFoundException

Description copied from interface: Streamable

Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed

Throws:

IOException

ClassNotFoundException

toString

public String toString()

Overrides:

toString in class Header