gov.bnl.star.offline.scheduler
Class Site

java.lang.Object
  gov.bnl.star.offline.scheduler.Site

public class Site
extends java.lang.Object

This class defines a site used in the config. It holds a cluster list and gateway list as well as other site specific objects.

Author:

Levente Hajdu

Constructor Summary

Site()
Creates a new instance of site

Method Summary

void	addAccessPoint(LocalAccessPoint accessPoint) This function should be called from the config file, it adds an access object (GateKeeperAccess, LocalAccess) to a access list.
void	AddBatchSystem(BatchSystem batchSystem) Adds a batch system object to the site.
void	AddFileTransferGatekeeper(GateKeeperAccessPoint gateKeeper) Adds a file Transfer gatekeepers object to the site.
void	addGateKeeperAccess(GateKeeperAccessPoint gateKeeperAccessPoint) Used to add a gatekeeper to this site, to which jobs can be submitted Note: This function is called from the config file.
void	addLocalAccess(LocalAccessPoint localAccess) Used to add a local access point to this site, from which jobs can be submitted Note: This function is called from the config file.
java.util.List	getAccessPointsList() Returns a list (ArrayList) of access object available from the site.
java.util.List	getBatchSystems() Returns the List of batch systems for this site.
java.lang.String	getCanonicalName() Returns the domain name of the site.
Policy	getDefaultPolic()
GateKeeperAccessPoint	getFileTransferGatekeeper() Returns a gatekeeper object form this site that can be used for file transfers
java.util.List	getFileTransferGatekeepes() Returns the List of gatekeepers for this site.
java.util.List	getGateKeeperAccess() This function returns a list of gatekeeper object, that a can be used to access this site.
java.util.List	getGateKeeperAccessPointList() Returns a list (ArrayList) of only the GateKeeperAccess objects on the access list.
InformationService	getInformationService()
java.util.List	getLocalAccess() This function returns a list of local access objects, that a can be used to access this site.
java.util.List	getLocalAccessPointsList() Returns a list (ArrayList) of only the LocalAccess objects on the access list.
java.util.Map	getLogConf() This function is used by the system to recover parameters needed for logging in the format of a hastable.
java.util.Map	getProgramLocations()
Proxy	getProxy()
java.lang.String	getSiteName() Returns the domain name of the site.
java.util.Map	getStatisticsConf() This function is used by the system to recover parameters needed for statistics collection into a MySQL database.
void	setAccessPointsList(java.util.List accessList) This function replaces the list of access objects.
void	setBatchSystems(java.util.List batchSystems) Sets the List of batch systems for this site.
void	setCanonicalName(java.lang.String canonicalName) Sets the domain name of the site.
void	setDefaultPolicy(Policy defaultPolicy)
void	setFileTransferGatekeepes(java.util.List fileTransferGatekeepers) Sets the List of gatekeepers for this site.
void	setGateKeeperAccess(java.util.List gatekeeperAccess) This function sets the pointer to the list of gatekeeper objects accessible through this site.
void	setInformationService(InformationService informationService) This is just temporary until such time as it can be moved to the batch system level in the new format.
void	setLocalAccess(java.util.List localAccess) This function sets the pointer to the localAccess object accessible through this site, for submitting jobs.
void	setLogConf(java.util.Map logConf) Set the hashtable with the parameters needed for logging.
void	setProgramLocations(java.util.Map programLocations)
void	setProxy(Proxy proxy) Sets the proxy fo rthe information service .
void	setSiteName(java.lang.String siteName) Sets the domain name of the site.
void	setStatisticsConf(java.util.Map statisticsConf) Set the hashtable with the parameters needed for statistics collection into a MySQL database.

Methods inherited from class java.lang.Object

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

Constructor Detail

Site

public Site()

Creates a new instance of site

Method Detail

getSiteName

public java.lang.String getSiteName()

Returns the domain name of the site. Examples: nersc.gov, rcf.bnl.gov

setSiteName

public void setSiteName(java.lang.String siteName)

Sets the domain name of the site. Examples: nersc.gov, rcf.bnl.gov

getCanonicalName

public java.lang.String getCanonicalName()

Returns the domain name of the site. Examples: nersc.gov, rcf.bnl.gov

setCanonicalName

public void setCanonicalName(java.lang.String canonicalName)

Sets the domain name of the site. Examples: nersc.gov, rcf.bnl.gov

AddBatchSystem

public void AddBatchSystem(BatchSystem batchSystem)

Adds a batch system object to the site. This function is used primarily for configuration in the config file. Note that this function can be called multiple time for add multiple objects.

getBatchSystems

public java.util.List getBatchSystems()

Returns the List of batch systems for this site. Only intended for use by serializer.

setBatchSystems

public void setBatchSystems(java.util.List batchSystems)

Sets the List of batch systems for this site. Only intended for use by serializer.

setAccessPointsList

public void setAccessPointsList(java.util.List accessList)

This function replaces the list of access objects. Note:This function is -only- used by the framework and should not be called as it will reset the access list set by the config file

getAccessPointsList

public java.util.List getAccessPointsList()

Returns a list (ArrayList) of access object available from the site.

addAccessPoint

public void addAccessPoint(LocalAccessPoint accessPoint)

This function should be called from the config file, it adds an access object (GateKeeperAccess, LocalAccess) to a access list.

getGateKeeperAccessPointList

public java.util.List getGateKeeperAccessPointList()

Returns a list (ArrayList) of only the GateKeeperAccess objects on the access list.

getLocalAccessPointsList

public java.util.List getLocalAccessPointsList()

Returns a list (ArrayList) of only the LocalAccess objects on the access list.

addGateKeeperAccess

public void addGateKeeperAccess(GateKeeperAccessPoint gateKeeperAccessPoint)

Used to add a gatekeeper to this site, to which jobs can be submitted Note: This function is called from the config file.

setGateKeeperAccess

public void setGateKeeperAccess(java.util.List gatekeeperAccess)

This function sets the pointer to the list of gatekeeper objects accessible through this site. Note: This function is used only by the frame work and should not be called, becuase it will clear all gatekeeps already setup by the config file.

getGateKeeperAccess

public java.util.List getGateKeeperAccess()

This function returns a list of gatekeeper object, that a can be used to access this site.

addLocalAccess

public void addLocalAccess(LocalAccessPoint localAccess)

Used to add a local access point to this site, from which jobs can be submitted Note: This function is called from the config file.

setLocalAccess

public void setLocalAccess(java.util.List localAccess)

This function sets the pointer to the localAccess object accessible through this site, for submitting jobs. Note: This function is used only by the frame work and should not be called, becuase it will clear all access objects already setup by the config file.

getLocalAccess

public java.util.List getLocalAccess()

This function returns a list of local access objects, that a can be used to access this site.

AddFileTransferGatekeeper

public void AddFileTransferGatekeeper(GateKeeperAccessPoint gateKeeper)

Adds a file Transfer gatekeepers object to the site. This function is used primarily for configuration in the config file. Note that this function can be called multiple time for add multiple objects.

getFileTransferGatekeepes

public java.util.List getFileTransferGatekeepes()

Returns the List of gatekeepers for this site. Only intended for use by serializer.

setFileTransferGatekeepes

public void setFileTransferGatekeepes(java.util.List fileTransferGatekeepers)

Sets the List of gatekeepers for this site. This is intended be used in the config file

getFileTransferGatekeeper

public GateKeeperAccessPoint getFileTransferGatekeeper()

Returns a gatekeeper object form this site that can be used for file transfers

setLogConf

public void setLogConf(java.util.Map logConf)

Set the hashtable with the parameters needed for logging. The keys that need to be set inside this hashtable are "directory" and "level".

getLogConf

public java.util.Map getLogConf()

This function is used by the system to recover parameters needed for logging in the format of a hastable.

setStatisticsConf

public void setStatisticsConf(java.util.Map statisticsConf)

Set the hashtable with the parameters needed for statistics collection into a MySQL database. The keys that need to be set inside this hashtable are password, username, URL (exmaple: jdbc:mysql://duvall.star.bnl.gov/Scheduler_bnl).

getStatisticsConf

public java.util.Map getStatisticsConf()

This function is used by the system to recover parameters needed for statistics collection into a MySQL database.

setProgramLocations

public void setProgramLocations(java.util.Map programLocations)

getProgramLocations

public java.util.Map getProgramLocations()

setDefaultPolicy

public void setDefaultPolicy(Policy defaultPolicy)

getDefaultPolic

public Policy getDefaultPolic()

setInformationService

public void setInformationService(InformationService informationService)

This is just temporary until such time as it can be moved to the batch system level in the new format.

getInformationService

public InformationService getInformationService()

setProxy

public void setProxy(Proxy proxy)

Sets the proxy fo rthe information service . This proxy me be used by other elements in it global to the JVM

getProxy

public Proxy getProxy()