docs.roxen.comView this page in a printer friendly mode
DocsRoxenWebServer 6.1System Developer Manual JavaReference for Roxen Java classes
Copyright © 2018, Roxen Internet Software
Suggestions, comments & compliments
manuals@roxen.com
 DEMO  DOCS  PIKE
 COMMUNITY  DOWNLOAD
www.roxen.com

   

AbstractLocationModule
ExperimentalModule
FileExtensionModule
Frame
HTTP
LastResortModule
LocationModule
Module
ParserModule
ProviderModule
RXML
RXML.Backtrace
RoxenClassLoader
RoxenConfiguration
RoxenFileResponse
RoxenLib
RoxenRXMLResponse
RoxenRequest
RoxenResponse
RoxenStringResponse
SecurityModule
SimpleTagCaller
UniqueModule

RoxenConfiguration

: Class RoxenConfiguration

com.roxen.roxen
Class RoxenConfiguration


java.lang.Object
  |
  +--com.roxen.roxen.RoxenConfiguration
public class RoxenConfiguration
extends java.lang.Object

A class representing the configuration of a virtual server in the Roxen server.

Constructor Summary
RoxenConfiguration()
           
 
Method Summary
 java.lang.String getFileContents(java.lang.String filename, RoxenRequest id)
          Gets the contents of a file
 java.lang.String getMimeType(java.lang.String filename)
          Gets the mime type of a file
 Module getProvider(java.lang.String provides)
          Returns any module providing a particular service
 Module[] getProviders(java.lang.String provides)
          Returns a list of modules providing a particular service
 java.lang.String getRealPath(java.lang.String filename, RoxenRequest id)
          Get the real path of a virtual file
 java.lang.Object query(java.lang.String name)
          Get the current value of a global configuration variable
 java.lang.String queryInternalLocation()
          Returns the URL path of the base for all internal mount points
 java.lang.String queryInternalLocation(Module m)
          Returns the URL path of the internal mount point for a specified module
 java.lang.String queryString(java.lang.String name)
          Get the current value of a string typed global configuration variable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RoxenConfiguration


public RoxenConfiguration()
Method Detail

getRealPath


public java.lang.String getRealPath(java.lang.String filename,
                                    RoxenRequest id)
Get the real path of a virtual file
Parameters:
name - The virtual file name

getFileContents


public java.lang.String getFileContents(java.lang.String filename,
                                        RoxenRequest id)
Gets the contents of a file
Parameters:
name - The name of the file
Returns:
File contents, or null if the file could not be read

getMimeType


public java.lang.String getMimeType(java.lang.String filename)
Gets the mime type of a file
Parameters:
name - The name of the file
Returns:
The mime type of the file

query


public java.lang.Object query(java.lang.String name)
Get the current value of a global configuration variable
Parameters:
name - the internal name of the variable
Returns:
the value of the variable

queryInternalLocation


public java.lang.String queryInternalLocation(Module m)
Returns the URL path of the internal mount point for a specified module
Parameters:
m - the module
Returns:
the URL path for the module's internal mount point

queryString


public java.lang.String queryString(java.lang.String name)
Get the current value of a string typed global configuration variable
Parameters:
name - the internal name of the variable
Returns:
the value of the variable

queryInternalLocation


public java.lang.String queryInternalLocation()
Returns the URL path of the base for all internal mount points
Returns:
the URL path for the base internal mount point

getProviders


public Module[] getProviders(java.lang.String provides)
Returns a list of modules providing a particular service
Returns:
the modules that provide this service

getProvider


public Module getProvider(java.lang.String provides)
Returns any module providing a particular service
Returns:
the module that provide this service, or null