Java Doc for PoolInfoProvider.java in  » Workflow-Engines » pegasus-2.1.0 » org » griphyn » cPlanner » poolinfo » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Workflow Engines » pegasus 2.1.0 » org.griphyn.cPlanner.poolinfo 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.griphyn.cPlanner.poolinfo.PoolInfoProvider

All known Subclasses:   org.griphyn.cPlanner.poolinfo.Abstract,
PoolInfoProvider
abstract public class PoolInfoProvider (Code)
This is an abstract class which defines the interface for the information providers like sites.xml, sites.catalog.
author:
   Karan Vahi
author:
   Gaurang Mehta
version:
   $Revision: 279 $


Field Summary
final public static  StringPEGASUS_HOME
     The name of the environment variable PEGASUS_HOME.
final public static  StringVDS_HOME
     The name of the environment variable VDS_HOME.
protected  booleanmDeepStorageStructure
     A boolean indicating whether to have a deep directory structure for the storage directory or not.
protected  StringmLogMsg
     The String holding the log message.
protected  LogManagermLogger
     The LogManager object which is used to log all the messages.
protected  StringmPoolProvider
     The path to the pool information provider.
protected  PegasusPropertiesmProps
     The object holding all the properties pertaining to Pegasus.
protected  StringmStorageDir
     This contains the storage directory relative to the se mount point of the pool.
protected  UserOptionsmUserOpts
     Handle to the Singleton instance containing the options passed to the planner at run time.
protected  StringmWorkDir
     The working directory relative to the mount point of the execution pool.


Method Summary
public  StringgetEnvironmentVariable(String siteID, String envVariable)
     Returns an environment variable for a particular site set in the Site Catalog.
Parameters:
  siteID - the name of the site.
Parameters:
  envVariable - the environment variable whose value is required.
public  StringgetExecPoolWorkDir(String executionPool)
     This determines the working directory on remote execution pool on the basis of whether an absolute path is specified in the pegasus.dir.exec directory or a relative path.
Parameters:
  executionPool - the pool where a job has to be executed.
public  StringgetExecPoolWorkDir(SubInfo job)
     This determines the working directory on remote execution pool for a particular job.
public  StringgetExecPoolWorkDir(String siteID, String path)
     This determines the working directory on remote execution pool on the basis of whether an absolute path is specified in the pegasus.dir.exec directory or a relative path.
Parameters:
  siteID - the name of the site where a job has to be executed.
Parameters:
  path - the relative path that needs to be appended to theworkdir from the execution pool.
public  StringgetExecPoolWorkDir(String siteID, String path, int jobClass)
     This determines the working directory on remote execution pool on the basis of whether an absolute path is specified in the pegasus.dir.exec directory or a relative path.
abstract public  ListgetGridFTPServers(String siteID)
     It returns all the gridftp servers corresponding to a specified pool.
Parameters:
  siteID - the name of the site at which the jobmanager runs.
abstract public  ListgetJobmanagers(String siteID)
     It returns all the jobmanagers corresponding to a specified site.
Parameters:
  siteID - the name of the site at which the jobmanager runs.
abstract public  ListgetJobmanagers(String siteID, String universe)
     It returns all the jobmanagers corresponding to a specified pool and universe.
Parameters:
  siteID - the name of the site at which the jobmanager runs.
Parameters:
  universe - the gvds universe with which it is associated.
public  StringgetPegasusHome(String siteID)
     Returns the value of PEGASUS_HOME for a site.
Parameters:
  siteID - the name of the site.
abstract public  SiteInfogetPoolEntry(String siteID, String universe)
     Gets the pool information from the pool.config file on the basis of the name of the pool, and the universe.
abstract public  StringgetPoolMode()
     Returns a textual description of the pool mode being used.
abstract public  ListgetPoolProfile(String siteID)
     It returns the profile information associated with a particular pool.
public  ListgetPoolProfile(String siteID, String namespace)
     It returns profile information associated with a particular namespace and pool.
Parameters:
  siteID - the name of the site, whose profile information you want.
Parameters:
  namespace - the namespace correspoinding to which the profileinformation of a particular site is desired.
abstract public  ListgetPools()
    
public  StringgetSeMountPoint(SiteInfo site)
     Return the storage mount point for a particular pool.
Parameters:
  site - SiteInfo object of the site for which you want thestorage-mount-point.
abstract public  SysInfogetSysinfo(String siteID)
     Returns the System information for a single site.
abstract public  MapgetSysinfos(List siteids)
     Returns the System information for a bunch of sites.
public  SiteInfogetTXPoolEntry(String poolName)
     Gets the pool object to be used for the transfer universe.
public  StringgetURLPrefix(String poolName)
     Returns the url prefix of a gridftp server on the pool. gsiftp://dataserver.phys.uwm.edu/~/griphyn_test/ligodemo_output/ gives a URL prefix of gsiftp://dataserver.phys.uwm.edu
Parameters:
  poolName - the name of the pool.
public  StringgetVDS_HOME(String siteID)
     Returns the value of VDS_HOME for a site.
Parameters:
  siteID - the name of the site.
public  voidloadNonSingletonObjects(String propFileName)
     It loads the objects using their non singleton implementations.
protected  voidloadSingletonObjects()
     It loads the objects that the pool providers need in a singleton manner, wherever possible.
protected  voidlogMessage(String msg)
     Logs the message to a logging stream.
public static  PoolInfoProvidernonSingletonInstance(String poolProvider, String propFileName)
     The method that returns a Non Singleton instance of the dervived InfoProvider class.
abstract public  booleanremoveGridFtp(String siteID, String urlPrefix)
     This is a soft state remove, that removes a gridftp server from a particular pool entry.
abstract public  booleanremoveJobManager(String siteID, String universe, String jobManagerContact)
     This is a soft state remove, that removes a jobmanager from a particular pool entry.
public  GridFTPServerselectGridFtp(ArrayList ftp)
     Return a random gridftp url from the list of gridftp url's.
Parameters:
  ftp - Takes an ArrayList of GridFTPServer Objects.
public  StringselectLRC(ArrayList lrcs)
     Return a random lrc url from the list of lrc url's.
Parameters:
  lrcs - Arraylist of LRC objects.
public  StringselectWorkdir(WorkDir workdir)
     Returns the path to the execution mount point (The Workdir).
Parameters:
  workdir - the WorkDir object containing the workdirinformation.
public static  PoolInfoProvidersingletonInstance(String poolProvider)
     The method which returns a Singleton instance of the derived InfoProvider class.

Field Detail
PEGASUS_HOME
final public static String PEGASUS_HOME(Code)
The name of the environment variable PEGASUS_HOME.



VDS_HOME
final public static String VDS_HOME(Code)
The name of the environment variable VDS_HOME.



mDeepStorageStructure
protected boolean mDeepStorageStructure(Code)
A boolean indicating whether to have a deep directory structure for the storage directory or not.



mLogMsg
protected String mLogMsg(Code)
The String holding the log message.



mLogger
protected LogManager mLogger(Code)
The LogManager object which is used to log all the messages. It's values are set in the CPlanner class.



mPoolProvider
protected String mPoolProvider(Code)
The path to the pool information provider.



mProps
protected PegasusProperties mProps(Code)
The object holding all the properties pertaining to Pegasus.



mStorageDir
protected String mStorageDir(Code)
This contains the storage directory relative to the se mount point of the pool. It is populated from the pegasus.dir.storage property from the properties file. If not specified then the storage directory is the se mount point from the pool.config file.



mUserOpts
protected UserOptions mUserOpts(Code)
Handle to the Singleton instance containing the options passed to the planner at run time.



mWorkDir
protected String mWorkDir(Code)
The working directory relative to the mount point of the execution pool. It is populated from the pegasus.dir.exec property from the properties file. If not specified then it work_dir is supposed to be the exec mount point of the execution pool.





Method Detail
getEnvironmentVariable
public String getEnvironmentVariable(String siteID, String envVariable)(Code)
Returns an environment variable for a particular site set in the Site Catalog.
Parameters:
  siteID - the name of the site.
Parameters:
  envVariable - the environment variable whose value is required. value of the environment variable if found, else null



getExecPoolWorkDir
public String getExecPoolWorkDir(String executionPool)(Code)
This determines the working directory on remote execution pool on the basis of whether an absolute path is specified in the pegasus.dir.exec directory or a relative path.
Parameters:
  executionPool - the pool where a job has to be executed. the path to the pool work dir.
throws:
  RuntimeException - in case of site not found in the site catalog.



getExecPoolWorkDir
public String getExecPoolWorkDir(SubInfo job)(Code)
This determines the working directory on remote execution pool for a particular job. The job should have it's execution pool set.
Parameters:
  job - SubInfo object for the job. the path to the pool work dir.
throws:
  RuntimeException - in case of site not found in the site catalog.



getExecPoolWorkDir
public String getExecPoolWorkDir(String siteID, String path)(Code)
This determines the working directory on remote execution pool on the basis of whether an absolute path is specified in the pegasus.dir.exec directory or a relative path.
Parameters:
  siteID - the name of the site where a job has to be executed.
Parameters:
  path - the relative path that needs to be appended to theworkdir from the execution pool. the path to the pool work dir.
throws:
  RuntimeException - in case of site not found in the site catalog.



getExecPoolWorkDir
public String getExecPoolWorkDir(String siteID, String path, int jobClass)(Code)
This determines the working directory on remote execution pool on the basis of whether an absolute path is specified in the pegasus.dir.exec directory or a relative path. If the job class happens to be a create directory job it does not append the name of the random directory since the job is trying to create that random directory.
Parameters:
  siteID - the name of the site where the job has to be executed.
Parameters:
  path - the relative path that needs to be appended to theworkdir from the execution pool.
Parameters:
  jobClass - the class of the job. the path to the pool work dir.
throws:
  RuntimeException - in case of site not found in the site catalog.



getGridFTPServers
abstract public List getGridFTPServers(String siteID)(Code)
It returns all the gridftp servers corresponding to a specified pool.
Parameters:
  siteID - the name of the site at which the jobmanager runs. List of GridFTPServer, each referring to oneGridFtp Server.



getJobmanagers
abstract public List getJobmanagers(String siteID)(Code)
It returns all the jobmanagers corresponding to a specified site.
Parameters:
  siteID - the name of the site at which the jobmanager runs. list of JobManager, each referring toone jobmanager contact string. An empty list if no jobmanagersfound.



getJobmanagers
abstract public List getJobmanagers(String siteID, String universe)(Code)
It returns all the jobmanagers corresponding to a specified pool and universe.
Parameters:
  siteID - the name of the site at which the jobmanager runs.
Parameters:
  universe - the gvds universe with which it is associated. list of JobManager, each referring toone jobmanager contact string. An empty list if no jobmanagersfound.



getPegasusHome
public String getPegasusHome(String siteID)(Code)
Returns the value of PEGASUS_HOME for a site.
Parameters:
  siteID - the name of the site. value if set else null.



getPoolEntry
abstract public SiteInfo getPoolEntry(String siteID, String universe)(Code)
Gets the pool information from the pool.config file on the basis of the name of the pool, and the universe.
Parameters:
  siteID - the name of the site
Parameters:
  universe - the execution universe for the job the corresponding pool object for the entry if foundelse null



getPoolMode
abstract public String getPoolMode()(Code)
Returns a textual description of the pool mode being used. String



getPoolProfile
abstract public List getPoolProfile(String siteID)(Code)
It returns the profile information associated with a particular pool. If the pool provider has no such information it should return null. The name of the object may purport that it is specific to GVDS format, but in fact it a tuple consisting of namespace, key and value that can be used by other Pool providers too.
Parameters:
  siteID - the name of the site, whose profile information you want. List of Profile objectsnull if the information about the site is not with the pool provider.
See Also:   org.griphyn.cPlanner.classes.Profile



getPoolProfile
public List getPoolProfile(String siteID, String namespace)(Code)
It returns profile information associated with a particular namespace and pool.
Parameters:
  siteID - the name of the site, whose profile information you want.
Parameters:
  namespace - the namespace correspoinding to which the profileinformation of a particular site is desired. List of Profile objectsNULL when the information about the site is not there or noprofile information associated with the site.
See Also:   org.griphyn.cPlanner.classes.Profile



getPools
abstract public List getPools()(Code)
It returns all the pools available in the site catalog List of names of the pools available as String



getSeMountPoint
public String getSeMountPoint(SiteInfo site)(Code)
Return the storage mount point for a particular pool.
Parameters:
  site - SiteInfo object of the site for which you want thestorage-mount-point. String corresponding to the mount point if the pool is found.null if pool entry is not found.



getSysinfo
abstract public SysInfo getSysinfo(String siteID)(Code)
Returns the System information for a single site.
Parameters:
  siteID - String The site whose system information is requested SysInfo The system information as a SysInfo object
See Also:   org.griphyn.common.classes.SysInfo



getSysinfos
abstract public Map getSysinfos(List siteids)(Code)
Returns the System information for a bunch of sites.
Parameters:
  siteids - List The siteid whose system information is required Map The key is the siteid and the value is a SysInfo object
See Also:   org.griphyn.common.classes.SysInfo



getTXPoolEntry
public SiteInfo getTXPoolEntry(String poolName)(Code)
Gets the pool object to be used for the transfer universe. If we do not get that then defaults back to globus universe for the same pool.
Parameters:
  poolName - the name of the pool Pool



getURLPrefix
public String getURLPrefix(String poolName)(Code)
Returns the url prefix of a gridftp server on the pool. gsiftp://dataserver.phys.uwm.edu/~/griphyn_test/ligodemo_output/ gives a URL prefix of gsiftp://dataserver.phys.uwm.edu
Parameters:
  poolName - the name of the pool. String corresponding to the url prefix if the pool is found.null if pool entry is not found.



getVDS_HOME
public String getVDS_HOME(String siteID)(Code)
Returns the value of VDS_HOME for a site.
Parameters:
  siteID - the name of the site. value if set else null.



loadNonSingletonObjects
public void loadNonSingletonObjects(String propFileName)(Code)
It loads the objects using their non singleton implementations.
Parameters:
  propFileName - the name of the properties file that needs to bepicked up from PEGASUS_HOME/etc directory.If it is null,then the default properties file should be picked up.



loadSingletonObjects
protected void loadSingletonObjects()(Code)
It loads the objects that the pool providers need in a singleton manner, wherever possible. If the class in not implemented in Singleton manner, the objects would be loaded normally.



logMessage
protected void logMessage(String msg)(Code)
Logs the message to a logging stream. Currently does not log to any stream.
Parameters:
  msg - the message to be logged.



nonSingletonInstance
public static PoolInfoProvider nonSingletonInstance(String poolProvider, String propFileName)(Code)
The method that returns a Non Singleton instance of the dervived InfoProvider class. This method if invoked should also ensure that all other internal Pegasus objectslike PegasusProperties are invoked in a non singleton manner. It must be overriden, by implementing classes.
Parameters:
  poolProvider - the path to the file containing the pool information.
Parameters:
  propFileName - the name of the properties file that needs to bepicked up from PEGASUS_HOME/etc directory.If it is null,then the default file should be picked up. PoolInfoProvider



removeGridFtp
abstract public boolean removeGridFtp(String siteID, String urlPrefix)(Code)
This is a soft state remove, that removes a gridftp server from a particular pool entry. The cause of this removal could be the inability to authenticate against it at runtime. The successful removal lead Pegasus not to schedule any transfers on that particular gridftp server.
Parameters:
  siteID - the name of the site at which the gridftp runs.
Parameters:
  urlPrefix - the url prefix containing the protocol,hostname and port. true if was able to remove the gridftp from the cachefalse if unable to remove, or the matching entry is not foundor if the implementing class does not maintain a soft state.or the information about site is not in the site catalog.



removeJobManager
abstract public boolean removeJobManager(String siteID, String universe, String jobManagerContact)(Code)
This is a soft state remove, that removes a jobmanager from a particular pool entry. The cause of this removal could be the inability to authenticate against it at runtime. The successful removal lead Pegasus not to schedule job on that particular jobmanager.
Parameters:
  siteID - the name of the site at which the jobmanager runs.
Parameters:
  universe - the gvds universe with which it is associated.
Parameters:
  jobManagerContact - the contact string to the jobmanager. true if was able to remove the jobmanager from the cachefalse if unable to remove, or the matching entry is not foundor if the implementing class does not maintain a soft state.



selectGridFtp
public GridFTPServer selectGridFtp(ArrayList ftp)(Code)
Return a random gridftp url from the list of gridftp url's.
Parameters:
  ftp - Takes an ArrayList of GridFTPServer Objects. String Returns a single gridftp url from among many
See Also:   org.griphyn.cPlanner.classes.GridFTPServer



selectLRC
public String selectLRC(ArrayList lrcs)(Code)
Return a random lrc url from the list of lrc url's.
Parameters:
  lrcs - Arraylist of LRC objects. String Returns one of lrc url's
See Also:   org.griphyn.cPlanner.classes.LRC



selectWorkdir
public String selectWorkdir(WorkDir workdir) throws Exception(Code)
Returns the path to the execution mount point (The Workdir).
Parameters:
  workdir - the WorkDir object containing the workdirinformation. String The exec-mount point (aka workdir)
throws:
  Exception -



singletonInstance
public static PoolInfoProvider singletonInstance(String poolProvider)(Code)
The method which returns a Singleton instance of the derived InfoProvider class. It must be overriden, by implementing classes.
Parameters:
  poolProvider - the url to site catalog source. Can be a URL. PoolInfoProvider



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.