gridsim.index
Class RegionalGIS

Object
  Thread
      Sim_entity
          GridSimCore
              AbstractGIS
                  RegionalGIS

All Implemented Interfaces:

Cloneable, Runnable

Direct Known Subclasses:

DataRegionalGIS

public class RegionalGIS
extends AbstractGIS

RegionalGIS is a simple regional GridInformationService (GIS) entity that performs basic functionalities, such as storing a list of local resources, and asking other regional GIS entities for resources.

If you want to implement other complex functionalities, you need to extend this class and to override processOtherEvent(Sim_event) and/or registerOtherEntity() method.

Since:

GridSim Toolkit 3.2

Author:

Anthony Sulistio

Invariant:

$none

Nested Class Summary

Nested classes/interfaces inherited from class Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

protected Integer

myID_ This entity ID in Integer object.

Fields inherited from class AbstractGIS

GIS_INQUIRY_RESOURCE_AR_LIST, GIS_INQUIRY_RESOURCE_AR_RESULT, GIS_INQUIRY_RESOURCE_LIST, GIS_INQUIRY_RESOURCE_RESULT, INQUIRY_GLOBAL_RESOURCE_AR_LIST, INQUIRY_GLOBAL_RESOURCE_LIST, INQUIRY_LOCAL_RESOURCE_AR_LIST, INQUIRY_LOCAL_RESOURCE_LIST, INQUIRY_REGIONAL_GIS, NOTIFY_GIS_RESOURCE_FAILURE, REGISTER_REGIONAL_GIS, REGISTER_RESOURCE, REGISTER_RESOURCE_AR, systemGIS_

Fields inherited from class GridSimCore

input, NETWORK_TYPE, output

Fields inherited from class Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

RegionalGIS(String name, Link link)
Creates a new regional GIS entity

Method Summary

protected boolean	getListFromOtherRegional(List regionalList, int eventTag) Get a list of IDs specified in the eventTag from other regional GIS
protected void	processEndSimulation() Informs the registered entities regarding to the end of a simulation. NOTE: This method can be overridden by its subclasses, provided that they call this method first.
protected void	processGISResourceARList(Sim_event ev) Process an incoming request from other GIS entities about getting a list of resource IDs supporting Advanced Reservation, that are registered to this regional GIS entity.
protected void	processGISResourceARResult(Sim_event ev) Process an incoming delivery from other GIS entities about their resource list supporting Advanced Reservation.
protected void	processGISResourceList(Sim_event ev) Process an incoming request from other GIS entities about getting a list of resource IDs, that are registered to this regional GIS entity.
protected void	processGISResourceResult(Sim_event ev) Process an incoming delivery from other GIS entities about their resource list.
protected void	processGlobalResourceARList(Sim_event ev) Process an incoming request about getting a list of resource IDs supporting Advanced Reservation that are registered in other regional GIS entities.
protected void	processGlobalResourceList(Sim_event ev) Process an incoming request from users about getting a list of resource IDs, that are registered in other regional GIS entities.
protected void	processInquiryRegionalGIS(Sim_event ev) Process an incoming request about getting a list of regional GIS IDs (including this entity ID), that are registered to the GridInformationService or system GIS.
protected void	processOtherEvent(Sim_event ev) Process an incoming request that uses a user-defined tag.
protected void	processRegisterResource(Sim_event ev) Process a registration request from a resource entity to this regional GIS entity.
protected void	processRegisterResourceAR(Sim_event ev) Process a registration request from a resource entity supporting Advanced Reservation to this regional GIS entity.
protected void	processResourceARList(Sim_event ev) Process an incoming request about getting a list of resource IDs supporting Advanced Reservation that are registered to this regional GIS entity.
protected void	processResourceList(Sim_event ev) Process an incoming request about getting a list of resource IDs that are registered to this regional GIS entity.
protected void	registerOtherEntity() Registers other information to GridInformationService or system GIS. NOTE: This method can be overridden by its subclasses, provided that they call this method first.
protected LinkedList	requestFromSystemGIS() Asks from GridInformationService or system GIS about a list of regional GIS entity ID.
protected boolean	requestFromSystemGIS(int eventTag, List list) Asks from GridInformationService or system GIS about a specific event or request.
protected boolean	sendListToSender(int senderID, int tag, List list) Sends a list to sender
protected boolean	storeRegistrationID(Sim_event ev, List list) Stores the incoming registration ID into the given list.

Methods inherited from class AbstractGIS

body, notifySystemGIS

Methods inherited from class GridSimCore

finalizeGridSimulation, getLink, getPingResult, isNetworked, ping, ping, ping, ping, pingBlockingCall, pingBlockingCall, pingBlockingCall, pingBlockingCall, send, send, send, send, send, send, setBackgroundTraffic, setBackgroundTraffic, terminateIOEntities

Methods inherited from class Sim_entity

add_generator, add_param, add_port, clone, get_id, get_name, get_port, get_port, get_stat, run, send_on, set_invisible, set_stat, sim_cancel, sim_completed, sim_current, sim_get_next, sim_get_next, sim_hold_for, sim_hold, sim_pause_for, sim_pause_for, sim_pause_until, sim_pause_until, sim_pause, sim_process_for, sim_process_for, sim_process_until, sim_process_until, sim_process, sim_putback, sim_schedule, sim_schedule, sim_schedule, sim_schedule, sim_schedule, sim_schedule, sim_select, sim_trace, sim_wait_for, sim_wait_for, sim_wait_for, sim_wait, sim_waiting, sim_waiting

Methods inherited from class Thread

activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class Object

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

Field Detail

myID_

protected Integer myID_

This entity ID in Integer object.

Constructor Detail

RegionalGIS

public RegionalGIS(String name,
                   Link link)
            throws Exception

Creates a new regional GIS entity

Parameters:

name - this regional GIS name

link - a network link to this entity

Throws:

Exception - This happens when creating this entity before initializing GridSim package or this entity name is null or empty

Pre Condition:

name != null, link != null

Post Condition:

$none

Method Detail

storeRegistrationID

protected boolean storeRegistrationID(Sim_event ev,
                                      List list)

Stores the incoming registration ID into the given list.
NOTE: ev.get_data() should contain an Integer object.

Parameters:

ev - a new Sim_event object or incoming registration request

list - a list storing the registration IDs

Returns:

true if successful, false otherwise

Pre Condition:

ev != null, list != null

Post Condition:

$none

processRegisterResourceAR

protected void processRegisterResourceAR(Sim_event ev)

Process a registration request from a resource entity supporting Advanced Reservation to this regional GIS entity.
NOTE: ev.get_data() should contain an Integer object representing the resource ID.

Specified by:

processRegisterResourceAR in class AbstractGIS

Parameters:

ev - a Sim_event object (or a registration request)

Pre Condition:

ev != null

Post Condition:

$none

processRegisterResource

protected void processRegisterResource(Sim_event ev)

Process a registration request from a resource entity to this regional GIS entity.
NOTE: ev.get_data() should contain an Integer object representing the resource ID.

Specified by:

processRegisterResource in class AbstractGIS

Parameters:

ev - a Sim_event object (or a registration request)

Pre Condition:

ev != null

Post Condition:

$none

processOtherEvent

protected void processOtherEvent(Sim_event ev)

Process an incoming request that uses a user-defined tag.
NOTE: This method can be overridden by its subclasses, provided that they call this method first. This is required, just in case this method is not empty.

Specified by:

processOtherEvent in class AbstractGIS

Parameters:

ev - a Sim_event object (or an incoming event or request)

Pre Condition:

ev != null

Post Condition:

$none

processGISResourceList

protected void processGISResourceList(Sim_event ev)

Process an incoming request from other GIS entities about getting a list of resource IDs, that are registered to this regional GIS entity.

Specified by:

processGISResourceList in class AbstractGIS

Parameters:

ev - a Sim_event object (or an incoming event or request)

Pre Condition:

ev != null

Post Condition:

$none

processGISResourceARList

protected void processGISResourceARList(Sim_event ev)

Process an incoming request from other GIS entities about getting a list of resource IDs supporting Advanced Reservation, that are registered to this regional GIS entity.

Specified by:

processGISResourceARList in class AbstractGIS

Parameters:

ev - a Sim_event object (or an incoming event or request)

Pre Condition:

ev != null

Post Condition:

$none

processGISResourceARResult

protected void processGISResourceARResult(Sim_event ev)

Process an incoming delivery from other GIS entities about their resource list supporting Advanced Reservation.
NOTE: ev.get_data() should contain List containing resource IDs (in Integer object).

Specified by:

processGISResourceARResult in class AbstractGIS

Parameters:

ev - a Sim_event object (or an incoming event or request)

Pre Condition:

ev != null

Post Condition:

$none

processGISResourceResult

protected void processGISResourceResult(Sim_event ev)

Process an incoming delivery from other GIS entities about their resource list.
NOTE: ev.get_data() should contain List containing resource IDs (in Integer object).

Specified by:

processGISResourceResult in class AbstractGIS

Parameters:

ev - a Sim_event object (or an incoming event or request)

Pre Condition:

ev != null

Post Condition:

$none

processInquiryRegionalGIS

protected void processInquiryRegionalGIS(Sim_event ev)

Process an incoming request about getting a list of regional GIS IDs (including this entity ID), that are registered to the GridInformationService or system GIS.

Specified by:

processInquiryRegionalGIS in class AbstractGIS

Parameters:

ev - a Sim_event object (or an incoming event or request)

Pre Condition:

ev != null

Post Condition:

$none

processGlobalResourceARList

protected void processGlobalResourceARList(Sim_event ev)

Process an incoming request about getting a list of resource IDs supporting Advanced Reservation that are registered in other regional GIS entities.

Specified by:

processGlobalResourceARList in class AbstractGIS

Parameters:

ev - a Sim_event object (or an incoming event or request)

Pre Condition:

ev != null

Post Condition:

$none

processGlobalResourceList

protected void processGlobalResourceList(Sim_event ev)

Process an incoming request from users about getting a list of resource IDs, that are registered in other regional GIS entities.

Specified by:

processGlobalResourceList in class AbstractGIS

Parameters:

ev - a Sim_event object (or an incoming event or request)

Pre Condition:

ev != null

Post Condition:

$none

getListFromOtherRegional

protected boolean getListFromOtherRegional(List regionalList,
                                           int eventTag)

Get a list of IDs specified in the eventTag from other regional GIS

Parameters:

regionalList - a list of regional GIS IDs

eventTag - an event tag or type of request

Returns:

true if successful, false otherwise

Pre Condition:

regionalList != null

Post Condition:

$none

requestFromSystemGIS

protected LinkedList requestFromSystemGIS()

Asks from GridInformationService or system GIS about a list of regional GIS entity ID.

Returns:

a list of regional GIS entity ID

Pre Condition:

$none

Post Condition:

$none

requestFromSystemGIS

protected boolean requestFromSystemGIS(int eventTag,
                                       List list)

Asks from GridInformationService or system GIS about a specific event or request.

Parameters:

eventTag - an event tag or type of request

list - a list storing the results

Returns:

true if successful, false otherwise

Pre Condition:

list != null

Post Condition:

$none

sendListToSender

protected boolean sendListToSender(int senderID,
                                   int tag,
                                   List list)

Sends a list to sender

Parameters:

senderID - the sender ID

tag - an event tag

list - a list to be sent to

Returns:

true if successful, false otherwise

Pre Condition:

senderID != -1

Post Condition:

$none

processResourceList

protected void processResourceList(Sim_event ev)

Process an incoming request about getting a list of resource IDs that are registered to this regional GIS entity.

Specified by:

processResourceList in class AbstractGIS

Parameters:

ev - a Sim_event object (or an incoming event or request)

Pre Condition:

ev != null

Post Condition:

$none

processResourceARList

protected void processResourceARList(Sim_event ev)

Process an incoming request about getting a list of resource IDs supporting Advanced Reservation that are registered to this regional GIS entity.

Specified by:

processResourceARList in class AbstractGIS

Parameters:

ev - a Sim_event object (or an incoming event or request)

Pre Condition:

ev != null

Post Condition:

$none

registerOtherEntity

protected void registerOtherEntity()

Registers other information to GridInformationService or system GIS.
NOTE: This method can be overridden by its subclasses, provided that they call this method first. This is required, just in case this method is not empty.

Specified by:

registerOtherEntity in class AbstractGIS

Pre Condition:

$none

Post Condition:

$none

processEndSimulation

protected void processEndSimulation()

Informs the registered entities regarding to the end of a simulation.
NOTE: This method can be overridden by its subclasses, provided that they call this method first. This is required, just in case this method is not empty.

Specified by:

processEndSimulation in class AbstractGIS

Pre Condition:

$none

Post Condition:

$none