rescuecore2.messages.control

Class AKConnect

java.lang.Object

rescuecore2.messages.AbstractMessage

rescuecore2.messages.control.AKConnect

All Implemented Interfaces:

Control, Message

public class AKConnect
extends AbstractMessage
implements Control

A message for connecting an agent to the kernel.

Constructor Summary

Constructors

Constructor and Description
AKConnect(java.io.InputStream in) An AKConnect message that populates its data from a stream.
AKConnect(int requestID, int version, java.lang.String agentName, java.lang.String... requestedEntityTypes) An AKConnect with particular version, requestID and requested entity types.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAgentName() Get the name of the agent making this request.
java.util.List<java.lang.String>	getRequestedEntityTypes() Get the requested entity types.
int	getRequestID() Get the request ID.
int	getVersion() Get the version number of this request.

Methods inherited from class rescuecore2.messages.AbstractMessage

addMessageComponent, getComponents, getURN, read, toString, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface rescuecore2.messages.Message

getURN, read, write

Constructor Detail

AKConnect

public AKConnect(java.io.InputStream in)
          throws java.io.IOException

An AKConnect message that populates its data from a stream.

Parameters:

in - The InputStream to read.

Throws:

java.io.IOException - If there is a problem reading the stream.

AKConnect

public AKConnect(int requestID,
                 int version,
                 java.lang.String agentName,
                 java.lang.String... requestedEntityTypes)

An AKConnect with particular version, requestID and requested entity types.

Parameters:

requestID - The request ID.

version - The version number.

agentName - The name of the agent.

requestedEntityTypes - The set of requested entity types.

Method Detail

getVersion

public int getVersion()

Get the version number of this request.

Returns:

The version number.

getRequestID

public int getRequestID()

Get the request ID.

Returns:

The request ID.

getAgentName

public java.lang.String getAgentName()

Get the name of the agent making this request.

Returns:

The agent name.

getRequestedEntityTypes

public java.util.List<java.lang.String> getRequestedEntityTypes()

Get the requested entity types.

Returns:

The requested entity types.