Module
com.roxen.roxen
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Field Summary | |
static int |
TYPE_DIR
Constant for directory name type module variables |
static int |
TYPE_DIR_LIST
Constant for directory name list type module variables |
static int |
TYPE_FILE
Constant for file name type module variables |
static int |
TYPE_FILE_LIST
Constant for file name list type module variables |
static int |
TYPE_FLAG
Constant for boolean type module variables |
static int |
TYPE_FLOAT
Constant for floating point type module variables |
static int |
TYPE_FONT
Constant for font name type module variables |
static int |
TYPE_INT
Constant for integer type module variables |
static int |
TYPE_INT_LIST
Constant for integer list type module variables |
static int |
TYPE_LOCATION
Constant for URL path type module variables |
static int |
TYPE_MODULE
Constant for module type module variables |
static int |
TYPE_MULTIPLE_INT
The same as TYPE_INT_LIST |
static int |
TYPE_MULTIPLE_STRING
The same as TYPE_STRING_LIST |
static int |
TYPE_PASSWORD
Constant for string type module variables |
static int |
TYPE_STRING
Constant for string type module variables |
static int |
TYPE_STRING_LIST
Constant for string list type module variables |
static int |
TYPE_TEXT
The same as TYPE_TEXT_FIELD |
static int |
TYPE_TEXT_FIELD
Constant for free format text type module variables |
static int |
TYPE_TOGGLE
The same as TYPE_FLAG |
static int |
VAR_DEVELOPER
Constant for developer option variable flag. |
static int |
VAR_EXPERT
Constant for expert mode variable flag. |
static int |
VAR_INITIAL
Constant for initial configuration variable flag. |
static int |
VAR_MORE
Constant for advanced option variable flag. |
| Constructor Summary | |
Module()
|
|
| Method Summary | |
protected void |
defvar(java.lang.String var,
java.lang.Object value,
java.lang.String name,
int type)
Create an undocumented module varible. |
protected void |
defvar(java.lang.String var,
java.lang.Object value,
java.lang.String name,
int type,
java.lang.String doc)
Create a module varible. |
protected RoxenResponse |
findInternal(java.lang.String f,
RoxenRequest id)
Request an internal resource from this module. |
abstract java.lang.String |
info()
Returns the documentation for the module |
RoxenConfiguration |
myConfiguration()
Returns the configuration object of the virtual server in which this module is enabled |
java.lang.Object |
query(java.lang.String name)
Get the current value of a module variable |
int |
queryInt(java.lang.String name)
Get the current value of a TYPE_INT or
TYPE_FLAG module variable |
protected java.lang.String |
queryInternalLocation()
Returns the URL path of the internal mount point that has been created for this module. |
abstract java.lang.String |
queryName()
Returns the name of the module |
java.lang.String |
queryString(java.lang.String name)
Get the current value of a module variable of one of the string types. |
protected void |
set(java.lang.String name,
int value)
Set the contents of a TYPE_INT or TYPE_FLAG
module variable to a new value |
protected void |
set(java.lang.String name,
java.lang.Object value)
Set the contents of a module variable to a new value |
protected void |
start()
Prepare the module for servicing requests |
java.lang.String |
status()
Produce information about the current status of the module |
protected void |
stop()
Inform the module that it is about to be taken out of service |
| Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
| Field Detail |
| Constructor Detail |
| Method Detail |
f - the path of the resource relative to the location of
this moduleid - the request objectnull if no such
file exists.null if no
information is availablevar - a name by which this variables is identified internallyvalue - the default value for this variablename - a human-readable name for this variabletype - a TYPE_-constant selecting the type of
this variable, optionally ORed with any VAR_
flagsdoc - an HTML string containing brief documentation for the
variablevar - a name by which this variables is identified internallyvalue - the default value for this variablename - a human-readable name for this variabletype - a TYPE_-constant selecting the type of
this variable, optionally ORed with any VAR_
flagsname - the internal name of the variableTYPE_INT or
TYPE_FLAG module variablename - the internal name of the variablename - the internal name of the variablename - the internal name of the variablevalue - the new valueTYPE_INT or TYPE_FLAG
module variable to a new valuename - the internal name of the variablevalue - the new value