sfi.director.util.Setup Class Reference

List of all members.

Detailed Description

The Setup class' task is to determine various configuration things on startup, set up database connections, init drivers / executors / invokers, etc.


Static Public Member Functions

static void shutdown ()
 Try to do some cleanup before system shutdown.
static void setup_base ()
 Setup some basic things .
static DBConnection set_db (String prop, String defloc, boolean fatal, String defaulturl)
 Setup one database.
static DBConnection set_db (String prop, String defloc, boolean fatal)
static DBConnection set_db (String prop, String defloc, boolean fatal, Credentials creds)
static DBConnection set_db (String prop, String defloc, boolean fatal, Credentials creds, String defaulturl)
static void setup_objectregistry ()
static void setup_objeventdb ()
static void setup ()
 The main setup() routine used by most of the interactive director classes.
static void setup_localagent ()
 The setup method used when running in agent mode.
static void setup_agent ()
 The setup method used when running in agent mode.
static void setup_setpasswd ()
 The setup method used by the user password utility.
static void setup_cli ()
 The setup method used by CLI commands.
static void setup_frinterface ()
 The frontend interface setup() routine.

Static Public Attributes

static final MyProperties defaultSettings
 default settings
static DBConnection lockdb = null
 The lock database.
static DBConnection localLockdb = null
 The database used for locks local to the system we are running on.
static DBConnection jobqueuedb = null
 The job queue database.
static DBConnection cmdqueuedb = null
 The command queue database.
static DBConnection reqqueuedb = null
 The request queue database.
static DBConnection jobarchivedb = null
 The job archive database.
static DBConnection hostsdb = null
 The database where host information is stored.
static DBConnection peopledb = null
 The database where people information is stored.
static DBConnection authdb = null
 The database used for authentication purposes.
static DBConnection classesdb = null
 The database where host/person class information is stored.
static DBConnection appsdb = null
 The database where application information is stored.
static DBConnection servicesdb = null
 The database where service information is stored.
static DBConnection dsrulesdb = null
 The database where domain service rule information is stored.
static DBConnection nulldb = null
 The null database.
static DBConnection docsdb = null
 The database where documentation is stored.
static DBConnection settingsdb = null
 The database where internal settings are stored.
static DBConnection schemadb = null
 The database where object schemata are stored.
static DBConnection memorydb = null
 The RAM database.
static DBConnection objregistrydb = null
 The database where object registry information is stored.
static DBConnection objeventdb = null
 The database where object event information is stored.
static DBConnection topdb = null
 The database where the database root is.
static DirectoryAccess hostsdir = null
 The directory for host information access.
static DirectoryAccess peopledir = null
 The directory for people information access.
static DirectoryAccess classesdir = null
 The directory for host/person class information access.
static Scheduler scheduler = null
 Our current scheduler.
static MyProperties properties = null
 Our 'raw' configuration as found in the director.conf file.
static File active_properties = null
 The director.conf file we are currently using.
static String hostname
 The principal name of the host we are running on.
static Vector hostnames = new Vector()
 A complete list of names of the host we are running on.
static String masterhost
 The name of our admin server.
static String tmphost
 The name of the host storing site-wide temporary files.
static String tmpstorage = null
 The directory on tmphost where site-wide temporary files are stored.
static String programid
 A (hopefully) unique ID identifying our program.
static String programname = "sfidirector"
 Our program's name.
static String program_cmdline = ""
 Our program's command line.
static Vector localjobqueue = new Vector()
 Here jobs are stored when they are stored locally.
static String fileSeparator
 The separator between fragments of a file's path.
static String pathSeparator = ":"
 The separator between multiple file names in a list.
static String rootDir
 The directory where the director is installed.
static String imageDir
 The directory where images (icons, etc.
static String rcdir
 The path of the personal (user specific) director configuration files can be found.
static String agentcommand
 The system command we use for starting up a director agent.
static Logger logger
 The default Logger.
static boolean interactive = false
 This is true if we are running in interactive mode (thus if we are run by a user and are able to interact with him/her).
static boolean isagent = false
 This is true if we are running in agent mode.
static String configFile = null
 This is set by whatever CLI command is the entry point for the director if the name of the config file is supplied via a command line argument.
static String configDomain = null
 Domain name.


Member Function Documentation

static DBConnection sfi.director.util.Setup.set_db String  prop,
String  defloc,
boolean  fatal,
Credentials  creds,
String  defaulturl
[static]
 

static DBConnection sfi.director.util.Setup.set_db String  prop,
String  defloc,
boolean  fatal,
Credentials  creds
[static]
 

static DBConnection sfi.director.util.Setup.set_db String  prop,
String  defloc,
boolean  fatal
[static]
 

static DBConnection sfi.director.util.Setup.set_db String  prop,
String  defloc,
boolean  fatal,
String  defaulturl
[static]
 

Setup one database.

static void sfi.director.util.Setup.setup  )  [static]
 

The main setup() routine used by most of the interactive director classes.

static void sfi.director.util.Setup.setup_agent  )  [static]
 

The setup method used when running in agent mode.

static void sfi.director.util.Setup.setup_base  )  [static]
 

Setup some basic things .

.. this method is invoked by any other setup_* method

static void sfi.director.util.Setup.setup_cli  )  [static]
 

The setup method used by CLI commands.

static void sfi.director.util.Setup.setup_frinterface  )  [static]
 

The frontend interface setup() routine.

static void sfi.director.util.Setup.setup_localagent  )  [static]
 

The setup method used when running in agent mode.

static void sfi.director.util.Setup.setup_objectregistry  )  [static]
 

static void sfi.director.util.Setup.setup_objeventdb  )  [static]
 

static void sfi.director.util.Setup.setup_setpasswd  )  [static]
 

The setup method used by the user password utility.

static void sfi.director.util.Setup.shutdown  )  [static]
 

Try to do some cleanup before system shutdown.

Release locks, force garbage collection, run finalization.


Member Data Documentation

File sfi.director.util.Setup.active_properties = null [static]
 

The director.conf file we are currently using.

String sfi.director.util.Setup.agentcommand [static]
 

The system command we use for starting up a director agent.

DBConnection sfi.director.util.Setup.appsdb = null [static]
 

The database where application information is stored.

DBConnection sfi.director.util.Setup.authdb = null [static]
 

The database used for authentication purposes.

DBConnection sfi.director.util.Setup.classesdb = null [static]
 

The database where host/person class information is stored.

DirectoryAccess sfi.director.util.Setup.classesdir = null [static]
 

The directory for host/person class information access.

DBConnection sfi.director.util.Setup.cmdqueuedb = null [static]
 

The command queue database.

String sfi.director.util.Setup.configDomain = null [static]
 

Domain name.

String sfi.director.util.Setup.configFile = null [static]
 

This is set by whatever CLI command is the entry point for the director if the name of the config file is supplied via a command line argument.

final MyProperties sfi.director.util.Setup.defaultSettings [static]
 

Initial value:

 new MyProperties( new String[] {
    "AdminServerPort: 10371",
    "Syslog.facility: daemon",
    "Scheduler: ParallelScheduler",
    "QueueCycle: 30",
    "ArchiveCycle: 600",
    "ArchiveMoveTime: 3600",
    "ArchivePurgeCycle: 86400",
    "ArchivePurgeTime: 604800",
    "TmpStorage: " + ((System.getProperties().getProperty( "java.io.tmpdir" ) != null)?
        System.getProperties().getProperty( "java.io.tmpdir" ) : "/tmp"),
    "PPDModelDir: /usr/share/cups/model",
    "TrustfulAgent: yes"
} )
default settings

DBConnection sfi.director.util.Setup.docsdb = null [static]
 

The database where documentation is stored.

DBConnection sfi.director.util.Setup.dsrulesdb = null [static]
 

The database where domain service rule information is stored.

String sfi.director.util.Setup.fileSeparator [static]
 

The separator between fragments of a file's path.

This is usually the same as the file.separator system property.

String sfi.director.util.Setup.hostname [static]
 

The principal name of the host we are running on.

Vector sfi.director.util.Setup.hostnames = new Vector() [static]
 

A complete list of names of the host we are running on.

DBConnection sfi.director.util.Setup.hostsdb = null [static]
 

The database where host information is stored.

DirectoryAccess sfi.director.util.Setup.hostsdir = null [static]
 

The directory for host information access.

String sfi.director.util.Setup.imageDir [static]
 

The directory where images (icons, etc.

) are located

boolean sfi.director.util.Setup.interactive = false [static]
 

This is true if we are running in interactive mode (thus if we are run by a user and are able to interact with him/her).

boolean sfi.director.util.Setup.isagent = false [static]
 

This is true if we are running in agent mode.

DBConnection sfi.director.util.Setup.jobarchivedb = null [static]
 

The job archive database.

DBConnection sfi.director.util.Setup.jobqueuedb = null [static]
 

The job queue database.

Vector sfi.director.util.Setup.localjobqueue = new Vector() [static]
 

Here jobs are stored when they are stored locally.

Usually this vector contains jobs before they are pushed into the job queue database or executed locally.

See also:
Tools.executeLocalqueue()

DBConnection sfi.director.util.Setup.localLockdb = null [static]
 

The database used for locks local to the system we are running on.

DBConnection sfi.director.util.Setup.lockdb = null [static]
 

The lock database.

Logger sfi.director.util.Setup.logger [static]
 

The default Logger.

String sfi.director.util.Setup.masterhost [static]
 

The name of our admin server.

DBConnection sfi.director.util.Setup.memorydb = null [static]
 

The RAM database.

DBConnection sfi.director.util.Setup.nulldb = null [static]
 

The null database.

DBConnection sfi.director.util.Setup.objeventdb = null [static]
 

The database where object event information is stored.

DBConnection sfi.director.util.Setup.objregistrydb = null [static]
 

The database where object registry information is stored.

String sfi.director.util.Setup.pathSeparator = ":" [static]
 

The separator between multiple file names in a list.

DBConnection sfi.director.util.Setup.peopledb = null [static]
 

The database where people information is stored.

DirectoryAccess sfi.director.util.Setup.peopledir = null [static]
 

The directory for people information access.

String sfi.director.util.Setup.program_cmdline = "" [static]
 

Our program's command line.

This should be set by CLI classes.

String sfi.director.util.Setup.programid [static]
 

A (hopefully) unique ID identifying our program.

String sfi.director.util.Setup.programname = "sfidirector" [static]
 

Our program's name.

This should be set by CLI classes.

MyProperties sfi.director.util.Setup.properties = null [static]
 

Our 'raw' configuration as found in the director.conf file.

String sfi.director.util.Setup.rcdir [static]
 

The path of the personal (user specific) director configuration files can be found.

This is usually the ".director" subdirectory of the home directory

DBConnection sfi.director.util.Setup.reqqueuedb = null [static]
 

The request queue database.

String sfi.director.util.Setup.rootDir [static]
 

The directory where the director is installed.

Scheduler sfi.director.util.Setup.scheduler = null [static]
 

Our current scheduler.

DBConnection sfi.director.util.Setup.schemadb = null [static]
 

The database where object schemata are stored.

DBConnection sfi.director.util.Setup.servicesdb = null [static]
 

The database where service information is stored.

DBConnection sfi.director.util.Setup.settingsdb = null [static]
 

The database where internal settings are stored.

String sfi.director.util.Setup.tmphost [static]
 

The name of the host storing site-wide temporary files.

String sfi.director.util.Setup.tmpstorage = null [static]
 

The directory on tmphost where site-wide temporary files are stored.

DBConnection sfi.director.util.Setup.topdb = null [static]
 

The database where the database root is.


The documentation for this class was generated from the following file:
Generated on Sat May 19 01:20:00 2012 for Node Director by  doxygen 1.4.5