org.locomotive.loco
Class LocoConfig

java.lang.Object
  |
  +--org.locomotive.server.Config
        |
        +--org.locomotive.loco.LocoConfig

public class LocoConfig
extends Config

The config object for the Locomotive. Each of the Locomotive configs that can be set are listed and documented in the sample loco.conf file included with each distribution. To see what the current config settings are, log into the Locomotive has an admin user and request the srv URL (i.e. 'http://www.yourdomain.com/cgi-bin/locolink/srv'). To change any configs during runtime, use the changeConfig() method. For more information, see the Locomotive Installation Guide or the Locomotive Administrator's Guide.


Field Summary
static int DB_TYPE
          Holds the database type.
 
Fields inherited from class org.locomotive.server.Config
BEAN, forint, forstring
 
Constructor Summary
LocoConfig()
           
LocoConfig(java.lang.String[] args, java.lang.String defaultpath)
          This creates a LocoConfig object.
 
Method Summary
 java.lang.String changeConfig(java.lang.String name, java.lang.String value)
          changes the value of a config at runtime.
 java.lang.Integer getLocoInstId()
           
 java.lang.Integer getLocoPort()
           
 java.lang.Integer getLocoPortBacklog()
           
 java.lang.String getLocoTemplateRootPath()
           
 java.lang.String getLocoUploadPath()
           
 java.lang.String getLocoUrlHomepage()
           
 java.lang.String getLocoUrlMain()
           
 java.lang.String getNsapiTunnelUriTokenPrefix()
           
 java.lang.String getServiceClasspath()
           
 java.lang.String getSystemInstanceId()
           
 java.lang.String getSystemServerRootPath()
           
 java.lang.String getSystemTag()
           
 void setLocoInstId(java.lang.Integer val)
           
 void setLocoPort(java.lang.Integer val)
           
 void setLocoPortBacklog(java.lang.Integer val)
           
 void setLocoTemplateRootPath(java.lang.String val)
           
 void setLocoUploadPath(java.lang.String val)
           
 void setLocoUrlHomepage(java.lang.String val)
           
 void setLocoUrlMain(java.lang.String val)
           
 void setNsapiTunnelUriTokenPrefix(java.lang.String val)
           
 void setServiceClasspath(java.lang.String val)
           
 void setSystemInstanceId(java.lang.String val)
           
 void setSystemServerRootPath(java.lang.String val)
           
 void setSystemTag(java.lang.String val)
           
 void setupDefaults()
          This establishes the default setting for all the Locomotive configs.
 
Methods inherited from class org.locomotive.server.Config
addConfig, doConfigDump, genericGetInteger, genericGetString, genericSet, genericSetInteger, genericSetString, getConfigFilePath, getConfigNamesEnumeration, getInt, getString, init, isComment, loadConfigsFromFile, printsyntax
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DB_TYPE

public static int DB_TYPE
Holds the database type. Currently Oracle, Informix, Cloudscape, MySQL, Solid, and PostGreSQL are supported.
Constructor Detail

LocoConfig

public LocoConfig(java.lang.String[] args,
                  java.lang.String defaultpath)
           throws java.lang.IllegalArgumentException
This creates a LocoConfig object. It takes the same comman arguments as its super class.

LocoConfig

public LocoConfig()
Method Detail

getSystemTag

public java.lang.String getSystemTag()

setSystemTag

public void setSystemTag(java.lang.String val)

getSystemInstanceId

public java.lang.String getSystemInstanceId()

setSystemInstanceId

public void setSystemInstanceId(java.lang.String val)

getLocoInstId

public java.lang.Integer getLocoInstId()

setLocoInstId

public void setLocoInstId(java.lang.Integer val)

getLocoUrlMain

public java.lang.String getLocoUrlMain()

setLocoUrlMain

public void setLocoUrlMain(java.lang.String val)

getLocoUrlHomepage

public java.lang.String getLocoUrlHomepage()

setLocoUrlHomepage

public void setLocoUrlHomepage(java.lang.String val)

getNsapiTunnelUriTokenPrefix

public java.lang.String getNsapiTunnelUriTokenPrefix()

setNsapiTunnelUriTokenPrefix

public void setNsapiTunnelUriTokenPrefix(java.lang.String val)

getSystemServerRootPath

public java.lang.String getSystemServerRootPath()

setSystemServerRootPath

public void setSystemServerRootPath(java.lang.String val)

getLocoTemplateRootPath

public java.lang.String getLocoTemplateRootPath()

setLocoTemplateRootPath

public void setLocoTemplateRootPath(java.lang.String val)

getLocoUploadPath

public java.lang.String getLocoUploadPath()

setLocoUploadPath

public void setLocoUploadPath(java.lang.String val)

getServiceClasspath

public java.lang.String getServiceClasspath()

setServiceClasspath

public void setServiceClasspath(java.lang.String val)

getLocoPort

public java.lang.Integer getLocoPort()

setLocoPort

public void setLocoPort(java.lang.Integer val)

getLocoPortBacklog

public java.lang.Integer getLocoPortBacklog()

setLocoPortBacklog

public void setLocoPortBacklog(java.lang.Integer val)

setupDefaults

public void setupDefaults()
This establishes the default setting for all the Locomotive configs.
Overrides:
setupDefaults in class Config
Tags copied from class: Config
See Also:
Config.addConfig(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

changeConfig

public java.lang.String changeConfig(java.lang.String name,
                                     java.lang.String value)
                              throws ConfigNotFoundException,
                                     ConfigInitializationException
changes the value of a config at runtime. Checks for change in DB_TYPE, and, if changed, resets the DB_TYPE variable. Also checks to make sure SERVICE_DEFAULT is either HANDLER or SERVLET.
Overrides:
changeConfig in class Config
Parameters:
name: - the name of the config
value - the new value for the config.
Throws:
ConfigNotFoundException - if the config does not exist.
ConfigInitializationException - if the config value does not match the required constraints. For DB_TYPE, value must be either 'Oracle', 'Informix', 'Cloudscape', MySQL, or 'Solid'. For SERVICE_DEFAULT, this must be either 'Handler' or 'Servlet'.