velosurf
Class Velosurf

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap
          velosurf.context.DBReference
              velosurf.Velosurf

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map, ReadOnlyMap

public class Velosurf
extends DBReference

this class is the Velosurf main entry class if you do not use the toolbox.xml mechanism. Unless you specify the config file to use, it will successively search for a configuration file :

• from the java property "config.velosurf" (like in 'java -Dconfig.velosurf=/.../velosurf.xml ...' )

• from the Velocity property "config.velosurf" (entry of the velocity.properties file)

• as './velosurf.xml', './conf/velosurf.xml', './WEB-INF/velosurf.xml', './cfg/velosurf.xml'

  Author:

  Claude Brisson

  See Also:

  Serialized Form

  Field Summary

  private java.lang.String	configFile
  private boolean	initialized

  Fields inherited from class velosurf.context.DBReference

  cache, db, externalParams, userContext

  Constructor Summary

  Velosurf()
  

  Velosurf(java.io.File file)
  

  Velosurf(java.io.InputStream config)
  

  Method Summary

  java.lang.String	deobfuscate(java.lang.Object value) de-obfuscate the given value
  protected static java.lang.String	findConfig()
  java.lang.Object	get(java.lang.Object key) Generic getter, used to access entities or root attributes by their name.
  java.lang.String	getSchema() get the schema
  protected void	init()
  protected void	init(java.io.InputStream config)
  protected void	initLogging()
  java.lang.String	obfuscate(java.lang.Object value) obfuscate the given value
  java.lang.Object	put(java.lang.Object key, java.lang.Object value) Generic setter used to set external params for children attributes
  void	setConfigFile(java.lang.String config)

  Methods inherited from class velosurf.context.DBReference

  init, init

  Methods inherited from class java.util.HashMap

  clear, clone, containsKey, containsValue, entrySet, isEmpty, keySet, putAll, remove, size, values

  Methods inherited from class java.util.AbstractMap

  equals, hashCode, toString

  Methods inherited from class java.lang.Object

  finalize, getClass, notify, notifyAll, wait, wait, wait

  Methods inherited from interface velosurf.sql.ReadOnlyMap

  keySet

  Methods inherited from interface java.util.Map

  equals, hashCode

  Field Detail

  initialized

  private boolean initialized

  configFile

  private java.lang.String configFile

  Constructor Detail

  Velosurf

  public Velosurf()
           throws java.io.IOException,
                  java.sql.SQLException

  Throws:

  java.io.IOException

  java.sql.SQLException

  Velosurf

  public Velosurf(java.io.File file)
           throws java.io.IOException,
                  java.sql.SQLException

  Throws:

  java.io.IOException

  java.sql.SQLException

  Velosurf

  public Velosurf(java.io.InputStream config)
           throws java.io.IOException,
                  java.sql.SQLException

  Throws:

  java.io.IOException

  java.sql.SQLException

  Method Detail

  setConfigFile

  public void setConfigFile(java.lang.String config)

  initLogging

  protected void initLogging()

  findConfig

  protected static java.lang.String findConfig()
                                        throws java.io.IOException

  Throws:

  java.io.IOException

  init

  protected void init(java.io.InputStream config)
               throws java.sql.SQLException,
                      java.io.IOException

  Throws:

  java.sql.SQLException

  java.io.IOException

  init

  protected void init()
               throws java.sql.SQLException,
                      java.io.IOException

  Throws:

  java.sql.SQLException

  java.io.IOException

  get

  public java.lang.Object get(java.lang.Object key)

  Description copied from class: DBReference

  Generic getter, used to access entities or root attributes by their name.

  For attributes, the return value depends upon the type of the attribute :

  • if the attribute is multivalued, returns an AttributeReference.
  • if the attribute is singlevalued, returns an Instance.
  • if the attribute is scalar, returns a String.

  Specified by:

  get in interface java.util.Map

  Specified by:

  get in interface ReadOnlyMap

  Overrides:

  get in class DBReference

  Parameters:

  key - the name of the desired entity or root attribute.

  Returns:

  an entity, an attribute reference, an instance, a string or null if not found. See See above.

  put

  public java.lang.Object put(java.lang.Object key,
                              java.lang.Object value)

  Description copied from class: DBReference

  Generic setter used to set external params for children attributes

  Specified by:

  put in interface java.util.Map

  Overrides:

  put in class DBReference

  Parameters:

  key - name of the external parameter

  value - value given to the external parameter

  Returns:

  the previous value, if any

  getSchema

  public java.lang.String getSchema()

  Description copied from class: DBReference

  get the schema

  Overrides:

  getSchema in class DBReference

  Returns:

  the schema

  obfuscate

  public java.lang.String obfuscate(java.lang.Object value)

  obfuscate the given value

  Overrides:

  obfuscate in class DBReference

  Parameters:

  value - value to obfuscate

  Returns:

  obfuscated value

  deobfuscate

  public java.lang.String deobfuscate(java.lang.Object value)

  de-obfuscate the given value

  Overrides:

  deobfuscate in class DBReference

  Parameters:

  value - value to de-obfuscate

  Returns:

  obfuscated value