MicroTAPAS.mobility
Class MobilitySupportActor

java.lang.Object
  |
  +--MicroTAPAS.MicroActor
        |
        +--MicroTAPAS.mobility.MobilitySupportActor

All Implemented Interfaces:

ControlInterface, MicroActorInterface, java.io.Serializable

Direct Known Subclasses:

MobilityAgent1, MobilityManager1

abstract class MobilitySupportActor

extends MicroActor

implements ControlInterface

This is an abstract class to contain all the common functionality for the MobilityManager and MobilityAgent classes.

Field Summary

protected static boolean	DEBUG Determines whether debug info to be sent to debug-server
protected static boolean	isConnected
protected Node	node Object to hold information about THIS node
protected java.lang.String	nodeID Unique ID for this terminal
protected static MicroPingClient	pc
protected static MicroPingServer	ps
protected GAI	registryGAI Address of the registry where this node is registered

Fields inherited from class MicroTAPAS.MicroActor

bf, context, debug, fh, properties

Constructor Summary

protected

MobilitySupportActor() Constructor

Method Summary

RequestResult	actorEntry(RequestPars rp) Common enrty point of this actor to invoke some activity from outside
void	cleanUp()
RequestResult	control(java.lang.String command, java.lang.String[] pars) Controls this entity through text commands and paramters.
boolean	getConnected() Returns the connection status of this entity
abstract java.util.Vector	getPingNodes() Returns a vector of pingable nodes
void	init(ActorContext pAC) To leave constructor empty, this method is used to initialize Object data
abstract RequestResult	mobilityActorEntry(RequestPars rp) Method to access/control child objects.
protected RequestResult	requestToActor(RequestPars pRP) Common method for most types of requests from actors to other actors
abstract void	setConnected(boolean pIsConnected, Node pNode) Method that handles changing of connection status.
void	start() Starts this entity
Item	status() Status report of this entity in Item hierarchy of information elements.
void	term() Terminate method from the ActorInterface.
abstract void	terminalMoveLocation(java.lang.String oldNode, java.lang.String newNode) Handles the terminal move operation.

Methods inherited from class MicroTAPAS.MicroActor

findRoleSession, getGAI, terminalMove

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

protected static final boolean DEBUG

Determines whether debug info to be sent to debug-server

See Also:

Constant Field Values

registryGAI

protected GAI registryGAI

Address of the registry where this node is registered

nodeID

protected java.lang.String nodeID

Unique ID for this terminal

pc

protected static MicroPingClient pc

ps

protected static MicroPingServer ps

isConnected

protected static boolean isConnected

node

protected Node node

Object to hold information about THIS node

Constructor Detail

MobilitySupportActor

protected MobilitySupportActor()

Constructor

Method Detail

init

public void init(ActorContext pAC)

To leave constructor empty, this method is used to initialize Object data

Overrides:

init in class MicroActor

Parameters:

pAC - context data for this actor

start

public void start()

Starts this entity

Specified by:

start in interface MicroActorInterface

Overrides:

start in class MicroActor

mobilityActorEntry

public abstract RequestResult mobilityActorEntry(RequestPars rp)

Method to access/control child objects.

setConnected

public abstract void setConnected(boolean pIsConnected,
                                  Node pNode)

Method that handles changing of connection status.

terminalMoveLocation

public abstract void terminalMoveLocation(java.lang.String oldNode,
                                          java.lang.String newNode)

Handles the terminal move operation.

getPingNodes

public abstract java.util.Vector getPingNodes()

Returns a vector of pingable nodes

control

public RequestResult control(java.lang.String command,
                             java.lang.String[] pars)
                      throws java.lang.Exception

Controls this entity through text commands and paramters. This method will only be called if any child object can't handle the request. Subsequently, all common functionality should be put in this method.

Specified by:

control in interface ControlInterface

Parameters:

command - the command to be performed

Returns:

TAPAS style result indication of the operation

java.lang.Exception

actorEntry

public RequestResult actorEntry(RequestPars rp)

Common enrty point of this actor to invoke some activity from outside

Specified by:

actorEntry in interface MicroActorInterface

Parameters:

rp - Parameters for the activity this actorEntry will attempt to carry out

Returns:

Result of the activity this actorEntry attempted to carry out

getConnected

public boolean getConnected()

Returns the connection status of this entity

Returns:

Connection status. false indicates no connection.

requestToActor

protected RequestResult requestToActor(RequestPars pRP)

Common method for most types of requests from actors to other actors

Parameters:

pRP - The request

Returns:

TAPAS style result of the request

status

public Item status()

Status report of this entity in Item hierarchy of information elements.

Overrides:

status in class MicroActor

Returns:

Hierarchy of Item information elements

cleanUp

public void cleanUp()

Specified by:

cleanUp in interface ControlInterface

term

public void term()

Terminate method from the ActorInterface. This is the last action before actor is terminated.

Specified by:

term in interface MicroActorInterface

Overrides:

term in class MicroActor