thredds.dqc.server

Class DqcServletConfig

java.lang.Object

thredds.dqc.server.DqcServletConfig

public class DqcServletConfig
extends Object

The DqcServletConfig class keeps track of the configuration of a DQC Servlet. The configuration is made up of all the dataset collections being handled by this DQC Servlet.

Constructor Summary

Constructors

Modifier	Constructor and Description
	DqcServletConfig(File configPath, String configFileName) Create a new DqcServletConfig instance using the given configuration file.
protected	DqcServletConfig(String configDocResourcePath, String configDocResourceName) Used for testing.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addItem(DqcServletConfigItem item)
boolean	addItem(String name, String description, String handlerName, String handlerConfigFileName)
InvCatalog	createCatalogRepresentation(String servletURL)
DqcServletConfigItem	findItem(String itemName) Find an item with the given name.
String	getDqcServletTitle()
Iterator	getIterator() Return an iterator of the config items in this config.
String	toString()
void	writeConfig(OutputStream os)
static void	writeExampleConfig(String fileName, String name, String description, String handlerName, String handlerConfigFileName) A convenience routine for writing a DqcServlet config file.

Methods inherited from class java.lang.Object

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

Constructor Detail

DqcServletConfig

public DqcServletConfig(File configPath,
                String configFileName)
                 throws IOException

Create a new DqcServletConfig instance using the given configuration file.

The configuration file is a ucar.util.prefs.XMLStore that contains one bean collection named "config". Each bean is a DqcServletConfigItem containing information about the setup of a DQC handler. Here is an example configuration document:

Several other examples are distributed as part of the DqcServlet distribution.

Parameters:

configPath - - the path to the DqcServlet configuration files.

configFileName - - the name of the DqcServlet configuration file.

Throws:

IOException - if can't create XMLStore from given file.

NullPointerException - if either the path or the filename parameters are null.

RuntimeException - if ucar.util.prefs has problems (not clear when these situations might occur).

DqcServletConfig

protected DqcServletConfig(String configDocResourcePath,
                String configDocResourceName)
                    throws IOException

Used for testing. Same functionality as DqcServletConfig( File, String).

Parameters:

configDocResourcePath - - the path to the resource containing the configuration document.

configDocResourceName - - the name of the resource containing the configuration document.

Throws:

IOException - if can't create XMLStore from resource.

NullPointerException - if the resource name parameter is null.

RuntimeException - if ucar.util.prefs has problems (not clear when these situations might occur).

Method Detail

getDqcServletTitle

public String getDqcServletTitle()

getIterator

public Iterator getIterator()

Return an iterator of the config items in this config.

findItem

public DqcServletConfigItem findItem(String itemName)

Find an item with the given name.

addItem

public boolean addItem(DqcServletConfigItem item)

addItem

public boolean addItem(String name,
              String description,
              String handlerName,
              String handlerConfigFileName)

writeConfig

public void writeConfig(OutputStream os)
                 throws IOException

Throws:

IOException

writeExampleConfig

public static void writeExampleConfig(String fileName,
                      String name,
                      String description,
                      String handlerName,
                      String handlerConfigFileName)
                               throws IOException

A convenience routine for writing a DqcServlet config file.

Parameters:

fileName -

name -

description -

handlerName -

handlerConfigFileName -

Throws:

IOException

createCatalogRepresentation

public InvCatalog createCatalogRepresentation(String servletURL)

toString

public String toString()

Overrides:

toString in class Object