vqServer API Index of fields and methods

Contents
Package index

A B C D E F G H I K L M N O P Q R S T U V W

G

get(int). Method in class vq.utils.kllist
Returns the nth entry in the list or null if the number of entries in the list is less than n.
get(String). Method in class vq.server.Cache
Returns a CacheEntry object which represents the file specified.
get(String). Method in class vq.utils.kllist
Returns the first entry in the list whose key matches (case insensitive) the specified string or null if no corresponding entry is found.
get(String, String). Method in class vq.server.Cache
Returns a CacheEntry object which represents the entry specified in the .zip or .jar file specified.
getAccesses(). Method in class vq.server.User
Returns the number of times the user has made an authenticated request since the user was created.
getAccessLogging(). Method in class vq.server.HttpServer
Returns true if access logging is enabled.
getAcls(). Static method in class vq.server.console
Returns the list of ACLs.
getAction(). Method in class vq.server.Alias
Returns an integer corresponding to the action for the alias.
getAddress(). Method in class vq.server.User
Returns the user's postal address.
getAdminServer(). Static method in class vq.server.console
Returns the administration server.
getAlias(). Method in class vq.server.ServletInstance
Returns the alias by which the servlet was/is invoked.
getAliases(). Method in class vq.server.HttpServer
Returns the server's list of aliases.
getAttribute(String). Method in class vq.server.HttpServer
Returns the object bound to the specified name.
getAttributeNames(). Method in class vq.server.HttpServer
Returns an enumeration of the names of the attributes known to the server.
getAutosaveInterval(). Static method in class vq.server.console
Returns the autosave interval.
getByID(String). Method in class vq.server.Users
Returns the (first) user with the specified ID.
getByName(String). Method in class vq.server.Acls
Returns the ACL with the specified name or null if no ACL with the specified name is in the list.
getByObject(Object). Method in class vq.utils.kolist
Returns the first list entry with the specified object or null if no matching entry is found.
getByValue(String). Method in class vq.utils.kvlist
Returns the first list entry with the specified value or null if no matching entry is found.
getCache(). Static method in class vq.server.console
Returns the server's cache.
getCacheTimeout(). Static method in class vq.server.console
Returns the cache timeout setting, in seconds.
getChanged(). Static method in class vq.server.console
Returns the changed flag.
getCheckHostNameAtStartup(). Static method in class vq.server.console
If this returns true, vqServer attempts to read the server computer's host name and IP address from the operating system during console.init().
getClassName(). Method in class vq.server.ServletInstance
Returns the fully qualified class name of the servlet.
getConsoleStatus(). Static method in class vq.server.console
Returns true if the vqServer console is enabled (or will be enabled).
getCookieAttr(String, String). Static method in class vq.utils.utils
Extracts the specifed attribute value from an HTTP cookie header.
getCreationTime(). Method in class vq.server.User
Returns the time (as returned by System.currentTimeMillis()) the user was created.
getData(). Method in class vq.server.CacheEntry
Returns the contents of the file represented by the CacheEntry as a byte[].
getDefaultFile(). Method in class vq.server.Alias
Returns the default file.
getDesc(). Method in class vq.server.Library
Returns the description of the Java library (as displayed in the vqServer control centre).
getDirListAllowed(). Method in class vq.server.Alias
Returns true if directory listings are enabled for the alias.
getEmail(). Method in class vq.server.User
Returns the user's email address.
getErrorLogging(). Method in class vq.server.HttpServer
Returns true if error logging is enabled.
getExt(). Method in class vq.server.Filetype
Returns the file extension associated with the file type.
getFileName(). Method in class vq.server.ServletInstance
Returns the actual file name of the servlet class file, the archive name if it was loaded from an archive or null if the servlet was read from the CLASSPATH.
getFiletypes(). Static method in class vq.server.console
Returns the list of file types.
getFilter(). Method in class vq.server.Alias
Returns the (list of) filter servlet specification(s) associated with the alias.
getFilter(). Method in class vq.server.Filetype
Returns the (list of) filter servlet specification(s) associated with the file type.
getGui(). Static method in class vq.server.console
Returns the Java AWT Frame object that represents the vqServer GUI window or null if the window is not open.
getGuiStatus(). Static method in class vq.server.console
Returns true if the vqServer GUI window is open (or will be opened).
getHitLogging(). Method in class vq.server.HttpServer
Returns true if hit logging is enabled.
getHostName(). Static method in class vq.server.console
Returns the server computer's host name that vqServer is using.
getHttpTimeout(). Method in class vq.server.HttpServer
Returns the server's HTTP transaction timeout setting.
getIcon(). Method in class vq.server.Filetype
Returns the alias of the icon associated with the file type.
getID(). Method in class vq.server.Acl
Returns the ID of the access control list (as used in the acl field of a self-registration page).
getID(). Method in class vq.server.User
Returns the user's ID.
getIds(). Method in class vq.server.Sessions
Returns an enumeration of all of the session IDs.
getInitParameter(String). Method in class vq.server.Alias
Returns the value of the initialisation parameter specified or null if an initialisation parameter with this name does not exist.
getInitParameterNames(). Method in class vq.server.Alias
Returns an enumeration of the initialization parameters for the alias.
getInitParameters(). Method in class vq.server.Alias
Returns the alias's initialisation parameters which can be maniplulated and modified using kvlist methods.
getInputStream(). Method in class vq.server.CacheEntry
Returns an input stream for reading from the file or archive entry represented by the CacheEntry.
getInterpreter(). Method in class vq.server.Filetype
Returns the CGI Script interpreter associated with the file type.
getIPAddr(). Static method in class vq.server.console
Returns server computer's IP address that vqServer is using.
getKeepAliveTimeout(). Method in class vq.server.HttpServer
Returns the server's keep-alive timeout setting.
getKey(String). Method in class vq.utils.kvlist
Returns the first key associated with the specified value or null if no matching entry is found.
getLastAccessTime(). Method in class vq.server.User
Returns the time (as returned by System.currentTimeMillis()) the user last made an authenticated request.
getLibraries(). Static method in class vq.server.console
Returns the list of Java libraries.
getLocation(). Method in class vq.server.Library
Returns the location of the Java library (as displayed in the vqServer control centre).
getLogBackground(). Static method in class vq.server.console
Returns the background logging setting.
getMainWebServer(). Static method in class vq.server.console
Returns the main web server.
getMaxCacheSize(). Static method in class vq.server.console
Returns the maximum size (in kB) of vqServer's file cache.
getMaxFileSize(). Static method in class vq.server.console
Returns the maximum size (in kB) of file that vqServer will cache.
getMaxServlets(). Static method in class vq.server.console
Returns the maximum number of servlets that vqServer will keep initialised.
getMaxSessionsCached(). Static method in class vq.server.console
Returns the maximum number of sessions that vqServer will keep in memory.
getMaxThreads(). Method in class vq.server.HttpServer
Returns the server's maximum threads setting.
getMembers(). Method in class vq.server.Acl
Returns the list of members of the access control list.
getMimeType(). Method in class vq.server.Filetype
Returns the MIME type associated with the file type.
getMimeType(String). Method in class vq.server.HttpServer
Returns the mime type of the specified file or null if not known.
getMinThreads(). Method in class vq.server.HttpServer
Returns the server's minimum threads setting.
getName(). Method in class vq.server.Acl
Returns the name of the access control list (as displayed in the vqServer control centre).
getName(). Method in class vq.server.Server
Returns the server's name.
getName(). Method in class vq.server.User
Returns the user's name.
getName(). Method in class vq.server.Alias
Returns the name of the alias.
getNeverDestroy(). Method in class vq.server.Alias
Returns the never destroy setting of the alias.
getNote(). Method in class vq.server.User
Returns the user's note field.
getObject(String). Method in class vq.utils.kolist
Returns the first object associated with the specified key in the list or null if no matching entry is found.
getPath(). Method in class vq.server.Alias
Returns the real name of the alias.
getPath(). Method in class vq.server.ServletInstance
Returns the directory or archive from which the servlet .class file was read.
getPort(). Method in class vq.server.Server
Returns the TCP/IP port on which the server listens for incoming requests.
getPort(). Method in class vq.server.ServletInstance
Returns the TCP/IP port number of the server that "owns" the servlet.
getPreload(). Method in class vq.server.Alias
Returns the preload setting of the alias.
getPwd(). Method in class vq.server.User
Returns the user's password.
getPwdChangedTime(). Method in class vq.server.User
Returns the time (as returned by System.currentTimeMillis()) the user's password was last changed.
getReadAcl(). Method in class vq.server.Alias
Returns the read ACL of the alias.
getRealPath(String). Method in class vq.server.HttpServer
Translates the specified alias into a real file name.
getRefererLogging(). Method in class vq.server.HttpServer
Returns true if referer logging is enabled.
getRegKey(). Static method in class vq.server.console
Returns the current registration key.
getRequestDispatcher(String). Method in class vq.server.HttpServer
Returns a request disptacher for the specified URI.
getResource(String). Method in class vq.server.HttpServer
Returns a URL object that points to the corresponding URI.
getSavedStatus(). Method in class vq.server.Server
Returns the server's status as read from or will be saved to the configuration file.
getSaveSessions(). Static method in class vq.server.console
Returns true if sessions are saved when vqServer is shut down.
getSelfReg(). Method in class vq.server.Acl
Returns true if self-registration is enabled for the access control list.
getServerInfo(). Method in class vq.server.HttpServer
Returns the server name and version number.
getServers(). Static method in class vq.server.console
Returns the list of servers.
getServlet(). Method in class vq.server.ServletInstance
Returns the actual servlet.
getServlet(String). Method in class vq.server.HttpServer
Returns the specified servlet.
getServlet(String, String, Alias). Method in class vq.server.Servlets
Returns the specified servlet instance (as a ServletInstance object) or null if the servlet cannot be loaded, instantiated or initialised.
getServletContext(). Method in class vq.server.Alias
Returns the ServletContext for the alias.
getServletLogging(). Method in class vq.server.HttpServer
Returns true if servlet logging is enabled.
getServletNames(). Method in class vq.server.HttpServer
Returns an enumeration of the aliases of the servlets in this context (server).
getServlets(). Method in class vq.server.HttpServer
Returns an enumeration of the servlets in this context (server).
getServlets(). Static method in class vq.server.console
Returns the list of servlets.
getSession(String). Method in class vq.server.Sessions
Returns the session object with the specified session ID or null if the specified session does not exist.
getSessions(). Static method in class vq.server.console
Returns the Sessions object.
getSessionsEnabled(). Static method in class vq.server.console
Returns true if session tracking is enabled.
getSessionTimeout(). Static method in class vq.server.console
Returns the session timeout, in minutes.
getStatus(). Method in class vq.server.Server
Returns true if the server is running.
getUseCustom(). Method in class vq.server.Acl
Returns true if a custom login page is enabled for the access control list.
getUsers(). Static method in class vq.server.console
Returns the list of users.
getValue(String). Method in class vq.utils.kvlist
Returns the first value associated with the specified key in the list or null if no matching entry is found.
getVersion(). Static method in class vq.server.console
Returns the vqServer version number.
getWriteAcl(). Method in class vq.server.Alias
Returns the write ACL of the alias.

vqServer API version 1.9. vqServer and the vqServer API are copyright © Steve Shering and vqSoft 1997-99. Last updated 15 May 2000.

Contents
Package index