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

A

AccessControlList - class org.locomotive.loco.perm.AccessControlList.
Defines permission ACLs.
AccessControlList(int) - Constructor for class org.locomotive.loco.perm.AccessControlList
Creates an ACL for an object with owner id.
ACLManager - class org.locomotive.loco.perm.ACLManager.
Maintains all database transactions dealing with acls.
ACLManager() - Constructor for class org.locomotive.loco.perm.ACLManager
 
AdaptiveClassLoader - class org.apache.java.lang.AdaptiveClassLoader.
A class loader that loads classes from directories and/or zip-format file such as JAR file.
AdaptiveClassLoader(Vector) - Constructor for class org.apache.java.lang.AdaptiveClassLoader
Creates a new class loader that will load classes from specified class repositories.
add(char[]) - Method in class org.locomotive.util.GrowableChar
 
add(GrowableChar) - Method in class org.locomotive.util.GrowableChar
 
add(String) - Method in class org.locomotive.util.StringConstraint
Deprecated. add a new constraint.
add(String) - Method in class org.locomotive.util.GrowableChar
 
addACL(AccessControlList, Connection) - Static method in class org.locomotive.loco.perm.ACLManager
Adds an ACL to the database.
addBeanProperty(BeanProperty) - Method in class org.locomotive.directory.BeanConfiguration
Add a bean property to this bean configuration.
addBytes(byte[]) - Method in class org.locomotive.loco.Response
adds the input byte array to the Response.
addCategory(Connection, String, String, String) - Method in class org.locomotive.module.discuss.DiscussionLib
adds a new category.
addConfig(String, String[], int[], String) - Method in class org.locomotive.server.MultiConfig
Create and add a config entry to the cache we're maintaining.
addConfig(String, String, String, String) - Method in class org.locomotive.server.Config
This method will allow you to add a config, regardless of whether or not it exists in the defaults, or in the config file
addCookie(Cookie) - Method in class org.locomotive.loco.Response
Adds a cookie to the headers for this response
addDirectoryEventListener(DirectoryEventListener) - Method in class org.locomotive.directory.NameService
Add a directory event listener.
addElement(Object) - Method in class org.locomotive.util.SearchableVector
This version of addElement() will check for uniqueness, as well as index the element into a hash table for easier access later.
addElements(Object) - Method in class org.locomotive.util.SearchableVector
 
addElements(Object[]) - Method in class org.locomotive.util.SearchableVector
 
addField(String, String) - Method in class org.locomotive.commerce.ics.ICSRequest
The following method allows you to add your own fields to the SCMP message.
addField(String, String) - Method in class org.locomotive.commerce.ics.SCMPMessage
Adds a name value pair to the message.
addGroup(Group, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Adds a new group to the database.
addGroup(String, String) - Method in class org.locomotive.loco.perm.AccessControlList
Adds a group to a particular permission in the ACL.
addHTTPHeader(String, String) - Method in class org.locomotive.loco.Response
adds an HTTP protocol header to the response.
addHTTPHeader(String, String) - Method in class org.locomotive.loco.HTTPResponse
adds an HTTP protocol header to the response.
addOffer(Offer) - Method in class org.locomotive.commerce.ics.ICSRequest
adds the specified offer to the list (Vector) of offers associated with this ICSRequest.
addPermission(String) - Method in class org.locomotive.loco.perm.AccessControlList
Adds a permission to the ACL.
addPost() - Method in class org.locomotive.module.discuss.DiscussionServlet
This method handles adding a post to a topic.
addPost() - Method in class org.locomotive.module.discuss.DiscussionHandler
This method handles adding a post to a topic.
addPost(Connection, int, String, String, String, String, String) - Method in class org.locomotive.module.discuss.DiscussionLib
adds a post with the specified into to list of posts for the topic specified by the id.
addPropertyConverter(Class, PropertyConverter) - Method in class org.locomotive.directory.NameService
Add property converter.
addRole(Role, Connection) - Static method in class org.locomotive.loco.perm.RoleManager
Adds a new role to the database.
addRoleToUser(int, String, Connection) - Static method in class org.locomotive.loco.perm.RoleManager
Adds a role to a user.
addService(String, String, String) - Method in class org.locomotive.server.ServiceRoutingTable
Creates and adds a new service to the ServiceRoutingTable.
addServletFactoryListener(ServletFactoryListener) - Method in class org.locomotive.loco.servlet.ServletFactory
Adds the specified ServletFactoryListener to the list of listeners to which this ServletFactory will broadcast events.
addStatusToHeaders() - Method in class org.locomotive.loco.servlet.LocoServletResponse
we don't currently have access to the status line via our tunnels, so we really can't do anything here...
addString(String) - Method in class org.locomotive.loco.Response
appends to the output of the Response.
addTopic() - Method in class org.locomotive.module.discuss.DiscussionServlet
This method handles adding a topic to a category.
addTopic() - Method in class org.locomotive.module.discuss.DiscussionHandler
This method handles adding a topic to a category.
addTopic(Connection, int, String) - Method in class org.locomotive.module.discuss.DiscussionLib
adds a topic for the category specified by the id whose title is the specified title.
addUser(String) - Method in class org.locomotive.loco.perm.Group
Adds a user to the group.
addUser(String, String) - Method in class org.locomotive.loco.perm.AccessControlList
Adds a user corresponding to a permission in the ACL.
addUserToGroup(int, int, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Adds a user to a group.
addValue(BeanPropertyValue) - Method in class org.locomotive.directory.BeanProperty
Add a property value.
admin - Variable in class org.locomotive.module.discuss.DiscussionServlet
 
AlarmThread - class org.locomotive.util.cache.AlarmThread.
 
AlarmThread(int, int, int) - Constructor for class org.locomotive.util.cache.AlarmThread
 
allErrorMsgs() - Method in class org.locomotive.loco.FormData
returns a String containing all the error messages generated while accessing all the fields in this form.
already_displayed_page - Variable in class org.locomotive.loco.handler.GenericHandler
whether or not a page has been flushed back to the browser.
and(PermissionSet) - Method in class org.locomotive.loco.perm.PermissionSet
'Ands' this PermissionSet with another PermissionSet.
ANONYMOUS_ID - Static variable in class org.locomotive.loco.User
 
ANONYMOUS_NAME - Static variable in class org.locomotive.loco.User
 
APPROVED - Static variable in class org.locomotive.module.pub.PublisherLib
 
ASCENDING - Static variable in class org.locomotive.util.SortableTable
used to denote an ascending sort
associateUser(Connection, User) - Method in class org.locomotive.loco.Session
associate a user with this session, persistantly.
associateUser(Connection, User, long) - Method in class org.locomotive.loco.store.session.SessionStore
associate a user with this session, persistantly.
associateUser(Connection, User, long) - Method in class org.locomotive.loco.store.session.SessionStoreJdbc
 
associateUser(Connection, User, long) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcInterbase
 
associateUser(Connection, User, long) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcMysql
 
associateUser(Connection, User, long) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcPostgresql
 
AUTHOR - Static variable in class org.locomotive.module.discuss.DiscussionLib
used by the getPostSummaries method specify sorting
availability - Variable in class org.locomotive.loco.servlet.ServletFactoryEvent
The availability status of the servlets.
availability - Variable in class org.locomotive.loco.servlet.ServletFactory
This member variable holds the current creation availability status of this ServletFactory's class of servlets.
availability - Variable in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
This ServiceEntry's service may not be available to serve requests at certain times.
AVAILABLE - Static variable in class org.locomotive.loco.servlet.ServletFactory
If the instance member availability is set to AVAILABLE, that means that servlets of the class servlet_class can be created and initialized.
AVAILABLE - Static variable in class org.locomotive.server.ServiceRoutingTable
If the instance member availability is set to AVAILABLE, that means that this ServiceEntry's service is available to serve requests.
available() - Method in class org.locomotive.loco.servlet.LocoServletRequest.RequestInputStream
 
AVERAGE_ENTRIES_PER_ROW - Static variable in class org.locomotive.util.DoubleHashtable
 

B

Base64 - class org.locomotive.util.Base64.
Utility routine for manipulating blocks of Base64 data
Base64() - Constructor for class org.locomotive.util.Base64
 
base64Decode(byte[]) - Static method in class org.locomotive.util.Base64
decodes input base64, returns binary byte array.
base64Encode(byte[]) - Static method in class org.locomotive.util.Base64
convert a byte array to a base64 byte array output is 4/3 size of input, plus extra 4 bytes 66% of the time
base64lookup - Static variable in class org.locomotive.util.Base64
 
base64reverse_lookup - Static variable in class org.locomotive.util.Base64
 
BaseHandler - class org.locomotive.module.base.BaseHandler.
The base handler is an example handler that accompanies the Loco.
BaseHandler() - Constructor for class org.locomotive.module.base.BaseHandler
 
BaseServlet - class org.locomotive.module.base.BaseServlet.
The base Servlet is an example Servlet that accompanies the Loco.
BaseServlet() - Constructor for class org.locomotive.module.base.BaseServlet
 
BEAN - Static variable in class org.locomotive.server.Config
When the config_file_path is equal to this, it indicates that the configuration was loaded from the BeanDirectory services, not a config file.
beanConfig - Variable in class org.locomotive.directory.DirectoryEvent
 
BeanConfiguration - class org.locomotive.directory.BeanConfiguration.
A class representing a bean configuration.
BeanConfiguration(DirectoryContext) - Constructor for class org.locomotive.directory.BeanConfiguration
Constructor for BeanConfiguration.
BeanDirectory - class org.locomotive.directory.loco.BeanDirectory.
This is an example application showing how you can use Bean Directory to start up an entire application as defined by a set of configuration files.
BeanInstantiator - class org.locomotive.directory.BeanInstantiator.
A NameService object delegates the responsibility for creating new bean instances from BeanConfiguration objects to a object of this class.
BeanParser - interface org.locomotive.directory.BeanParser.
Interface to an object responsible for parsing a single bean configuration file and building the appropriate BeanConfiguration structure.
beanProperty - Variable in class org.locomotive.directory.DirectoryEvent
 
BeanProperty - class org.locomotive.directory.BeanProperty.
Represents a property of a bean.
BeanProperty() - Constructor for class org.locomotive.directory.BeanProperty
 
BeanPropertyValue - class org.locomotive.directory.BeanPropertyValue.
A class representing a bean property value.
BeanPropertyValue() - Constructor for class org.locomotive.directory.BeanPropertyValue
 
block() - Method in class org.locomotive.util.BlockLock
thread that wants to block calls this
blockForTime(long) - Method in class org.locomotive.util.BlockLock
blocks for a certain maximum time period.
BlockLock - class org.locomotive.util.BlockLock.
BlockLock - allows one thread to hold and release another efficiently.
BlockLock() - Constructor for class org.locomotive.util.BlockLock
creates a new BlockLock.
bstamp_id - Variable in class org.locomotive.loco.handler.HandlerData
a numerical id used to track browsers.
BStampStore - class org.locomotive.loco.store.bstamp.BStampStore.
 
BStampStore() - Constructor for class org.locomotive.loco.store.bstamp.BStampStore
 
BStampStoreJdbc - class org.locomotive.loco.store.bstamp.BStampStoreJdbc.
 
BStampStoreJdbc() - Constructor for class org.locomotive.loco.store.bstamp.BStampStoreJdbc
 
BStampStoreJdbcCloudscape - class org.locomotive.loco.store.bstamp.BStampStoreJdbcCloudscape.
 
BStampStoreJdbcCloudscape() - Constructor for class org.locomotive.loco.store.bstamp.BStampStoreJdbcCloudscape
 
BStampStoreJdbcInformix - class org.locomotive.loco.store.bstamp.BStampStoreJdbcInformix.
 
BStampStoreJdbcInformix() - Constructor for class org.locomotive.loco.store.bstamp.BStampStoreJdbcInformix
 
BStampStoreJdbcInterbase - class org.locomotive.loco.store.bstamp.BStampStoreJdbcInterbase.
 
BStampStoreJdbcInterbase() - Constructor for class org.locomotive.loco.store.bstamp.BStampStoreJdbcInterbase
 
BStampStoreJdbcMysql - class org.locomotive.loco.store.bstamp.BStampStoreJdbcMysql.
 
BStampStoreJdbcMysql() - Constructor for class org.locomotive.loco.store.bstamp.BStampStoreJdbcMysql
 
BStampStoreJdbcOracle - class org.locomotive.loco.store.bstamp.BStampStoreJdbcOracle.
 
BStampStoreJdbcOracle() - Constructor for class org.locomotive.loco.store.bstamp.BStampStoreJdbcOracle
 
BStampStoreJdbcPostgresql - class org.locomotive.loco.store.bstamp.BStampStoreJdbcPostgresql.
 
BStampStoreJdbcPostgresql() - Constructor for class org.locomotive.loco.store.bstamp.BStampStoreJdbcPostgresql
 
BStampStoreJdbcSolid - class org.locomotive.loco.store.bstamp.BStampStoreJdbcSolid.
 
BStampStoreJdbcSolid() - Constructor for class org.locomotive.loco.store.bstamp.BStampStoreJdbcSolid
 
buf - Variable in class org.locomotive.util.GrowableChar
 
BugTrackerHandler - class org.locomotive.module.btrack.BugTrackerHandler.
BugTracker is a bug tracking system that allows the creation and editing of projects and bugs associated with them.
BugTrackerHandler() - Constructor for class org.locomotive.module.btrack.BugTrackerHandler
 
buildINClause(String, int[]) - Static method in class org.locomotive.util.SQL
builds an SQL "IN clause" using the input column name and number array
buildNOTINClause(String, int[]) - Static method in class org.locomotive.util.SQL
builds an SQL "NOT IN clause" using the input column name and number array

C

cached - Variable in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
 
CachedPageLoader - class org.locomotive.steam.CachedPageLoader.
The CachedPageLoader evalutes templates from the filesystem or passed in as a string according to the rules of the LOCO Template Language.
CachedPageLoader(Log, int) - Constructor for class org.locomotive.steam.CachedPageLoader
Contructs a CachedPageLoader with the specified debugging log/identifier for internal logging.
cachedTemplateExpr(String) - Static method in class org.locomotive.steam.CachedPageLoader
This method will get a template expression tree either from the cache or from a file.
cachedTemplateExpr(String, boolean) - Static method in class org.locomotive.steam.CachedPageLoader
This method will get a template expression tree either from the cache or from a file.
CacheNamingException - exception org.locomotive.util.cache.CacheNamingException.
 
canChangeLocoVars() - Method in class org.locomotive.loco.User
 
canEditUserPrefs() - Method in class org.locomotive.loco.User
 
canShutDownLoco() - Method in class org.locomotive.loco.User
 
canViewServerStatus() - Method in class org.locomotive.loco.User
 
canViewUserPrefs() - Method in class org.locomotive.loco.User
 
capitalize(String) - Method in class org.locomotive.directory.BeanInstantiator
 
CENSORED - Static variable in class org.locomotive.module.pub.PublisherLib
Constants used to denote the different statuses that a published page can be in:
cfg - Variable in class org.locomotive.loco.handler.HandlerData
a org.locomotive.loco.LocoConfig referencing the default Loco config object
cgi_envars_hash - Variable in class org.locomotive.loco.handler.HandlerData
A hashtable containing the name/value pairs passed into the Loco by the web server.
CGIUnescape(String) - Static method in class org.locomotive.util.StringUtil
takes CGIEncoded strings (normally from the contents of the STDIN in a POST) and unquotes them
changeCategoryStatus(Connection, int, String) - Method in class org.locomotive.module.discuss.DiscussionLib
Changes a topic's status to the specified parameter.
changeConfig(String, String) - Method in class org.locomotive.loco.HTTPServerConfig
changes the value of a config at runtime.
changeConfig(String, String) - Method in class org.locomotive.loco.LocoConfig
changes the value of a config at runtime.
changeConfig(String, String) - Method in class org.locomotive.server.Config
this method changes an already created config to a specified value.
changeNullsToString(int, String) - Method in class org.locomotive.util.SortableTable
change nulls in a column to an empty string ("")
changePostStatus(Connection, int, String) - Method in class org.locomotive.module.discuss.DiscussionLib
changes a post status.
changeStatus(Connection, int, int) - Static method in class org.locomotive.module.pub.PublisherLib
Changes the status of a page in the database.
changeTopicStatus(Connection, int, String) - Method in class org.locomotive.module.discuss.DiscussionLib
Changes a topic's status to the specified parameter.
char_encoding - Variable in class org.locomotive.loco.Response
 
check(String, StringBuffer) - Method in class org.locomotive.util.StringConstraint
Deprecated. Check a string with the present set of constraints.
checkHashWithConstraints(Hashtable, Hashtable) - Static method in class org.locomotive.util.StringConstraint
Deprecated. check all the values of a hash table against a hashtable containing a list of constraints.
classname - Variable in class org.locomotive.util.ObjectPool
This gets prepended to each logging message.
classname - Variable in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
 
cleanTopics(Connection) - Method in class org.locomotive.module.discuss.DiscussionLib
Delete all topics which don't have any posts.
CLEANUP_INTERVAL - Static variable in class org.locomotive.util.DoubleHashtable
 
cleanUpPrice(String) - Static method in class org.locomotive.util.Commerce
Given a price string, make it presentable by adding .00 if it's a straight integer or adding 0 if it's a 1.6 form.
clear() - Method in class org.locomotive.util.DoubleHashtable
 
clear() - Method in class org.locomotive.util.GrowableChar
 
clear() - Method in class org.locomotive.loco.perm.PermissionSet
Clears all permissions in the permission set.
clearBody() - Method in class org.locomotive.loco.Response
clears whatever data is currently resident in the Response body.
clearCacheForClass(String, boolean) - Method in class org.locomotive.util.cache.DBCache
This method will remove all the items for this class from the cache.
clearHeaders() - Method in class org.locomotive.loco.Response
wipes all headers for this response.
clearOffers() - Method in class org.locomotive.commerce.ics.ICSRequest
deletes or removes any offers that were added to this request.
clearTemplateCache() - Static method in class org.locomotive.steam.CachedPageLoader
This static method can be called to flush the template cache.
clip(String, int) - Static method in class org.locomotive.util.StringUtil
A utility function to trim a string to a given length.
clone() - Method in class org.locomotive.loco.perm.PermissionSet
Makes a clone of this PermissionSet.
close() - Method in class org.locomotive.util.FIFO
close the fifo.
close() - Method in class org.locomotive.loco.servlet.LocoServletRequest.RequestInputStream
 
close() - Method in class org.locomotive.loco.Response.ResponseOutputStream
 
closeCurrentPoolMembers() - Method in class org.locomotive.util.ObjectPool
Closes all objects in the pool at the time of the call.
closeLog() - Method in class org.locomotive.server.Log
Closes this Log.
Cloudscape - class org.locomotive.loco.Cloudscape.
This class provides integration of the Locomotive with Cloudscape.
Cloudscape() - Constructor for class org.locomotive.loco.Cloudscape
 
CodeGenerator - class org.locomotive.module.codegen.CodeGenerator.
CodeGenerator is a Java program which generates source code for other Java programs.
CodeGenerator() - Constructor for class org.locomotive.module.codegen.CodeGenerator
 
CodeGeneratorServlet - class org.locomotive.module.codegen.CodeGeneratorServlet.
CodeGenerator is a Java program which generates source code for other Java programs.
CodeGeneratorServlet() - Constructor for class org.locomotive.module.codegen.CodeGeneratorServlet
 
COMM_ADMIN - Static variable in class org.locomotive.module.discuss.DiscussionAdminServlet
Allows a user to administer user access control for discussions and topics:
COMM_ADMIN - Static variable in class org.locomotive.module.discuss.DiscussionAdminHandler
Allows a user to administer user access control for discussions and topics:
COMM_READ - Static variable in class org.locomotive.module.discuss.DiscussionAdminServlet
Allows a user read access to a discussion or topic:
COMM_READ - Static variable in class org.locomotive.module.discuss.DiscussionAdminHandler
Allows a user read access to a discussion or topic:
Commerce - class org.locomotive.util.Commerce.
This class contains some useful utilities, mostly for dealing with credits cards, and some for dealing with dollar currency formats.
Commerce() - Constructor for class org.locomotive.util.Commerce
 
compare(ComparisonKey) - Method in class org.locomotive.util.data.NumberKey
Compare myself to another object
compare(ComparisonKey) - Method in class org.locomotive.util.data.DateKey
Compare myself to another object
compare(ComparisonKey) - Method in class org.locomotive.util.data.StringKey
Compare myself to another object
compare(ComparisonKey) - Method in class org.locomotive.util.data.NameKey
Compare myself to another object
compare(ComparisonKey) - Method in interface org.locomotive.util.data.ComparisonKey
Compare myself to another object
compare(DataTree.TreeNode) - Method in class org.locomotive.util.data.DataTree.TreeNode
Convenience method for comparing the keys of two tree nodes
ComparisonKey - interface org.locomotive.util.data.ComparisonKey.
Defines the compare function to allow arbitrary objects to be compared.
ComparisonKeyException - exception org.locomotive.util.data.ComparisonKeyException.
Provides a basic exception class to be used by comparison keys.
ComparisonKeyException() - Constructor for class org.locomotive.util.data.ComparisonKeyException
 
ComparisonKeyException(String) - Constructor for class org.locomotive.util.data.ComparisonKeyException
 
COMPONENT_TYPE - Static variable in class org.locomotive.directory.BeanPropertyValue
Indicates that this value references a component, and and that the computed value cannot be stored for future use.
Config - class org.locomotive.server.Config.
The Config class provides a way to maintain configuration information.
config_path - Variable in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
 
Config() - Constructor for class org.locomotive.server.Config
Constructor for Bean Directory.
Config(String[], String) - Constructor for class org.locomotive.server.Config
Initializes a config object, with the specified arguments, from the specified file path.
ConfigInitializationException - exception org.locomotive.server.ConfigInitializationException.
this is thrown if a config value does not match its required constraints
ConfigInitializationException() - Constructor for class org.locomotive.server.ConfigInitializationException
 
ConfigInitializationException(String) - Constructor for class org.locomotive.server.ConfigInitializationException
 
ConfigNotFoundException - exception org.locomotive.server.ConfigNotFoundException.
Thrown if a config is requested but does not exist in the config object.
conn - Variable in class org.locomotive.loco.servlet.LocoServlet
The database connection this request can use, if desired.
conn - Variable in class org.locomotive.loco.handler.GenericHandler
The database connection this request can use, if desired.
conn - Variable in class org.locomotive.loco.handler.HandlerData
A JDBC Connection, cleared, opened, connected, and associated with the Loco's database namespace.
conserve_memory - Variable in class org.locomotive.util.DoubleHashtable
 
CONSTANT_TYPE - Static variable in class org.locomotive.directory.BeanPropertyValue
Indicates that value of this property is constant, and computedValue can be used in future lookups.
contains(Object) - Method in class org.locomotive.util.SearchableVector
 
contains(Object) - Method in class org.locomotive.util.DoubleHashtable
traverses the ENTIRE Hashtable of Hashtables -- a very expensive operation! Don't do this if you can possibly avoid it!
contains(Object, Object) - Method in class org.locomotive.util.DoubleHashtable
 
contains(String, Object) - Method in class org.locomotive.util.cache.DBCache
Tells whether an Object is in the DBCache.
containsAll(String[]) - Method in class org.locomotive.loco.FormData
tells whether the form contains values for all of the fields mentioned.
containsAllNonEmpty(String[]) - Method in class org.locomotive.loco.FormData
tells whether the form contains non-empty values for all of the fields mentioned.
containsChildTableKey(Object) - Method in class org.locomotive.util.DoubleHashtable
 
containsHeader(String) - Method in class org.locomotive.loco.Response
Returns true if a header with the specified name has been set.
containsHeader(String) - Method in class org.locomotive.loco.HTTPResponse
Returns true if a header with the specified name has been set.
containsService(String) - Method in class org.locomotive.server.ServiceRoutingTable
Returns true if there is a service associated with this pattern
containsUser(String) - Method in class org.locomotive.loco.perm.Group
Checks for the existence of a user within this group.
content_type - Variable in class org.locomotive.loco.Response
 
convertProperty(Object) - Method in class org.locomotive.directory.StringConverter
 
convertProperty(Object) - Method in class org.locomotive.directory.IntegerConverter
 
convertProperty(Object) - Method in interface org.locomotive.directory.PropertyConverter
Convert an object of one class to an object to another class.
convertToGroupId(String, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Converts a group name into a group id.
convertToGroupIds(Vector, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Converts a Vector of group names into a Vector of group ids.
convertToGroupName(int, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Converts a group id into a group name.
convertToGroupNames(Vector, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Converts a Vector of group ids into a Vector of group names.
copyAllIntoSteam(Hashtable) - Method in class org.locomotive.loco.FormData
copies the values of all fields in this form to the Hashtable containing all the Steam variables, so that you can use the Steam variables to put in default values for the form fields in the HTML template.
count - Variable in class org.locomotive.util.data.DataTree
 
createBeanInstance(BeanConfiguration) - Method in class org.locomotive.directory.BeanInstantiator
Created an instance of a component.
createBStampStore() - Static method in class org.locomotive.loco.store.StoreFactory
 
createDBConnectionPool(LocoConfig) - Static method in class org.locomotive.loco.Loco
creates the main Locomotive Database connection pool.
createNewObject() - Method in class org.locomotive.util.ObjectPool
This is called internally whenever a new object is created and added to the pool.
createNewObject() - Method in class org.locomotive.loco.servlet.ServletPool
ServletPool does not need an implementation of this method, since the ServletFactory creates them for ServletPool and hands them over when they're ready to serve.
createNewObject() - Method in class org.locomotive.server.DBConnectionPool
creates a new database connection
createNewSession(Connection, int, int, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStore
Saves a new Session and returns its sid
createNewSession(Connection, int, int, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbc
 
createNewSession(Connection, int, int, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcSolid
 
createNewSession(Connection, int, int, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcCloudscape
 
createNewSession(Connection, int, int, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcInterbase
 
createNewSession(Connection, int, int, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcMysql
 
createNewSession(Connection, int, int, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcInformix
 
createNewSession(Connection, int, int, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcOracle
 
createNewSession(Connection, int, int, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcPostgresql
 
createPermission(Connection, String) - Static method in class org.locomotive.loco.perm.Permission
Creates a new permission and puts it in the cache.
createServiceEntry(String, String, String) - Method in class org.locomotive.loco.servlet.ServletRoutingTable
Adds the a ServletEntry to the service_tokens_hash or the service_extensions_hash.
createServiceEntry(String, String, String) - Method in class org.locomotive.server.ServiceRoutingTable
Override this to return the ServiceEntry class you need.
createServiceEntry(String, String, String) - Method in class org.locomotive.loco.handler.HandlerRoutingTable
Adds the a HandlerEntry to the service_hash.
createSession(Connection, int, int, Timestamp) - Static method in class org.locomotive.loco.Cloudscape
use this to create a new session.
createSessionStore() - Static method in class org.locomotive.loco.store.StoreFactory
 
createUser(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStore
Persistantly stores User's data.
createUser(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
Persistantly stores User's data.
createUser(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcMysql
Persistantly stores User's data.
createUser(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcOracle
Persistantly stores User's data.
createUser(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInterbase
Persistantly stores User's data.
createUser(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcPostgresql
Persistantly stores User's data.
createUser(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcSolid
Persistantly stores User's data.
createUser(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcCloudscape
Persistantly stores User's data.
createUser(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInformix
Persistantly stores User's data.
createUser(Connection, String, String, int) - Static method in class org.locomotive.loco.Cloudscape
use this to create a new user.
createUserStore() - Static method in class org.locomotive.loco.store.StoreFactory
 
CRITICAL_ERROR - Static variable in class org.locomotive.server.Log
Critical Error- Handler severely disabled.
cur_pool_size - Variable in class org.locomotive.loco.servlet.ServletFactory
This member variable stores the current number of servlets that this ServletFactory's primary listener currently has.
current_open - Variable in class org.locomotive.util.ObjectPool
 
cursorpos - Variable in class org.locomotive.util.GrowableChar
 

D

DataTree - class org.locomotive.util.data.DataTree.
this class is an abstract implementation of a data tree, and can be extended to for heaps or binary search trees.
DataTree.TreeNode - class org.locomotive.util.data.DataTree.TreeNode.
a node for a binary search tree
DataTree.TreeNode(DataTree, ComparisonKey) - Constructor for class org.locomotive.util.data.DataTree.TreeNode
Constructor for Nodes with keys as data
DataTree.TreeNode(DataTree, ComparisonKey, Object) - Constructor for class org.locomotive.util.data.DataTree.TreeNode
Constructor takes a key and it's corresponding data
DataTree() - Constructor for class org.locomotive.util.data.DataTree
construct an empty tree sets number of items in the tree to zero
DataTree(ComparisonKey) - Constructor for class org.locomotive.util.data.DataTree
constructs a tree with the comparisonKey as the key and the data for the root node.
DataTree(ComparisonKey, Object) - Constructor for class org.locomotive.util.data.DataTree
constructs a new tree with a key and it's data as the root
DataTree(DataTree.TreeNode) - Constructor for class org.locomotive.util.data.DataTree
create a tree with the node as it's root
date - Variable in class org.locomotive.util.data.DateKey
 
DATE - Static variable in class org.locomotive.util.SortableTable
used to denote a Date comparison for sorting
DATE - Static variable in class org.locomotive.module.discuss.DiscussionLib
used by the getPostSummaries method specify sorting
dateFormat - Static variable in class org.locomotive.loco.StandardInsertions
 
DateKey - class org.locomotive.util.data.DateKey.
this class provides a comparison key for dates with times.
DateKey(Date) - Constructor for class org.locomotive.util.data.DateKey
Constructor creates a new DateKey from a date
DB_TYPE - Static variable in class org.locomotive.loco.LocoConfig
Holds the database type.
DB_TYPE - Static variable in class org.locomotive.loco.perm.Permission
 
DB_TYPE_CLOUDSCAPE - Static variable in class org.locomotive.util.SQL
 
DB_TYPE_INFORMIX - Static variable in class org.locomotive.util.SQL
 
DB_TYPE_INTERBASE - Static variable in class org.locomotive.util.SQL
 
DB_TYPE_MYSQL - Static variable in class org.locomotive.util.SQL
 
DB_TYPE_ORACLE - Static variable in class org.locomotive.util.SQL
 
DB_TYPE_POSTGRESQL - Static variable in class org.locomotive.util.SQL
 
DB_TYPE_SOLID - Static variable in class org.locomotive.util.SQL
 
DBCache - class org.locomotive.util.cache.DBCache.
 
DBCache() - Constructor for class org.locomotive.util.cache.DBCache
Default constructor for the database cache.
DBCache(Config, DBConnectionPool) - Constructor for class org.locomotive.util.cache.DBCache
Construct a database cache reading default values from a LocoConfig and with a specific connection pool.
DBCache(Config, DBConnectionPool, Log) - Constructor for class org.locomotive.util.cache.DBCache
Construct a database cache reading default values from a Config and with a specific connection pool.
DBConnectionPool - class org.locomotive.server.DBConnectionPool.
Manages a pool of JDBC connections.
DBConnectionPool() - Constructor for class org.locomotive.server.DBConnectionPool
Default constructor for the connection pool.
DBConnectionPool(String, String, String, String, int, int, Log) - Constructor for class org.locomotive.server.DBConnectionPool
creates a new pool, and fills it with the specified minumum number of database connections.
DEBUG - Static variable in class org.locomotive.loco.servlet.LocoServlet
log level to use for debugging
DEBUG - Static variable in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Log level to use for debugging
DEBUG - Static variable in interface org.locomotive.directory.DirectoryEventTypes
Debug information.
DEBUG - Static variable in class org.locomotive.server.Log
Debug information.
DEBUG - Static variable in class org.locomotive.loco.handler.GenericHandler
log level to use for debugging
DEBUG_REALLY_VERBOSE - Static variable in class org.locomotive.server.Log
All debug information, including internal Locomotive state logging.
DEBUG_VERBOSE - Static variable in class org.locomotive.server.Log
More Debug information, including the CGI environment for each request.
decodeStrings(String) - Static method in class org.locomotive.util.StringUtil
Takes a string that represents a list of strings and parses them out.
default_wait_retries - Static variable in class org.locomotive.loco.servlet.ServletFactory
The default number of retries that ServletFactories will attempt when trying to instantiate and initialize servlets of any given class.
default_waiting_period - Static variable in class org.locomotive.loco.servlet.ServletFactory
This is the default waiting period that ServletFactories will wait before continuing to instantiate, initialize, and offer new servlet instances after a servlet throws a ServletException while the servlet is either being instantiated or initialized.
DefaultHandler - class org.locomotive.loco.handler.DefaultHandler.
A sample default handler.
DefaultHandler() - Constructor for class org.locomotive.loco.handler.DefaultHandler
 
DefaultServlet - class org.locomotive.loco.servlet.DefaultServlet.
A very basic servlet....
DefaultServlet() - Constructor for class org.locomotive.loco.servlet.DefaultServlet
 
delete(Connection) - Method in interface org.locomotive.util.cache.RelationalObject
The GlobalDBCache calls this method to delete your object from the database.
deleteDeadDiscussions(Connection) - Method in class org.locomotive.module.discuss.DiscussionLib
Get rid of the 'DEAD' discussions.
deleteDeadPosts(Connection) - Method in class org.locomotive.module.discuss.DiscussionLib
Get rid of the 'DEAD' posts.
deleteDeadTopics(Connection) - Method in class org.locomotive.module.discuss.DiscussionLib
Get rid of the 'DEAD' topics.
deletePermission(Connection, String) - Static method in class org.locomotive.loco.perm.Permission
deletes the permission with the specified name from the database
deletePermissions(int[], Connection) - Static method in class org.locomotive.loco.perm.UserPerm
Deletes many users' permissions from the database.
deletePermissions(int, Connection) - Static method in class org.locomotive.loco.perm.UserPerm
Deletes a user's permissions in the database.
deleteSerializedObjectFromDB(String, Object) - Method in class org.locomotive.util.cache.DBCache
This method deletes an object from the database, but NOT from the cache.
DESCENDING - Static variable in class org.locomotive.util.SortableTable
used to denote a descending sort
destroy() - Method in class org.locomotive.module.discuss.DiscussionServlet
Makes sure the Admin servlet gets destroyed too.
destroyObject(Object) - Method in class org.locomotive.util.ObjectPool
This should be overridden in sub classes to clean up any of an object's resources before the object get's removed from the pool.
destroyObject(Object) - Method in class org.locomotive.loco.servlet.ServletPool
Calls destroy()
destroyObject(Object) - Method in class org.locomotive.server.DBConnectionPool
calls connection.close() on the object.
DirectoryContext - class org.locomotive.directory.DirectoryContext.
A directory context is a path in the configuration structure, e.g.
DirectoryEvent - class org.locomotive.directory.DirectoryEvent.
All events that occurs when using the bean directory will generate this event.
directoryEvent(DirectoryEvent) - Method in class org.locomotive.directory.loco.BeanDirectory
 
directoryEvent(DirectoryEvent) - Method in interface org.locomotive.directory.DirectoryEventListener
Called when an event occurs in the bean directory.
DirectoryEvent(int, Object, String) - Constructor for class org.locomotive.directory.DirectoryEvent
Constructor for the DirectoryEvent.
DirectoryEvent(int, Object, String, BeanConfiguration) - Constructor for class org.locomotive.directory.DirectoryEvent
Constructor for the DirectoryEvent.
DirectoryEvent(int, Object, String, BeanConfiguration, BeanProperty) - Constructor for class org.locomotive.directory.DirectoryEvent
Constructor for the DirectoryEvent.
DirectoryEvent(int, Object, String, BeanConfiguration, BeanProperty, Throwable) - Constructor for class org.locomotive.directory.DirectoryEvent
Constructor for the DirectoryEvent.
DirectoryEventListener - interface org.locomotive.directory.DirectoryEventListener.
Listener interface for events in the bean directory.
DirectoryEventTypes - interface org.locomotive.directory.DirectoryEventTypes.
This interface defines a set of constants defining the different types of DirectoryEvents thrown by the bean directory.
DiscussionAdminHandler - class org.locomotive.module.discuss.DiscussionAdminHandler.
This class handles the administration for the communities.
DiscussionAdminHandler() - Constructor for class org.locomotive.module.discuss.DiscussionAdminHandler
 
DiscussionAdminServlet - class org.locomotive.module.discuss.DiscussionAdminServlet.
This class handles the administration for the communities.
DiscussionAdminServlet() - Constructor for class org.locomotive.module.discuss.DiscussionAdminServlet
 
DiscussionHandler - class org.locomotive.module.discuss.DiscussionHandler.
This class is the main handler class for The Locomotive Discussion system.
DiscussionHandler() - Constructor for class org.locomotive.module.discuss.DiscussionHandler
 
DiscussionLib - class org.locomotive.module.discuss.DiscussionLib.
This class provides a series of static methods which return Database information used by the Locomotive Discussion system.
DiscussionLib(Connection) - Constructor for class org.locomotive.module.discuss.DiscussionLib
Initializes a DiscussionLib instance, with the correct database type.
DiscussionServlet - class org.locomotive.module.discuss.DiscussionServlet.
This class is the main handler class for The Locomotive Discussion system.
DiscussionServlet() - Constructor for class org.locomotive.module.discuss.DiscussionServlet
 
dispatchErrorEvent(Object, String, BeanConfiguration, BeanProperty, Throwable) - Method in class org.locomotive.directory.NameService
Convenience method for creating and dispatching an event event.
dispatchEvent(DirectoryEvent) - Method in class org.locomotive.directory.NameService
Dispatch a DirectoryEvent to event listeners.
dispatchEvent(int, Object, String, BeanConfiguration, BeanProperty, Throwable) - Method in class org.locomotive.directory.NameService
Convenience method for creating and dispatching an event event.
displayPage(String, Hashtable) - Method in class org.locomotive.loco.servlet.LocoServlet
loads a Steam document, inserts the values of Steam variables into that document, and then writes the result back to the Web server.
displayPage(String, Hashtable) - Method in class org.locomotive.loco.handler.GenericHandler
loads a Steam document, inserts the values of Steam variables into that document, and then writes the result back to the Web server.
displayPage(String, Hashtable, HttpServletResponse) - Method in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Loads a Steam document, inserts the values of Steam variables into that document, and then writes the result back to the Web server.
DisplayPageHandler - class org.locomotive.module.display.DisplayPageHandler.
DisplayPageHandler can be used to map a url into the path of a HTML template file in the file system.
DisplayPageHandler() - Constructor for class org.locomotive.module.display.DisplayPageHandler
 
DisplayPageServlet - class org.locomotive.module.display.DisplayPageServlet.
DisplayPageServlet can be used to map a url into the path of a HTML template file in the file system.
DisplayPageServlet() - Constructor for class org.locomotive.module.display.DisplayPageServlet
 
displayString(String) - Method in class org.locomotive.loco.servlet.LocoServlet
if you want to send back a single string as the response to the user, you can use this method.
displayString(String) - Method in class org.locomotive.loco.handler.GenericHandler
if you want to send back a single string as the response to the user, you can use this method.
displayString(String, HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.MultiThreadedHttpServlet
If you want to send back a single string as the response to the user, you can use this method.
disposeDBConnection(Connection) - Static method in class org.locomotive.loco.Loco
throws away a Connection that has been corrupted, for example, by a SQLException, so that it will be deleted from the DBConnection Pool.
doConfigDump() - Method in class org.locomotive.server.Config
prints all the configs and their present values, along with their description, to standard out.
doDelete(Connection, String) - Method in class org.locomotive.util.SortableTable
Deletes all the Rows in the SortableTable.
doDelete(Connection, String, String[]) - Method in class org.locomotive.util.SortableTable
deletes all the rows in the sortableTable from the named table.
DOESNT_FIT_TYPE - Static variable in class org.locomotive.util.ParseStringException
 
DOESNT_FIT_TYPE - Static variable in class org.locomotive.loco.FormData
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.userpref.UserMgtServlet
entry point from UserPrefServlet.java - main logic of servlet This servlet accepts the following URLS:
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.userpref.UserPrefServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.userpref.PersonalPrefServlet
determines whether hit requires handling new data, then displays the page
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.graffiti.GraffitiWallServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.loco.servlet.UnknownServlet
Required to use locoServlet fields public void service (HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { super.service(req, resp); } /** this is the entry point for the server.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.loco.servlet.UnavailableServlet
This method is run for each request to this servlet.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.MultiThreadedHang
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.PermanentlyUnavailable1
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.PermanentlyUnavailable2
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.PermanentlyUnavailable3
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.PermanentlyUnavailable4
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.SingleThreadedHang
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.TemporarilyUnavailable1
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.TemporarilyUnavailable2
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.TemporarilyUnavailable3
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.TemporarilyUnavailable4
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.codegen.CodeGeneratorServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.loco.ServerServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.loco.perm.PermServlet
This is the entry point for the server upon receipt of a new request.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.base.LogoutServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.base.LoginServlet
A GET simply shows the login page.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.base.BaseServlet
just send off our various requests
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.base.RegistrationServlet
BaseServlet will forward to this Servlet if the url_tokens are "/base?reg"
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.steam.SteamServlet
Send the requested page to the client, using the rules specified in the class documentation above.
doInsert(Connection, String) - Method in class org.locomotive.util.SortableTable
Inserts each row of the SortableTable into a table in the database.
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.userpref.UserMgtServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.userpref.UserPrefServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.userpref.PersonalPrefServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.graffiti.GraffitiWallServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.loco.servlet.UnknownServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.loco.servlet.UnavailableServlet
This method just calls doGet(request, response).
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.MultiThreadedHang
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.PermanentlyUnavailable1
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.PermanentlyUnavailable2
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.PermanentlyUnavailable3
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.PermanentlyUnavailable4
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.SingleThreadedHang
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.TemporarilyUnavailable1
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.TemporarilyUnavailable2
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.TemporarilyUnavailable3
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.test.TemporarilyUnavailable4
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.codegen.CodeGeneratorServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.base.LoginServlet
Takes the username and password entered from the HTML form and tries to log the user in.
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.base.BaseServlet
send off the various posts
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.base.RegistrationServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.steam.SteamServlet
forwards the request to toGet()
DoubleHashtable - class org.locomotive.util.DoubleHashtable.
DoubleHashtable is a hashtable of hashtables, where you use the first key to find a hashtable, and then use the second key to search within that hashtable to find your item.
DoubleHashtable() - Constructor for class org.locomotive.util.DoubleHashtable
Default constructor sets up the DoubleHashtable with the conserve memory property set to false.
DoubleHashtable(boolean) - Constructor for class org.locomotive.util.DoubleHashtable
If you want to conserve memory usage, and you know that your child Hashtables are temporary, then you should set conserve_memory to true in order to make this class throw away empty child Hashtables once in a while.
doUpdate(Connection, String, String[]) - Method in class org.locomotive.util.SortableTable
Updates a table in the database based on the information in the SortableTable.

E

elements() - Method in class org.locomotive.util.SortableTable
Returns an enumeration of all the objects in the table.
elements() - Method in class org.locomotive.util.data.Heap
creates an enumeration of the heap
email - Variable in class org.locomotive.module.userpref.UserPref
 
EMAIL - Static variable in class org.locomotive.server.MultiConfig
 
encodeRedirectUrl(String) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Deprecated. in favor of encodeRedirectURL
encodeRedirectURL(String) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Encodes a url for use by the sendRedirect method.
encodeString(String) - Static method in class org.locomotive.util.StringUtil
Take a string and replace all the "'s with \"'s and the \'s with \\'s and surrounds the string with "'s which is necessary for a concatenated list of strings to be sucessfully decoded.
encodeStrings(Enumeration) - Static method in class org.locomotive.util.StringUtil
encode strings with the default seperator ", "...
encodeStrings(Enumeration, String) - Static method in class org.locomotive.util.StringUtil
Take an enumeration of strings and make a big string of encoded strings.
encodeStrings(Vector) - Static method in class org.locomotive.util.StringUtil
encode strings with the default seperator ", "...
encodeStrings(Vector, String) - Static method in class org.locomotive.util.StringUtil
Take a vector of strings and make a big string of encoded strings.
encodeStringsEfficiently(Enumeration) - Static method in class org.locomotive.util.StringUtil
encode strings with no seperator (saves some space.) Same thing as encodeStrings(s, "") (call that for even more efficiency :-) ) This will decode just fine.
encodeStringsEfficiently(Vector) - Static method in class org.locomotive.util.StringUtil
encode strings with no seperator (saves some space.) Same thing as encodeStrings(s, "") (call that for even more efficiency :-) ) This will decode just fine.
encodeUrl(String) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Deprecated. in favor of encodeURL
encodeURL(String) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Encodes a url with any information necessary for session persistence.
enforceConfigTypes() - Method in class org.locomotive.server.MultiConfig
Override this function to simply return true or false.
entryExists(Connection, String) - Static method in class org.locomotive.module.userpref.UserPref
returns true if an entry already exists in loco_user_prefs for usrId.
equals(Object) - Method in class org.locomotive.loco.User
overrides Object.equals for User specific checking
ERROR - Static variable in class org.locomotive.loco.servlet.LocoServlet
Log level to use for serious errors; e.g.
ERROR - Static variable in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Log level to use for serious errors; e.g.
ERROR - Static variable in interface org.locomotive.directory.DirectoryEventTypes
Error.
ERROR - Static variable in class org.locomotive.server.Log
Error.
ERROR - Static variable in class org.locomotive.loco.handler.GenericHandler
Log level to use for serious errors; e.g.
errorCode() - Method in class org.locomotive.util.ParseStringException
 
evalString(String, Hashtable, boolean) - Method in class org.locomotive.steam.CachedPageLoader
Evaluate the following string.
evalTemplate(String, Hashtable) - Method in class org.locomotive.steam.CachedPageLoader
Evaluate the given filename, relative to the given template root with the given substitution environment.
evaluateTemplate(String, Hashtable) - Static method in class org.locomotive.loco.Loco
Evalute a template.
event_log - Variable in class org.locomotive.loco.handler.HandlerData
a org.locomotive.server.Log referencing the Loco event log.
event_timestamp - Variable in class org.locomotive.loco.servlet.ServletFactoryEvent
The date/timestamp of when this event occurred.
exceptionStackTrace(Throwable) - Static method in class org.locomotive.util.StringUtil
A utility function - given the exception, give us a string that contains the stack trace for it.
exceptionStackTrace(Throwable) - Static method in class org.locomotive.servlets.MultiThreadedHttpServlet
A utility function - given the exception, give us a string that contains the stack trace for it.
exists(Connection, int) - Static method in class org.locomotive.loco.User
returns true if a user with this userid exists in the user database
exists(Connection, int) - Method in class org.locomotive.loco.store.user.UserStore
returns true if a user with this userid exists in the user database
exists(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
returns true if a user with this userid exists in the user database
exists(Connection, String) - Static method in class org.locomotive.loco.User
returns true if a user in the user database has the same name
exists(Connection, String) - Method in class org.locomotive.loco.store.user.UserStore
returns true if a user in the user database has the same name
exists(Connection, String) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
returns true if a user in the user database has the same name
exists(int, Connection) - Static method in class org.locomotive.loco.perm.ACLManager
Checks the existence of an ACL in the database.
exists(String) - Static method in class org.locomotive.loco.perm.Permission
Checks the existence of a permission in the cache.
exists(String) - Static method in class org.locomotive.loco.perm.PermissionSet
Deprecated. in favor of Permission.exists()
exists(String, Connection) - Static method in class org.locomotive.loco.perm.RoleManager
Verifies that a role exists in the DB.
exists(String, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Verifies that a group exists in the DB.
existsAnyCase(Connection, String) - Static method in class org.locomotive.loco.User
returns true if a user in the user database has the same name, regardless of case.
existsAnyCase(Connection, String) - Method in class org.locomotive.loco.store.user.UserStore
returns true if a user in the user database has the same name, regardless of case.
existsAnyCase(Connection, String) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
returns true if a user in the user database has the same name, regardless of case.
existsAnyCase(Connection, String) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInterbase
returns true if a user in the user database has the same name, regardless of case.
existsAnyCase(Connection, String) - Method in class org.locomotive.loco.store.user.UserStoreJdbcCloudscape
returns true if a user in the user database has the same name, regardless of case.
existsAnyCase(Connection, String) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInformix
returns true if a user in the user database has the same name, regardless of case.
existsInDB() - Method in interface org.locomotive.util.cache.RelationalObject
returns the value of the flag which tells whether this object already exists in the DB or not.
expire(Connection) - Method in class org.locomotive.loco.Session
expires this session, in both the object and the database returns false if the operation failed
expire(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStore
expires this session, in the database returns false if the operation failed
expire(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbc
 
expire(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcInterbase
 
expire(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcMysql
 
expire(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcOracle
 
expire(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcPostgresql
 
ExpressionSearch - class org.locomotive.util.ExpressionSearch.
A class for matching string A against string B, where one of the strings may have one or more wildcard characters (which are dots, '.') which can match any single character.
ExpressionSearch(String) - Constructor for class org.locomotive.util.ExpressionSearch
Create a new expression search object that will search for the input String
ExpressionSearch(String[]) - Constructor for class org.locomotive.util.ExpressionSearch
Creates a new expression search object.

F

FailedSessionException - exception org.locomotive.loco.FailedSessionException.
This is thrown when a session either cannot be created or cannot be accessed.
FailedSessionException(String) - Constructor for class org.locomotive.loco.FailedSessionException
 
FATAL_ERROR - Static variable in class org.locomotive.server.Log
Fatal error- Handler cannot continue.
FIFO - class org.locomotive.util.FIFO.
A FIFO is essentially a variable length list.
FIFO() - Constructor for class org.locomotive.util.FIFO
create a new empty FIFO with max size of 8.
FIFO(int) - Constructor for class org.locomotive.util.FIFO
create a new FIFO, with the specified max size.
fileRename(File, File) - Static method in class org.locomotive.module.pub.PublisherServlet
This method is a workaround because the renameTo doesn't work on NFS mounted file systems I'd still consider it a bug -- a Java application or servlet has no idea whether a given path is a "single filesystem" or is NFS-mounted.
finalize() - Method in class org.locomotive.commerce.ics.SCMPMessage
When the SCMPMessages are unreferenced, the garbage collector eventually comes along to free the memory.
find(ComparisonKey) - Method in class org.locomotive.util.data.DataTree
finds the object node containing the object with the specified key and returns it.
find(ComparisonKey) - Method in class org.locomotive.util.data.Heap
Search for an object (obj) in the heap such that obj.equals(key) is true.
finished - Variable in class org.locomotive.loco.servlet.ServletFactory
This ServletFactory Thread will keep looping (running) as long as nothing has called our shutdown() method.
fireServletFactoryEvent(ServletFactoryEvent) - Method in class org.locomotive.loco.servlet.ServletFactory
Broadcasts the specified ServletFactoryEvent to all of the known ServletFactoryListener Objects.
firstName - Variable in class org.locomotive.util.data.NameKey
 
flush() - Method in class org.locomotive.loco.Response
Flushes the contents of the Response with no logging.
flush() - Method in class org.locomotive.loco.Response.ResponseOutputStream
 
flush(Log) - Method in class org.locomotive.loco.Response
flushes the contents of the response to the OutputStream.
flush(Log) - Method in class org.locomotive.loco.Response.ResponseOutputStream
 
fName - Variable in class org.locomotive.module.userpref.UserPref
 
forint - Variable in class org.locomotive.server.Config
a constraint for use in the addConfig method which will check to make sure the value of the config is not empty or null, and is an integer
form_data - Variable in class org.locomotive.loco.servlet.LocoServlet
the FormData object that contains any form information from a POST.
form_data - Variable in class org.locomotive.loco.handler.GenericHandler
the FormData object that contains any form information from a POST.
form_data - Variable in class org.locomotive.loco.handler.HandlerData
A convenient class which allows you to access and error-check the data in an HTML form that a user submits.
form_hash - Variable in class org.locomotive.loco.handler.HandlerData
A hash of HTML form input variables.
formatDateColumn(int, String) - Method in class org.locomotive.util.SortableTable
change an entire column of timestamps to a column of strings containing formatted dates.
formatUserPrefsToSteam(UserPref, Hashtable) - Static method in class org.locomotive.module.userpref.PersonalPrefServlet
 
formatUserPrefsToSteam(UserPref, Hashtable) - Static method in class org.locomotive.module.userpref.PersonalPrefHandler
 
FormData - class org.locomotive.loco.FormData.
FormData combines the features of a Hashtable with a string-checker and a StringBuffer into one powerful class.
FormData(Hashtable) - Constructor for class org.locomotive.loco.FormData
create a new FormData object, and initialize it with the values of the fields from the Hashtable, form_hash.
FormParser - class org.locomotive.server.FormParser.
This class takes care of parsing out forms HTTP forms.
FormParser(InputStream, Hashtable, LocoConfig, Log) - Constructor for class org.locomotive.server.FormParser
instantiates the parser.
forstring - Variable in class org.locomotive.server.Config
a constraint for use in the addConfig method which will check to make sure the value of the config is neither empty nor null.
forward(ServletRequest, ServletResponse) - Method in class org.locomotive.loco.servlet.LocoRequestDispatcher
This will reset the necessary variables in request, then forward the existing request to another service.
freeNumber(int) - Method in class org.locomotive.util.LowNumberKeeper
Returns the number back to the pool so that others may use it.

G

generateCookieString() - Method in class org.locomotive.loco.Session
returns a string suitable for usage in a HTTP cookie naming of the cookie is handled externally
generateForward() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Will create a HandlerData object with this Request's fields.
generateInclude() - Method in class org.locomotive.loco.servlet.LocoServletResponse
Generates a crippled version of this response which will not allow headers to be set.
generateNewPassword(int) - Static method in class org.locomotive.loco.User
Generates a character sequence of length 8 suitable for a password (though probably not easy to remember)
genericGetInteger(String) - Method in class org.locomotive.server.Config
 
genericGetString(String) - Method in class org.locomotive.server.Config
 
GenericHandler - class org.locomotive.loco.handler.GenericHandler.
The GenericHandler class is a generic implementation of the Handler interface.
GenericHandler() - Constructor for class org.locomotive.loco.handler.GenericHandler
 
genericSet(String, String) - Method in class org.locomotive.server.Config
 
genericSetInteger(String, Integer) - Method in class org.locomotive.server.Config
 
genericSetString(String, String) - Method in class org.locomotive.server.Config
 
get(int, int) - Method in class org.locomotive.util.SortableTable
returns the object stored at the given indexes.
get(int, String) - Method in class org.locomotive.util.SortableTable
returns the object stored at the given indexes.
get(Object, Object) - Method in class org.locomotive.util.DoubleHashtable
 
get(String) - Static method in class org.locomotive.loco.perm.Permission
Retrieves a permission from the permissions cache.
get(String) - Static method in class org.locomotive.loco.perm.PermissionSet
Deprecated. in favor of Permission.get()
get(String, int) - Method in class org.locomotive.util.cache.DBCache
"convenience" get() method using an int key:
get(String, long) - Method in class org.locomotive.util.cache.DBCache
"convenience" get() method using a long key:
get(String, Object) - Method in class org.locomotive.util.cache.DBCache
This method retrieves an object from the cache.
getAccessLog() - Method in class org.locomotive.loco.HTTPServer
gets the reference to the access log of this HTTPServer instance
getACL(int, Connection) - Static method in class org.locomotive.loco.perm.ACLManager
Retrieves an ACL from the database.
getActive() - Method in class org.locomotive.loco.store.session.LocoSessionRow
 
getActiveCount() - Method in class org.locomotive.server.ThreadPoolManager
 
getActiveThreadCount() - Method in class org.locomotive.loco.HTTPServer
Returns the number of active RequestManager Threads.
getActiveThreadCount() - Static method in class org.locomotive.loco.Loco
Returns the number of active RequestManager Threads.
getAdded() - Method in class org.locomotive.loco.store.session.LocoSessionRow
 
getAllChildTableKeys() - Method in class org.locomotive.util.DoubleHashtable
 
getAllElements() - Method in class org.locomotive.util.DoubleHashtable
This is a VERY expensive operation -- it traverses the entire table.
getAlphanum(String) - Static method in class org.locomotive.util.StringUtil
trims string_containing_alphanum and returns a string containing only alphanumerics.
getAlphanum(String, int, int, boolean) - Static method in class org.locomotive.util.StringUtil
if this field contains non-alphanumerics, then they will be removed.
getAlphanum(String, String, int, int, boolean) - Method in class org.locomotive.loco.FormData
if this field contains non_alphanumerics, then they will be removed.
getAnonymousUserid() - Method in class org.locomotive.loco.User
gets the userid of the Anonymous User
getAnonymousUsername() - Method in class org.locomotive.loco.User
gets the username of the Anonymous User
getArrayOfElements() - Method in class org.locomotive.util.SearchableVector
 
getAttribute(String) - Method in class org.locomotive.loco.servlet.LocoServletRequest
returns the attribute with the specified name, if any.
getAttribute(String) - Method in class org.locomotive.loco.servlet.LocoServletContext
Returns the value of the named attribute of the network service, or null if the attribute does not exist.
getAttributeNames() - Method in class org.locomotive.loco.servlet.LocoServletRequest
returns an Enumeration of the names of all the attributes associated with this request.
getAttributeNames() - Method in class org.locomotive.loco.servlet.LocoServletContext
returns an enumeration of all the attribute names in the server.
getAttributes() - Method in class org.locomotive.loco.handler.HandlerData
Get the value of attributes.
getAuthor() - Method in class org.locomotive.module.graffiti.Tag
returns the author of the Tag
getAuthType() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the authentification type, if any.
getAutoSaveSleepInterval() - Method in class org.locomotive.util.cache.DBCache
 
getAutoSessionHandling() - Static method in class org.locomotive.loco.HTTPServer
returns the current value of the auto_session_handling flag.
getAutoSessionHandling() - Static method in class org.locomotive.loco.Loco
returns the current value of the auto_session_handling flag.
getAvailability() - Method in class org.locomotive.loco.servlet.ServletFactoryEvent
Returns the availability status for the class of servlets that are made by the ServletFactory that created this ServletFactoryEvent.
getAvailability() - Method in class org.locomotive.loco.servlet.ServletFactory
Returns the availability status of new, initialized instances of servlets whose Class is servlet_class.
getAvailability() - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
Returns the availability status of this ServiceEntry's service.
getBacklog() - Method in class org.locomotive.router.Router
Returns the maximum length of the queue of clients waiting at any given time.
getBeanConfig() - Method in class org.locomotive.directory.DirectoryEvent
If this event occured in the context of a particular bean configuration, this method will return it.
getBeanConfiguration(DirectoryContext, String) - Method in class org.locomotive.directory.NameService
Get the BeanConfiguration for a given component.
getBeanParser() - Method in class org.locomotive.directory.NameService
The parser to use when parsing bean configuration files.
getBeanProperties() - Method in class org.locomotive.directory.BeanConfiguration
Get all the properties defined for this bean.
getBeanProperty() - Method in class org.locomotive.directory.DirectoryEvent
If this event occured in the context of a particular bean property, this method will return it.
getBeanProperty(String) - Method in class org.locomotive.directory.BeanConfiguration
Get a bean property by name.
getBogusCommandMessage() - Static method in class org.locomotive.loco.ServerHandler
 
getCategoryInfo(Connection, int) - Method in class org.locomotive.module.discuss.DiscussionLib
retrieves a single category's information
getCategoryList(Connection, String) - Method in class org.locomotive.module.discuss.DiscussionLib
returns the list of categories available for the community
getCharacterEncoding() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the character encoding for the input body of the request, or null if none has been specified.
getCharacterEncoding() - Method in class org.locomotive.loco.Response
returns the character encoding, if it was included in the content type.
getCheckIntervalSeconds() - Method in class org.locomotive.directory.NameService
Get the check interval seconds property.
getChildTable(Object) - Method in class org.locomotive.util.DoubleHashtable
 
getClassName() - Method in class org.locomotive.directory.BeanConfiguration
Get the fully qualified classname for this bean configuration.
getClazz() - Method in class org.locomotive.directory.BeanConfiguration
Get class for this bean configuration.
getColumnIndex(String) - Method in class org.locomotive.util.SortableTable
returns the column index denoted by the specified column name.
getColumnName(int) - Method in class org.locomotive.util.SortableTable
returns the name of the columns at the specified column index.
getComponent(DirectoryContext, String) - Method in class org.locomotive.directory.ScopeStore
Get a specific component from this scope store.
getComputedValue() - Method in class org.locomotive.directory.BeanPropertyValue
Get the computed value for this property value.
getConfig() - Method in class org.locomotive.loco.HTTPServer
returns the HTTPServerConfig of the server
getConfig() - Static method in class org.locomotive.loco.Loco
returns the LocoConfig of the server
getConfigFilePath() - Method in class org.locomotive.server.Config
returns the path of the file the config is read in from.
getConfigFilePath() - Method in class org.locomotive.server.MultiConfig
Gives us the file path this config file was constructed with (null if it was actually constructed with string config data passed in...)
getConfigNamesEnumeration() - Method in class org.locomotive.server.Config
returns an enumeration of all the config names
getConfigNamesEnumeration() - Method in class org.locomotive.server.MultiConfig
Returns the enumeration of all the config entry names (i.e.
getConfigStringData() - Method in class org.locomotive.server.MultiConfig
Gives us the string config data given to the config object when it was created (null if it was actually created with a file path.)
getConnection() - Method in class org.locomotive.server.DBConnectionPool
gets a JDBC Connection object from the pool.
getConnection(HttpServletRequest) - Method in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Pass this method the ServletRequest Object, and it returns the Locomotive's database Connection for this request (if it is defined in the request attributes under the key "locomotive.connection").
getConnectionPool() - Method in class org.locomotive.util.cache.DBCache
Get the connection pool for this cache.
getContentLength() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the length of the input content, or -1 if not known
getContentType() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the content (MIME) type of the request body data, or null if not available.
getContext() - Method in class org.locomotive.directory.NameParse
Get the directory context part of this NameParse.
getContext() - Method in class org.locomotive.directory.DirectoryContext
 
getContext(String) - Method in class org.locomotive.loco.servlet.LocoServletContext
Returns the ServletContext for the specified uri.
getCookies() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns an array of Cookie objects that came in with this request.
getCounts() - Method in class org.locomotive.loco.servlet.ServletFactory
This method calls some ServletFactoryListener methods on our primary listener to find out the current values for the minimum number of servlets we should keep on hand, the maximum number of servlets we should keep on hand, and the current number of servlets that are in service.
getCreationTime() - Method in class org.locomotive.loco.Session
Returns the time in milliseconds, since 1/1/1970, when this session was created/
getCurPoolSize() - Method in class org.locomotive.loco.servlet.ServletFactory
Returns this ServletFactory's copy of the value of the primary ServletFactoryListener's current pool size.
getCurrentRequestID() - Method in class org.locomotive.loco.HTTPServer
gets the current value of the request id.
getCurrentRequestID() - Static method in class org.locomotive.loco.Loco
gets the current value of the request id.
getCurrentResponseLength() - Method in class org.locomotive.loco.Response
gets the current length of the data in the response buffer.
getCurrentServletCount() - Method in class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry
The ServletFactory calls this method when it needs to know how many servlets that the primary listener (like a ServletPool or a ServletRoutingTable) currently holds.
getCurrentServletCount() - Method in class org.locomotive.loco.servlet.ServletPool
The ServletFactory calls this method when it needs to know how many servlets that the primary listener (like a ServletPool or a ServletEntry) currently holds.
getCurrentServletCount() - Method in interface org.locomotive.loco.servlet.ServletFactoryListener
The ServletFactory calls this method when it needs to know how many servlets that the primary listener (like a ServletPool or a ServletEntry) currently holds.
getData() - Method in class org.locomotive.util.data.DataTree.TreeNode
access data
getDate(String) - Static method in class org.locomotive.util.StringUtil
tries to parse a field as a Date in one of the following formats: "MMM d, yyyy", "MM-d-yy", "MM-d-yyyy", "MM/d/yy", "MM/d/yyyy", "d.MM.yy", "d.MM.yyyy"
getDate(String, String) - Method in class org.locomotive.loco.FormData
tries to parse a field as a Date in one of the following formats: "MMM d, yyyy", "MM-d-yy", "MM-d-yyyy", "MM/d/yy", "MM/d/yyyy", "d.MM.yy", "d.MM.yyyy".
getDate(String, String, String) - Static method in class org.locomotive.util.StringUtil
tries to parse the three fields, month_field, day_field, and year_field, and create a Date out of them.
getDate(String, String, String, String) - Method in class org.locomotive.loco.FormData
tries to parse the three fields, month_field, day_field, and year_field, and create a Date out of them.
getDateHeader(String) - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the value of the requested header converted to a long representing a date expressed in milliseconds since January 1, 1970, 00:00:00GMT.
getDBConnection() - Static method in class org.locomotive.loco.Loco
Gets a Connection from the Request Manager's DBConnection Pool.
getDBType(Connection) - Static method in class org.locomotive.util.SQL
This will return one of this class's final static int DB_TYPES for the database connection supplied.
getDefaultAutoSaveInterval() - Method in class org.locomotive.util.cache.DBCache
 
getDefaultConfigTypes() - Method in class org.locomotive.server.MultiConfig
If the enforceConfigNames method you implement returns false, then when the parser encoutners a strange line it will use the types specified in this method as the default form of the line.
getDefaultExpirationTime() - Method in class org.locomotive.util.cache.DBCache
 
getDefaultLogLevel() - Static method in class org.locomotive.server.DBConnectionPool
 
getDigits(String) - Static method in class org.locomotive.util.StringUtil
trims string_containing_digits and returns a string containing only digits.
getDigits(String, int, int, boolean) - Static method in class org.locomotive.util.StringUtil
if this field contains non-digits, then the non-digits will be removed.
getDigits(String, String, int, int, boolean) - Method in class org.locomotive.loco.FormData
if this field contains non-digits, then the non-digits will be removed.
getDirectoryContext() - Method in class org.locomotive.directory.BeanConfiguration
Get the directory context for this configuration.
getDirectoryContext(DirectoryContext, String) - Static method in class org.locomotive.directory.DirectoryContext
 
getDirectoryContext(String) - Static method in class org.locomotive.directory.DirectoryContext
 
getDocumentRoot() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the web server's document root filesystem path that was sent in with the request.
getDownloadURLs() - Method in class org.locomotive.commerce.ics.ICSReply
Returns an array of URLS generated by Cybersource if the ICSRequest contained a request for the "ics_download" service.
getDriverClassName() - Method in class org.locomotive.server.DBConnectionPool
Get name of the driver class for this connection pool.
getElcRefNumbers() - Method in class org.locomotive.commerce.ics.ICSReply
Gets the reference numbers (elc_ref_nums) for offers when the ICS service "ics_elc" was requested in the Request.
getElementByKey(Object) - Method in class org.locomotive.util.SearchableVector
 
getElementsOfChildTable(Object) - Method in class org.locomotive.util.DoubleHashtable
 
getEmailAddress(String, String, int, int) - Method in class org.locomotive.loco.FormData
Will return the email address no matter what, even if it doesn't fit, but if there are errors, will give IS_NULL, IS_EMPTY, TOO_SHORT, TOO_LONG, and DOESNT_FIT_TYPE.
getEncodedString() - Method in class org.locomotive.commerce.ics.Offer
returns the string suitable for inclusion in an SCMPMessage.
getEnumOfElements() - Method in class org.locomotive.util.SearchableVector
 
getEventLog() - Method in class org.locomotive.loco.HTTPServer
gets the reference to the event log of this HTTPServer instance
getEventLog() - Static method in class org.locomotive.loco.Loco
gets the reference to the main server log of the Loco
getEventTimestamp() - Method in class org.locomotive.loco.servlet.ServletFactoryEvent
Gets the timestamp for when this event occurred, according to the object that created this ServletFactoryEvent.
getExpirationSleepInterval() - Method in class org.locomotive.util.cache.DBCache
 
getExpire() - Method in class org.locomotive.loco.store.session.LocoSessionRow
 
getExpiredMessage() - Static method in class org.locomotive.loco.ServerHandler
 
getField(String) - Method in class org.locomotive.loco.FormData
returns the value of the field named field_name.
getFieldCount() - Method in class org.locomotive.commerce.ics.SCMPMessage
Gets the field count.
getFormData(HttpServletRequest) - Method in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Pass this method the ServletRequest Object, and it returns the Locomotive's FormData for this request (if it is defined in the request attributes under the key "locomotive.form_data").
getFullName() - Method in class org.locomotive.directory.BeanConfiguration
Get the full name of this configuration.
getGlobalDBCache() - Static method in class org.locomotive.loco.Loco
Get the global DBCache for Loco.
getGroup(String, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Returns a group object from the database via its name.
getGroupNames(Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Returns an enumeration of all the group names in the database.
getGroups(String) - Method in class org.locomotive.loco.perm.AccessControlList
Returns a Vector of group names associated with a particular permission
getHandlerProperties(Handler) - Static method in class org.locomotive.loco.Loco
This will return the Properties object associated with a Handler, if there is any.
getHashtable() - Method in class org.locomotive.loco.FormData
returns the value of a Hashtable containing all fields in this form.
getHeader(String) - Method in class org.locomotive.loco.servlet.LocoServletRequest
Gets the value of the Header field with the requested name.
getHeaderCount() - Method in class org.locomotive.loco.Response
returns the number of items currently scheduled to be sent in the HTTP header
getHeaderCount() - Method in class org.locomotive.loco.HTTPResponse
returns the number of items currently scheduled to be sent in the HTTP header
getHeaderNames() - Method in class org.locomotive.loco.servlet.LocoServletRequest
This method returns an enumeration of String objects representing the header names for this request.
getId() - Method in class org.locomotive.loco.Session
returns the session id (sid) of the session
getId() - Method in class org.locomotive.loco.perm.Permission
Returns the id of the permission.
getId() - Method in class org.locomotive.loco.perm.Role
Returns the id of the role.
getId() - Method in class org.locomotive.loco.perm.AccessControlList
Returns the owner id of the ACL.
getId() - Method in class org.locomotive.loco.perm.Group
Returns the id of the group.
getID() - Method in class org.locomotive.loco.Session
returns the session id (sid) of the session
getIds() - Method in class org.locomotive.loco.servlet.ServletRoutingTable
Deprecated. for security reasons
getIndexTable(Connection, int, int, int) - Static method in class org.locomotive.module.pub.PublisherLib
Returns a table containing index information of published pages between the two ranges inclusive, beginning with most recent page.
getInitParameter(String) - Method in class org.locomotive.loco.servlet.LocoServletConfig
Returns the value of the init parameter specified by the name.
getInitParameterNames() - Method in class org.locomotive.loco.servlet.LocoServletConfig
Returns an enumeration of the names of all the initialization parameters.
getInputStream() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns a ServletInputStream for the request body data.
getInstance() - Static method in class org.locomotive.loco.store.id.LocoId
 
getInstance() - Static method in class org.locomotive.directory.loco.BeanDirectory
 
getInsTime() - Method in class org.locomotive.module.graffiti.Tag
returns the Date the Tag was created.
getInt(Connection, String) - Static method in class org.locomotive.util.SQL
executes a query (which should request a single number) and returns an int.
getInt(String) - Method in class org.locomotive.server.Config
returns the value of a config as an int, if possible
getInt(String) - Method in class org.locomotive.server.MultiConfig
Gets the first element of the array of integers that come from the config entry that matches the key (i.e.
getInt(String, String) - Method in class org.locomotive.loco.FormData
tries to read a field as an int.
getIntArray(String) - Method in class org.locomotive.server.MultiConfig
Returns the array of integer values for the config entry matching the supplied name (i.e.
getIntByIndex(String, int) - Method in class org.locomotive.server.MultiConfig
Gets the array of integers matching the key passed in in "name" and returns the value found at the index specified - will throw an exception if the index specified is invalid for this config entry or "name" is null or "" or if the config entry found is the null object.
getIntHeader(String) - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns an integer representation of the value of the header field with the specified name.
getIntWithinBounds(String, String, int, int) - Method in class org.locomotive.loco.FormData
tries to read a field as an int, bounded by a minimum and a maximum.
getKey() - Method in class org.locomotive.util.data.DataTree.TreeNode
Access key
getKey(Object) - Method in class org.locomotive.util.SearchableVector
This method is called to find the element in this SearchableVector.
getKeysOfChildTable(Object) - Method in class org.locomotive.util.DoubleHashtable
 
getLastAccessedTime() - Method in class org.locomotive.loco.Session
Returns the time in milliseconds since the last request assigned to this session
getLastAvailabilityEventTimestamp() - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
Gets the timestamp of the last availability event.
getLastReadTime() - Method in class org.locomotive.directory.BeanConfiguration
Get the time this configuration last was read from the file system.
getLeftChild() - Method in class org.locomotive.util.data.DataTree.TreeNode
 
getLoco_Flags() - Method in class org.locomotive.loco.store.user.LocoUserRow
 
getLocoFlags() - Method in class org.locomotive.loco.User
gets the value for this User's Loco-specific flags
getLocoInstId() - Method in class org.locomotive.loco.LocoConfig
 
getLocoPort() - Method in class org.locomotive.loco.LocoConfig
 
getLocoPortBacklog() - Method in class org.locomotive.loco.LocoConfig
 
getLocoServletRequest() - Method in class org.locomotive.loco.servlet.ServletRoutingTable
This method returns the LocoServletRequest for the current Thread
getLocoSessionRow(Connection, long) - Method in class org.locomotive.loco.store.session.SessionStore
Returns an individual session row if it can be found.
getLocoSessionRow(Connection, long) - Method in class org.locomotive.loco.store.session.SessionStoreJdbc
 
getLocoSessionRow(Connection, long) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcInterbase
 
getLocoTemplateRootPath() - Method in class org.locomotive.loco.LocoConfig
 
getLocoUploadPath() - Method in class org.locomotive.loco.LocoConfig
 
getLocoUrlHomepage() - Method in class org.locomotive.loco.LocoConfig
 
getLocoUrlMain() - Method in class org.locomotive.loco.LocoConfig
 
getLogDebug() - Method in class org.locomotive.directory.NameService
Control logging of debug messages for the bean directory.
getLogLevel() - Method in class org.locomotive.util.ObjectPool
Get the log level for this object pool.
getLogPath() - Method in class org.locomotive.server.Log
Get relative path to the log file.
getLong(Connection, String) - Static method in class org.locomotive.util.SQL
executes a query (which should request a single number) and returns a long.
getMajorVersion() - Method in class org.locomotive.loco.servlet.LocoServletContext
Returns the major version of the Servlet API this engine implements.
getMaxCount() - Method in class org.locomotive.server.ThreadPoolManager
 
getMaxEntries() - Method in class org.locomotive.util.cache.DBCache
 
getMaxExpirationTime() - Method in class org.locomotive.util.cache.DBCache
 
getMaxInactiveInterval() - Method in class org.locomotive.loco.Session
Returns the maximum amount of time the session can be inactive before it is expired, in seconds.
getMaxPooledThreads() - Method in class org.locomotive.router.Router
Returns the maximum number of threads used by the router.
getMaxPoolSize() - Method in class org.locomotive.loco.servlet.ServletFactory
Returns this ServletFactory's copy of the value of the primary ServletFactoryListener's maximum pool size.
getMaxServletCount() - Method in class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry
The ServletFactory calls this method when it needs to know the maximum number of servlets that the primary listener (like a ServletPool or a ServletRoutingTable) will hold..
getMaxServletCount() - Method in class org.locomotive.loco.servlet.ServletPool
The ServletFactory calls this method when it needs to know the maximum number of servlets that the primary listener (like a ServletPool or a ServletEntry) will hold..
getMaxServletCount() - Method in interface org.locomotive.loco.servlet.ServletFactoryListener
The ServletFactory calls this method when it needs to know the maximum number of servlets that the primary listener (like a ServletPool or a ServletEntry) will hold..
getMaxSize() - Method in class org.locomotive.util.ObjectPool
Get the maximum size of the object pool.
getMaxThreadPoolSize() - Method in class org.locomotive.loco.HTTPServer
Returns the number of active RequestManager Threads.
getMaxThreadPoolSize() - Static method in class org.locomotive.loco.Loco
Returns the number of active RequestManager Threads.
getMaxThreads() - Method in class org.locomotive.server.ThreadPoolManager
Get the maximum number of threads for this pool.
getMessage() - Method in class org.locomotive.directory.DirectoryEvent
Get a descriptive message of the event.
getMethod() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the HTTP method for this request.
getMimeType(String) - Method in class org.locomotive.loco.servlet.LocoServletContext
returns the mime type for a particular file.
getMinCount() - Method in class org.locomotive.server.ThreadPoolManager
 
getMinorVersion() - Method in class org.locomotive.loco.servlet.LocoServletContext
Returns the minor version of the Servlet API this engine implements.
getMinPooledThreads() - Method in class org.locomotive.router.Router
Returns the minimum number of threads used by the router.
getMinPoolSize() - Method in class org.locomotive.loco.servlet.ServletFactory
Returns this ServletFactory's copy of the value of the primary ServletFactoryListener's minimum pool size.
getMinServletCount() - Method in class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry
The ServletFactory calls this method when it needs to know how many servlets that the primary listener (like a ServletPool or a ServletRoutingTable) needs to keep active and ready to serve.
getMinServletCount() - Method in class org.locomotive.loco.servlet.ServletPool
The ServletFactory calls this method when it needs to know how many servlets that the primary listener (like a ServletPool or a ServletEntry) needs to keep active and ready to serve.
getMinServletCount() - Method in interface org.locomotive.loco.servlet.ServletFactoryListener
The ServletFactory calls this method when it needs to know how many servlets that the primary listener (like a ServletPool or a ServletEntry) needs to keep active and ready to serve.
getMinSize() - Method in class org.locomotive.util.ObjectPool
Get the minimum size of the object pool.
getMinThreads() - Method in class org.locomotive.server.ThreadPoolManager
Get the minimum number of threads for this pool.
getMostRecentId(Connection, int) - Static method in class org.locomotive.module.pub.PublisherLib
Returns the most recently inserted page id of a user.
getName() - Method in class org.locomotive.loco.perm.Permission
Returns the name of the permission.
getName() - Method in class org.locomotive.loco.perm.Role
Returns the name of the role.
getName() - Method in class org.locomotive.loco.perm.Group
Returns the name of the group.
getName() - Method in class org.locomotive.directory.NameParse
Get the component name part of this NameParse.
getName() - Method in class org.locomotive.directory.BeanProperty
Get the property name.
getName(int) - Method in class org.locomotive.commerce.ics.SCMPMessage
gets the field name at index postion field_index.
getNextBrowserStampID(Connection) - Method in class org.locomotive.loco.store.bstamp.BStampStore
 
getNextBrowserStampID(Connection) - Method in class org.locomotive.loco.store.bstamp.BStampStoreJdbc
 
getNextBrowserStampID(Connection) - Method in class org.locomotive.loco.store.bstamp.BStampStoreJdbcCloudscape
 
getNextBrowserStampID(Connection) - Method in class org.locomotive.loco.store.bstamp.BStampStoreJdbcOracle
 
getNextBrowserStampID(Connection) - Method in class org.locomotive.loco.store.bstamp.BStampStoreJdbcMysql
 
getNextBrowserStampID(Connection) - Method in class org.locomotive.loco.store.bstamp.BStampStoreJdbcInformix
 
getNextBrowserStampID(Connection) - Method in class org.locomotive.loco.store.bstamp.BStampStoreJdbcPostgresql
 
getNextBrowserStampID(Connection) - Method in class org.locomotive.loco.store.bstamp.BStampStoreJdbcSolid
 
getNextBStampId(Connection) - Method in class org.locomotive.loco.store.bstamp.BStampStoreJdbc
 
getNextBStampID(Connection) - Static method in class org.locomotive.loco.Cloudscape
gets a unique bstamp_id.
getNextGraffitiTagID(Connection) - Static method in class org.locomotive.loco.Cloudscape
gets a unique graffiti tag id.
getNextId() - Method in class org.locomotive.util.ObjectPool
Each PoolEntry has a numeric ID, this method increments it and gives it out.
getNextId(Connection) - Static method in class org.locomotive.loco.perm.RoleManager
Returns a unique id for a new role.
getNextId(Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Returns a unique id for a new group.
getNextId(int, Connection) - Method in class org.locomotive.loco.store.id.LocoId
 
getNextIdFromDatabase(int, int, Connection) - Method in class org.locomotive.loco.store.id.LocoId
 
getNextIdFromDatabase(int, int, Connection) - Method in class org.locomotive.loco.store.id.LocoIdJdbc
 
getNextNumber() - Method in class org.locomotive.util.LowNumberKeeper
gets the next available number in the sequence.
getNextSessionId(Connection) - Method in class org.locomotive.loco.store.session.SessionStore
Returns the next available id to use when saving a new session
getNextSessionId(Connection) - Method in class org.locomotive.loco.store.session.SessionStoreJdbc
 
getNextUserId(Connection) - Method in class org.locomotive.loco.store.user.UserStore
Returns the next available id to use when saving a new user
getNextUserId(Connection) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
returns the next free user id
getNonEmptyField(String, String) - Method in class org.locomotive.loco.FormData
returns the value of the field named field_name.
getNonNullField(String, String) - Method in class org.locomotive.loco.FormData
returns the value of the field named field_name.
getNsapiTunnelUriTokenPrefix() - Method in class org.locomotive.loco.LocoConfig
 
getNumColumns() - Method in class org.locomotive.util.SortableTable
returns the number of columns in the table.
getNumPages(Connection, int) - Static method in class org.locomotive.module.pub.PublisherLib
Returns the number of published pages in the database according to status.
getNumRows() - Method in class org.locomotive.util.SortableTable
returns the number of rows in the table.
getObject() - Method in class org.locomotive.util.ObjectPool
gets an object from the pool.
getObject() - Method in class org.locomotive.loco.servlet.ServletPool
Use this method to get a servlet from the ServletPool.
getOpenDBConnectionCount() - Static method in class org.locomotive.loco.Loco
used by the Server Handler for status
getOutputStream() - Method in class org.locomotive.loco.servlet.LocoServletResponse
Retrieve our friendly ServletOutputStream.
getPageInfo(Connection, int, Hashtable) - Static method in class org.locomotive.module.pub.PublisherLib
Returns all the fields of a user page (identified by its id) in a SortableTable.
getParameter(String) - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the value of the input parameter with the specified name
getParameterNames() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns an Enumeration of all the form input names.
getParameterValues(String) - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns an array of all the values for a specified name
getParent() - Method in class org.locomotive.util.data.DataTree.TreeNode
Access parent
getPassword() - Method in class org.locomotive.loco.User
returns the value of the User's password Note that later this might be made package accessable only
getPassword() - Method in class org.locomotive.loco.store.user.LocoUserRow
 
getPathInfo() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the path information that preceded the servlet path of this request's URI, if any.
getPathTranslated() - Method in class org.locomotive.loco.servlet.LocoServletRequest
This method gets any extra path information following the servlet path of this request's URL and translates it into a real path.
getPermissions() - Method in class org.locomotive.module.pub.PublisherServlet
Prepares the PermissionSet object for permission checking.
getPermissions() - Method in class org.locomotive.module.pub.PublisherHandler
Prepares the PermissionSet object for permission checking.
getPermissions() - Method in class org.locomotive.loco.perm.AccessControlList
Returns a Vector containing all of the permission names contained in the ACL.
getPermissions(Connection) - Static method in class org.locomotive.loco.perm.Permission
Returns all the permissions currently available.
getPermissions(Connection, int[]) - Static method in class org.locomotive.loco.perm.UserPerm
Gets a bunch of users' permissions from the database.
getPermissions(int, Connection) - Static method in class org.locomotive.loco.perm.UserPerm
Gets a user's permissions from the database.
getPermTable() - Method in class org.locomotive.loco.perm.PermissionSet
returns a SortableTable of all the permissions and whether or not this permission set has them set.
getPolarity(String) - Method in class org.locomotive.loco.perm.AccessControlList
Gets the polarity value of a permission in the ACL.
getPooledThread() - Method in class org.locomotive.server.ThreadPoolManager
 
getPoolSize() - Method in class org.locomotive.util.ObjectPool
returns the current number of open db objects in the pool
getPoolSize() - Method in class org.locomotive.server.ThreadPoolManager
 
getPort() - Method in class org.locomotive.router.Router
Returns the port this router uses.
getPost(Connection, int) - Method in class org.locomotive.module.discuss.DiscussionLib
returns a post
getPostIds(Connection, int) - Method in class org.locomotive.module.discuss.DiscussionLib
returns the entire list of posts from the database for the topic specified by the id
getPostList(Connection, int, int, int) - Method in class org.locomotive.module.discuss.DiscussionLib
returns a list of posts for a topic specified by the id.
getPostSummaries(Connection, int, int) - Method in class org.locomotive.module.discuss.DiscussionLib
this method returns a summary of all the posts related to a particular topic.
getPreAppAcceptURLs() - Method in class org.locomotive.commerce.ics.ICSReply
Gets the accept URLs (preapp_accept_url) for offers when the ICS service "ics_preapp" was requested in the Request.
getProperName() - Method in class org.locomotive.util.StringConstraint
Deprecated.  
getProperties(Class) - Method in class org.locomotive.server.ServiceRoutingTable
return the properties object for a given Class.
getProperty() - Method in class org.locomotive.directory.NameParse
Get the property part of this NameParse, or null if there is no property part.
getProperty(BeanConfiguration, Object, String) - Method in class org.locomotive.directory.BeanInstantiator
Get a property for an object.
getPropertyConverter(Class) - Method in class org.locomotive.directory.NameService
Get the property converter for a specific class.
getProtocol() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the request Protocol- for example, HTTP/1.1.
getQueryString() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the part of the request URI that is a query String, if any.
getReader() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns a BufferedReader of the request body data.
getRealPath(String) - Method in class org.locomotive.loco.servlet.LocoServletRequest
Deprecated. Use ServletContext.getRealPath() instead!
getRealPath(String) - Method in class org.locomotive.loco.servlet.LocoServletContext
Returns a String containing the real path that corresponds to a virtual path.
getRemoteAddr() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the IP address of the requestor, or null if not available.
getRemoteHost() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the Host name of the requestor, if available.
getRemoteUser() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the name of the user making this request, if it has been set via HTTP authentification.
getRequestDispatcher(String) - Method in class org.locomotive.loco.servlet.LocoServletContext
This returns a requestDispatcher object that will allow forwarding to another servlet or handler.
getRequestedSessionId() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the session id specified with this request.
getRequestID() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the unique id for this request.
getRequestID() - Method in class org.locomotive.loco.handler.HandlerData
gets the id of this request (for logging purposes)
getRequestURI() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns, from the first line of the HTTP request, the part of this request's URL that defines the resource being requested.
getResource(String) - Method in class org.locomotive.loco.servlet.LocoServletContext
Returns a URL to the resource that is mapped to a specified path.
getResource(String) - Method in class org.apache.java.lang.AdaptiveClassLoader
Find a resource with a given name.
getResourceAsStream(String) - Method in class org.locomotive.loco.servlet.LocoServletContext
Returns the resource located at the named path as an InputStream object.
getResourceAsStream(String) - Method in class org.apache.java.lang.AdaptiveClassLoader
Get an InputStream on a given resource.
getRightChild() - Method in class org.locomotive.util.data.DataTree.TreeNode
 
getRole(String, Connection) - Static method in class org.locomotive.loco.perm.RoleManager
Returns a role object from the database via its name.
getRoleNames(Connection) - Static method in class org.locomotive.loco.perm.RoleManager
Returns an enumeration of all the role names in the database.
getRoleNamesForUser(int, Connection) - Static method in class org.locomotive.loco.perm.RoleManager
Lists all the role names associated with a user.
getRolesForUser(int, Connection) - Static method in class org.locomotive.loco.perm.RoleManager
Returns a role of all the user's roles OR'ed together.
getRootPath() - Method in class org.locomotive.server.Log
Get the root path.
getRunCount() - Method in class org.locomotive.server.PooledThread
 
getScheme() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the scheme of the URL used for this request- For example: http, https, ftp.
getSCMPMessage() - Method in class org.locomotive.commerce.ics.ICSReply
Useful for debugging.
getScope(String) - Method in class org.locomotive.directory.loco.ScopeLookupImpl
Return the appropriate object for the requested scope.
getScope(String) - Method in class org.locomotive.directory.loco.BeanDirectory
 
getScope(String) - Method in interface org.locomotive.directory.ScopeLookup
Return the appropriate object for the requested scope.
getScopeType() - Method in class org.locomotive.directory.BeanConfiguration
Get the scope type for this bean.
getScriptName() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the "script name".
getSearchResultTableRows(Connection, String, String, String, String, StringBuffer, StringBuffer, int) - Static method in class org.locomotive.module.userpref.UserPref
Searches database with criteria provided in the parameter list and creates a table with search results.
getServerInfo() - Method in class org.locomotive.loco.servlet.LocoServletContext
Returns the following information about the current server, in the following format:
getServerLog() - Method in class org.locomotive.loco.HTTPServer
gets the reference to the main server log of this HTTPServer instance
getServerLog() - Static method in class org.locomotive.loco.Loco
gets the reference to the main server log of the Loco
getServerName() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the server name.
getServerPort() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the Server Port.
getServerRoot() - Method in class org.locomotive.loco.Loco
Get the server root.
getService() - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
Regardless of what the service Object is, use this method to get a reference to it.
getService(LocoConfig, String) - Method in class org.locomotive.server.ServiceRoutingTable
returns the Service Entry object appropriate for the given config and pattern string.
getServiceClasspath() - Method in class org.locomotive.loco.LocoConfig
 
getServices() - Method in class org.locomotive.directory.loco.ServiceList
 
getServlet() - Method in class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry
Give out the Servlet, but only to classes within the same package.
getServlet() - Method in class org.locomotive.loco.servlet.ServletFactoryEvent
If this method returns null, then this ServletFactoryEvent was sent by the ServletFactory to tell the listeners that the servlets that it creates are currently unavailable.
getServlet(String) - Method in class org.locomotive.loco.servlet.LocoServletContext
Deprecated. - too dangerous
getServletClass() - Method in class org.locomotive.loco.servlet.ServletFactoryEvent
Returns the class of servlets that this ServletFactoryEvent affects.
getServletClass() - Method in class org.locomotive.loco.servlet.ServletFactory
Returns the Class of servlets that this ServletFactory is managing.
getServletContext() - Method in class org.locomotive.loco.servlet.LocoServletConfig
Returns the servlet context object for this servlet.
getServletFactory() - Method in class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry
Returns a reference to this ServletPool's ServletFactory Object.
getServletFactory() - Method in class org.locomotive.loco.servlet.ServletPool
Returns a reference to this ServletPool's ServletFactory Object.
getServletFromPool() - Method in class org.locomotive.loco.servlet.ServletPool
Gets a servlet from this pool.
getServletNames() - Method in class org.locomotive.loco.servlet.LocoServletContext
Deprecated. because it's too dangerous
getServletPath() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Returns the part of this request's URI that identifies this the servlet to be invoked.
getServletRoutingTable() - Method in class org.locomotive.loco.servlet.LocoServletContext
 
getServlets() - Method in class org.locomotive.loco.servlet.LocoServletContext
Deprecated. because it's too dangerous
getSession() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Gets the current valid session associated with this request
getSession(boolean) - Method in class org.locomotive.loco.servlet.LocoServletRequest
Gets the current valid session associated with this request, if create is false or, if necessary, creates a new session for the request, if create is true.
getSession(String) - Method in class org.locomotive.loco.servlet.ServletRoutingTable
Deprecated. for security reasons
getSessionContext() - Method in class org.locomotive.loco.servlet.ServletRoutingTable
Returns the session context object for this server.
getSessionContext() - Method in class org.locomotive.loco.Session
Deprecated. as the SessionContext object is thought to be a security risk.
getSessionObjects(Connection, long) - Method in class org.locomotive.loco.store.session.SessionStore
Returns the objects for the individual session
getSessionObjects(Connection, long) - Method in class org.locomotive.loco.store.session.SessionStoreJdbc
 
getSessionObjects(Connection, long) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcCloudscape
 
getSetPerms() - Method in class org.locomotive.loco.perm.PermissionSet
Returns an enumeration of all set permission names.
getSize() - Static method in class org.locomotive.loco.perm.Permission
Returns the number of permissions currently in the cache
getSQLType(int) - Method in class org.locomotive.util.SortableTable
returns the column's SQL type.
getStartupDate() - Method in class org.locomotive.loco.HTTPServer
returns the startup date of the HTTPServer
getStartupDate() - Static method in class org.locomotive.loco.Loco
returns the startup date of the Loco
getStatus(Connection, int) - Static method in class org.locomotive.module.pub.PublisherLib
Changes the status of a page in the database.
getStatusVars() - Static method in class org.locomotive.loco.ServerHandler
send back a nice status page
getSteamVars(HttpServletRequest) - Method in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Pass this method the ServletRequest Object, and it returns the Locomotive's SteamVars Hashtable for this request (if it is defined in the request attributes under the key "locomotive.steam_vars").
getStoredrand() - Method in class org.locomotive.loco.store.session.LocoSessionRow
 
getString(String) - Method in class org.locomotive.server.Config
returns the value of a config as a string
getString(String) - Method in class org.locomotive.server.MultiConfig
Gets the first element of the array of strings that come from the config entry that matches the key (i.e.
getString(String, String, int, int) - Method in class org.locomotive.loco.FormData
Returns the string field named field_name.
getStringArray(String) - Method in class org.locomotive.server.MultiConfig
Returns the array of string objects for the config entry matching the supplied name (i.e.
getStringByIndex(String, int) - Method in class org.locomotive.server.MultiConfig
Gets the array of strings matching the key passed in in "name" and returns the string found at the index specified - will throw an exception if the index specified is invalid for this config entry or "name" is null or "" or the config entry found is the null object.
getSystemInstanceId() - Method in class org.locomotive.loco.LocoConfig
 
getSystemServerRootPath() - Method in class org.locomotive.loco.LocoConfig
 
getSystemTag() - Method in class org.locomotive.loco.LocoConfig
 
getTaxAmounts() - Method in class org.locomotive.commerce.ics.ICSReply
Gets the tax amounts associated (tax_taxamount0..n) with the offers submitted in the ICSRequest.
getText() - Method in class org.locomotive.module.graffiti.Tag
returns the text of the Tag.
getThreadPoolSize() - Method in class org.locomotive.loco.HTTPServer
Returns the number of active RequestManager Threads.
getThreadPoolSize() - Static method in class org.locomotive.loco.Loco
Returns the number of active RequestManager Threads.
getThrowable() - Method in class org.locomotive.directory.DirectoryEvent
If this event was triggered by an throwable, this method will return that throwable.
getTopicInfo(Connection, int) - Method in class org.locomotive.module.discuss.DiscussionLib
returns the information for the topic whose id is specified
getTopicList(Connection, int, String) - Method in class org.locomotive.module.discuss.DiscussionLib
returns a list of topics for the category whose id is specified
getTrimmedString(String, int, int) - Static method in class org.locomotive.util.StringUtil
This method trims the leading and trailing whitespace in a string, and returns its value.
getTrimmedString(String, String, int, int) - Method in class org.locomotive.loco.FormData
This method trims the leading and trailing whitespace in a field, and returns its value.
getType() - Method in class org.locomotive.directory.BeanPropertyValue
Get the type of this property value declaration.
getType() - Method in class org.locomotive.directory.DirectoryEvent
Get the type of this directory event.
getUnavailabilityReason() - Method in class org.locomotive.loco.servlet.ServletFactoryEvent
Get the reason for the unavailability.
getUnavailabilityReason() - Method in class org.locomotive.loco.servlet.ServletFactory
Returns the reason for the unavailability.
getUnavailabilityReason() - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
Returns the reason for the unavailability.
getUnavailableSeconds() - Method in class org.locomotive.loco.servlet.ServletFactoryEvent
Gets the number of seconds that this ServletFactoryEvent's ServletFactory will wait (or is currently waiting) before trying to make more servlets.
getUnavailableSeconds() - Method in class org.locomotive.loco.servlet.ServletFactory
Gets the number of seconds that this ServletFactory will wait (or is currently waiting) before trying to make more servlets.
getUnavailableSeconds() - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
Gets the number of seconds that this ServiceEntry's service is unavailable for.
getUrl() - Method in class org.locomotive.server.DBConnectionPool
Get the url to the database in this connection pool.
getURLTokens(HttpServletRequest) - Method in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Pass this method the ServletRequest Object, and it returns the Locomotive's URL tokens (if they are defined in the request attributes under the key "locomotive.url_tokens").
getUser(HttpServletRequest) - Method in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Pass this method the ServletRequest Object, and it returns the Locomotive's User Object for this request (if it is defined in the request's session values under the key "locomotive.user").
getUserid() - Method in class org.locomotive.loco.User
gets the userid of this User
getUserid() - Method in class org.locomotive.loco.perm.PermissionSet
gets the userid for this permission set
getUserid() - Method in class org.locomotive.loco.store.user.LocoUserRow
 
getUserid() - Method in class org.locomotive.loco.store.session.LocoSessionRow
 
getUserId() - Method in class org.locomotive.loco.Session
returns the userid of this session
getUserIdsFromGroup(int, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Lists all the user ids contained in a group.
getUserInfo(Connection, User, Hashtable) - Method in class org.locomotive.module.discuss.DiscussionLib
 
getUsername() - Method in class org.locomotive.loco.User
gets username of this User
getUsername() - Method in class org.locomotive.loco.store.user.LocoUserRow
 
getUserName() - Method in class org.locomotive.server.DBConnectionPool
Get the database username to use for connections in this pool.
getUsername(Connection, int) - Static method in class org.locomotive.loco.User
Given a userid, return the username
getUsername(Connection, int) - Method in class org.locomotive.loco.store.user.UserStore
Given a userid, return the username
getUsername(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
Given a userid, return the username
getUsernames(Connection, Vector) - Static method in class org.locomotive.loco.User
Given a vector of Integer-ized userids, look up each username for them.
getUsernames(Connection, Vector) - Method in class org.locomotive.loco.store.user.UserStore
Given a vector of Integer-ized userids, look up each username for them.
getUsernames(Connection, Vector) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
Given a vector of Integer-ized userids, look up each username for them.
getUserPageIndex(Connection, int) - Static method in class org.locomotive.module.pub.PublisherLib
Returns an index of pages of a single user.
getUsers() - Method in class org.locomotive.loco.perm.Group
Lists all the user names contained in the group.
getUsers(String) - Method in class org.locomotive.loco.perm.AccessControlList
Returns a Vector containing the user names associated with a particular permission.
getValue() - Method in class org.locomotive.directory.BeanPropertyValue
Get the value as a String.
getValue(int) - Method in class org.locomotive.commerce.ics.SCMPMessage
gets the field value at index postion field_index.
getValue(String) - Method in class org.locomotive.loco.Session
returns a stored object keyed by the name.
getValueByName(String) - Method in class org.locomotive.commerce.ics.ICSReply
Gets the value for the given return code name.
getValueByName(String) - Method in class org.locomotive.commerce.ics.SCMPMessage
Gets the field for a specified name.
getValueInCentsFromPriceStr(String) - Static method in class org.locomotive.util.Commerce
 
getValueNames() - Method in class org.locomotive.loco.Session
Returns an array of Strings representing the names to all the Objects stored with this session
getValues() - Method in class org.locomotive.directory.BeanProperty
Get the list of property values for this property.
getVersionString() - Method in class org.locomotive.loco.HTTPServer
returns the Version Number of the server (for now, returns the same String as Loco.getVersionString();
getVersionString() - Static method in class org.locomotive.loco.Loco
returns the Version Number of the server
getWriter() - Method in class org.locomotive.loco.servlet.LocoServletResponse
Retrieve the Response PrintWriter
go() - Method in class org.locomotive.server.PooledThread
 
go(Log, boolean) - Method in class org.locomotive.server.SMTPClient
Starts the delivery process.
GraffitiWallHandler - class org.locomotive.module.graffiti.GraffitiWallHandler.
This class implements the GraffitiWall example module, as described in the Locomotive Developers Guide.
GraffitiWallHandler() - Constructor for class org.locomotive.module.graffiti.GraffitiWallHandler
 
GraffitiWallServlet - class org.locomotive.module.graffiti.GraffitiWallServlet.
This class implements the GraffitiWall example module, as described in the Locomotive Developers Guide.
GraffitiWallServlet() - Constructor for class org.locomotive.module.graffiti.GraffitiWallServlet
 
Group - class org.locomotive.loco.perm.Group.
Contains all the information for one group, which represents a set of users.
Group(String) - Constructor for class org.locomotive.loco.perm.Group
Creates a group with associated with a name.
Group(String, int, Vector) - Constructor for class org.locomotive.loco.perm.Group
Creates a group with complete group information.
GroupManager - class org.locomotive.loco.perm.GroupManager.
Maintains all database transactions dealing with groups.
GroupManager() - Constructor for class org.locomotive.loco.perm.GroupManager
 
GrowableChar - class org.locomotive.util.GrowableChar.
 
GrowableChar(int) - Constructor for class org.locomotive.util.GrowableChar
 

H

hAddr - Variable in class org.locomotive.module.userpref.UserPref
 
handleAdminPosts() - Method in class org.locomotive.module.discuss.DiscussionAdminServlet
Handles all post administration.
handleAdminPosts() - Method in class org.locomotive.module.discuss.DiscussionAdminHandler
Handles all post administration.
handleAdminTopics() - Method in class org.locomotive.module.discuss.DiscussionAdminServlet
Handles all topic administration.
handleAdminTopics() - Method in class org.locomotive.module.discuss.DiscussionAdminHandler
Handles all topic administration.
handleCreate() - Method in class org.locomotive.module.btrack.BugTrackerHandler
Called to handle any URLs of the form "btrack?create+...
handleDBConnPoolReloadRequest(User) - Static method in class org.locomotive.loco.ServerHandler
 
handleEdit() - Method in class org.locomotive.module.btrack.BugTrackerHandler
Called to handle any URLs of the form "btrack?edit+...
handleException(Exception, String) - Method in class org.locomotive.loco.servlet.LocoServlet
this is a convenience method you can use when you catch serious Exceptions for which you want a stack trace and you need to send the user an error code, which can help you debug.
handleException(Exception, String) - Method in class org.locomotive.loco.handler.GenericHandler
this is a convenience method you can use when you catch serious Exceptions for which you want a stack trace and you need to send the user an error code, which can help you debug.
handleException(Exception, String, HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.MultiThreadedHttpServlet
This is a convenience method you can use when you catch serious Exceptions for which you want a stack trace and you need to send the user an error code, which can help you debug.
handleFormSubmission() - Method in class org.locomotive.module.base.LoginServlet
handle the login form submission.
handleHRTReloadRequest(User) - Static method in class org.locomotive.loco.ServerHandler
 
handleListBugs() - Method in class org.locomotive.module.btrack.BugTrackerHandler
Lists bugs.
handleListProjects() - Method in class org.locomotive.module.btrack.BugTrackerHandler
display to the client the list of all the projects.
Handler - interface org.locomotive.loco.handler.Handler.
The Locomotive requires a generic way to instantiate a class and have it handle a request; the Handler interface provides it.
handler_config - Variable in class org.locomotive.loco.handler.HandlerData
the properties file associated with the handler this is being sent to, if there is one.
handler_uri - Variable in class org.locomotive.loco.handler.GenericHandler
The last part of the url which specifies which Handler to use
handler_uri - Variable in class org.locomotive.loco.handler.HandlerData
The part of the URI that is after the Locomotive indicator token.
HandlerData - class org.locomotive.loco.handler.HandlerData.
A HandlerData object is passed to all module Handlers when they are invoked.
HandlerData(int) - Constructor for class org.locomotive.loco.handler.HandlerData
HandlerDataconstructor takes the request id whose fields it contains
handleRequest(HandlerData) - Method in class org.locomotive.module.pub.PublisherHandler
main entry point called by RequestManager for each new request.
handleRequest(HandlerData) - Method in class org.locomotive.module.userpref.UserMgtHandler
entry point from UserPrefHandler.java - main logic of handler This handler accepts the following URLS:
handleRequest(HandlerData) - Method in class org.locomotive.module.userpref.UserPrefHandler
This will route a request to the UserPrefHandler or UserMgtHandler class.
handleRequest(HandlerData) - Method in class org.locomotive.module.userpref.PersonalPrefHandler
determines whether hit requires handling new data, then displays the page
handleRequest(HandlerData) - Method in class org.locomotive.module.graffiti.GraffitiWallHandler
 
handleRequest(HandlerData) - Method in class org.locomotive.module.codegen.CodeGenerator
 
handleRequest(HandlerData) - Method in class org.locomotive.module.display.DisplayPageHandler
main entry point called by RequestManager for each new request.
handleRequest(HandlerData) - Method in class org.locomotive.module.btrack.BugTrackerHandler
This entry point is called by RequestManager for each new request.
handleRequest(HandlerData) - Method in class org.locomotive.loco.ServerHandler
this is the entry point for the server
handleRequest(HandlerData) - Method in class org.locomotive.loco.perm.PermHandler
This is the entry point for the server upon receipt of a new request.
handleRequest(HandlerData) - Method in class org.locomotive.module.base.LogoutHandler
 
handleRequest(HandlerData) - Method in class org.locomotive.module.base.BaseHandler
main entry point called by RequestManager for each new request.
handleRequest(HandlerData) - Method in class org.locomotive.module.base.LoginHandler
 
handleRequest(HandlerData) - Method in class org.locomotive.module.base.RegistrationHandler
called by BaseHandler.handleRequest () if routed here by url_tokens
handleRequest(HandlerData) - Method in class org.locomotive.module.discuss.DiscussionHandler
The main method to call for this Handler.
handleRequest(HandlerData) - Method in class org.locomotive.module.discuss.DiscussionAdminHandler
This handles the administration for communities discussions, topics, and posts.
handleRequest(HandlerData) - Method in class org.locomotive.loco.handler.GenericHandler
initializes all the local variables.
handleRequest(HandlerData) - Method in class org.locomotive.loco.handler.UnknownHandler
this is the entry point for the server.
handleRequest(HandlerData) - Method in class org.locomotive.loco.handler.DefaultHandler
This is the entry point for the server upon receipt of a new request.
handleRequest(HandlerData) - Method in interface org.locomotive.loco.handler.Handler
this is the entry point for the server for a specific Request.
HandlerRoutingTable - class org.locomotive.loco.handler.HandlerRoutingTable.
Used to choose which handler classes get invoked.
HandlerRoutingTable.HandlerEntry - class org.locomotive.loco.handler.HandlerRoutingTable.HandlerEntry.
 
HandlerRoutingTable(String, Log, Vector, boolean) - Constructor for class org.locomotive.loco.handler.HandlerRoutingTable
creates a new (but uninitialized) HanderManager
handleServletFactoryEvent(ServletFactoryEvent) - Method in class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry
The ServletFactory calls this method when it has either successfully instantiated and initialized a servlet (and the new servlet is ready to serve requests), or when the ServletFactory needs to signal the ServletFactoryListener(s) that some other event has occurred.
handleServletFactoryEvent(ServletFactoryEvent) - Method in class org.locomotive.loco.servlet.ServletPool
The ServletFactory calls this method when it has either successfully instantiated and initialized a servlet (and the new servlet is ready to serve requests), or when the ServletFactory needs to signal the ServletFactoryListener(s) that some other event has occurred.
handleServletFactoryEvent(ServletFactoryEvent) - Method in interface org.locomotive.loco.servlet.ServletFactoryListener
The ServletFactory calls this method when it has either successfully instantiated and initialized a servlet (and the new servlet is ready to serve requests), or when the ServletFactory needs to signal the ServletFactoryListener(s) that some other event has occurred.
handleShutdownRequest(User) - Static method in class org.locomotive.loco.ServerHandler
 
handleSRTReloadRequest(User) - Static method in class org.locomotive.loco.ServerServlet
 
handleTemplateReloadRequest(User) - Static method in class org.locomotive.loco.ServerHandler
 
hasAdminPriveleges(Connection, int) - Static method in class org.locomotive.module.userpref.UserPref
checks if the user with userid has admin priveleges for the UMS
hasAnyErrors() - Method in class org.locomotive.loco.FormData
tells whether the last get...() method generated any errors of any kind.
hasContents() - Method in class org.locomotive.util.FIFO
true if there are currently objects in the queue.
hasError(int) - Method in class org.locomotive.loco.FormData
tells whether the last get...() method generated an error whose code matches error_code.
hasMoreElements() - Method in class org.locomotive.util.data.Heap.HeapIterator
The following two methods implement the enumeration interface Returns true if we have not yet reached the end of the heap false otherwise.
hasNoChildren() - Method in class org.locomotive.util.data.DataTree.TreeNode
returns true if node has no children
hasPassword(String) - Method in class org.locomotive.loco.User
tests to see if the stored password is equivalent to the input
hasPasswordAnyCase(String) - Method in class org.locomotive.loco.User
tests to see if the stored password is equivalent to the input in any case (i.e.
hCity - Variable in class org.locomotive.module.userpref.UserPref
 
hCountry - Variable in class org.locomotive.module.userpref.UserPref
 
hd - Variable in class org.locomotive.loco.handler.GenericHandler
The handlerData object containing information for this request.
header_was_flushed - Variable in class org.locomotive.loco.Response
 
Heap - class org.locomotive.util.data.Heap.
this class implements a heap ADT.
Heap.HeapIterator - class org.locomotive.util.data.Heap.HeapIterator.
HeapIterator class creates a pointer to a node in a heap, thus allowing one to access any item in a heap, not just the first
Heap.HeapIterator(Heap) - Constructor for class org.locomotive.util.data.Heap.HeapIterator
Construct a new iterator on the heap and make the first node to be the "current" node
Heap() - Constructor for class org.locomotive.util.data.Heap
 
hPhone - Variable in class org.locomotive.module.userpref.UserPref
 
hState - Variable in class org.locomotive.module.userpref.UserPref
 
ht - Variable in class org.locomotive.util.SearchableVector
 
htmlQuoteHash(Hashtable) - Static method in class org.locomotive.util.StringUtil
HTML quotes all values in the input hash.
htmlQuoteString(String) - Static method in class org.locomotive.util.StringUtil
quotes any string for interpreted display of an HTML page by a browser.
HTTPResponse - class org.locomotive.loco.HTTPResponse.
The response class for regular HTTP requests.
HTTPResponse(OutputStream, int) - Constructor for class org.locomotive.loco.HTTPResponse
 
HTTPServer - class org.locomotive.loco.HTTPServer.
The org.locomotive.loco.HTTPServer is the Locomotive's embedded web server.
HTTPServerConfig - class org.locomotive.loco.HTTPServerConfig.
The config object for the HTTPServer.
HTTPServerConfig(String[], String) - Constructor for class org.locomotive.loco.HTTPServerConfig
This creates an HTTPServerConfig object.
hZip - Variable in class org.locomotive.module.userpref.UserPref
 

I

ICSReply - class org.locomotive.commerce.ics.ICSReply.
Represents a response returned from Cybersource.
ICSRequest - class org.locomotive.commerce.ics.ICSRequest.
A wrapper class for generating proper SCMPMessages.
ICSRequest(boolean, String, String) - Constructor for class org.locomotive.commerce.ics.ICSRequest
 
id - Variable in class org.locomotive.util.ObjectPool.PoolEntry
 
IdException - exception org.locomotive.loco.store.id.IdException.
 
IdException() - Constructor for class org.locomotive.loco.store.id.IdException
 
IdException(String) - Constructor for class org.locomotive.loco.store.id.IdException
 
ignoreErrorCode(int) - Method in class org.locomotive.loco.FormData
allows you to ignore the error message associated with error_code in the last get...() method call.
ignoreErrors() - Method in class org.locomotive.loco.FormData
allows you to ignore all the error messages in the last get...() method call.
include(ServletRequest, ServletResponse) - Method in class org.locomotive.loco.servlet.LocoRequestDispatcher
This will include the contents of the servlet which is invoked to be included in the parent servlet's response.
INet - class org.locomotive.util.INet.
Holds library calls for internet-related networking stuff.
INet() - Constructor for class org.locomotive.util.INet
 
INFO - Static variable in class org.locomotive.server.Log
Useful information.
init() - Method in class org.locomotive.servlets.test.PermanentlyUnavailable1
 
init() - Method in class org.locomotive.servlets.test.PermanentlyUnavailable3
 
init() - Method in class org.locomotive.servlets.test.TemporarilyUnavailable1
 
init() - Method in class org.locomotive.servlets.test.TemporarilyUnavailable3
 
init(Log) - Method in class org.locomotive.module.pub.PublisherHandler
The required init method, as defined in org.locomotive.loco.Handler.
init(Log) - Method in class org.locomotive.module.userpref.PersonalPrefHandler
Required to implement Handler.
init(Log) - Method in class org.locomotive.module.display.DisplayPageHandler
DisplayPageHandler doesn't do anything in the init() method.
init(Log) - Method in class org.locomotive.loco.ServerHandler
Place holder.
init(Log) - Method in class org.locomotive.loco.perm.PermHandler
Called during Handler initiation.
init(Log) - Method in class org.locomotive.module.base.BaseHandler
The required init method, as defined in org.locomotive.loco.Handler.
init(Log) - Method in class org.locomotive.module.discuss.DiscussionHandler
The required init method, as defined in org.locomotive.loco.Handler.
init(Log) - Method in class org.locomotive.module.discuss.DiscussionAdminHandler
our templates are loaded by DiscussionHandler for now, so we don't need to do anything
init(Log) - Method in class org.locomotive.loco.handler.GenericHandler
GenericHandler doesn't do anything in the init() method.
init(Log) - Method in class org.locomotive.loco.handler.UnknownHandler
we don't load anything, so just return.
init(Log) - Method in class org.locomotive.loco.handler.DefaultHandler
Called during Handler initiation.
init(Log) - Method in interface org.locomotive.loco.handler.Handler
Called by the HandlerRoutingTable when loaded/linked.
init(ServletConfig) - Method in class org.locomotive.module.pub.PublisherServlet
The required init method, as defined in org.locomotive.loco.Servlet.
init(ServletConfig) - Method in class org.locomotive.module.userpref.UserPrefServlet
Creates our internal servlets
init(ServletConfig) - Method in class org.locomotive.loco.perm.PermServlet
Called during Handler initiation.
init(ServletConfig) - Method in class org.locomotive.module.base.BaseServlet
Creates our internal LoginServlet, RegistrationServlet, and LogoutServlet
init(ServletConfig) - Method in class org.locomotive.module.discuss.DiscussionServlet
The required init method, as defined in org.locomotive.loco.Handler.
init(ServletConfig) - Method in class org.locomotive.module.discuss.DiscussionAdminServlet
intializes the DiscussionLib this Servlet will use
init(ServletConfig) - Method in class org.locomotive.steam.SteamServlet
This Initializes the Cached Page Loader.
init(String[], String) - Method in class org.locomotive.server.Config
 
InitializationException - exception org.locomotive.server.InitializationException.
A basic exception class that should be used to send initialization errors
InitializationException() - Constructor for class org.locomotive.server.InitializationException
 
InitializationException(String) - Constructor for class org.locomotive.server.InitializationException
 
InitializationException(String, Throwable) - Constructor for class org.locomotive.server.InitializationException
Sends the stack trace of the throwable to the superclass along with the err message.
initialize() - Method in class org.locomotive.util.ObjectPool
This needs to be called after the pool is created
initialize() - Method in class org.locomotive.loco.servlet.ServletRoutingTable
This method overrides ServiceRoutingTable::initialize().
initialize() - Method in class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry
 
initialize() - Method in class org.locomotive.loco.servlet.ServletPool
This method overrides ObjectPool.initialize().
initialize() - Static method in class org.locomotive.loco.Session
Initializes static variables, like the config object and the session_objects hash.
initialize() - Static method in class org.locomotive.loco.User
initializes the config object.
initialize() - Method in class org.locomotive.server.ServiceRoutingTable
initializes or re-initializes this object's routing structures based on the defaults and the contents of the file at the location specified in 'path' in the Constructor.
initialize() - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
This needs to be overridden to instantiate and create the service.
initialize() - Method in class org.locomotive.loco.handler.HandlerRoutingTable.HandlerEntry
 
initialize(Connection) - Static method in class org.locomotive.loco.perm.PermissionSet
Deprecated. in favor of Permission.initializeCache();
initialize(String, int, int) - Static method in class org.locomotive.steam.CachedPageLoader
 
initializeCache(Connection) - Static method in class org.locomotive.loco.perm.Permission
Reads permissions from the database and puts them into the permission hash.
initializeServlet(Servlet) - Method in class org.locomotive.loco.servlet.ServletFactory
Initializes the servlet by calling the init method of the servlet, passing in this ServletFactory's servlet_config Object.
insert(ComparisonKey) - Method in class org.locomotive.util.data.DataTree
inserts a node whose comparisonKey is its data
insert(ComparisonKey) - Method in class org.locomotive.util.data.Heap
this method inserts a ComparisonKey object into the heap in an appropriate place.
insert(ComparisonKey, Object) - Method in class org.locomotive.util.data.DataTree
inserts a new object into tree
insert(ComparisonKey, Object) - Method in class org.locomotive.util.data.Heap
this method inserts a ComparisonKey object into the heap in an appropriate place
insert(Connection) - Method in interface org.locomotive.util.cache.RelationalObject
The GlobalDBCache calls this method to create your new object in the database, if your object DOES NOT already exist in the database.
insert(Object, int, int) - Method in class org.locomotive.util.SortableTable
inserts an object at the given indexes.
insert(Object, int, String) - Method in class org.locomotive.util.SortableTable
inserts an object at the given row and column name.
insertAll(HandlerData) - Static method in class org.locomotive.loco.StandardInsertions
This method adds all the insertions implemented in the methods in this class.
insertAll(ServletRequest, Hashtable) - Static method in class org.locomotive.loco.StandardInsertions
This method adds all the insertions implemented in the methods in this class, for servlets.
insertDateTime(HandlerData) - Static method in class org.locomotive.loco.StandardInsertions
Inserts the current date and time.
insertHandlerURL(HandlerData) - Static method in class org.locomotive.loco.StandardInsertions
Inserts the handler url token, if there is one.
insertImagesIntoPage(Connection, int, String, String) - Static method in class org.locomotive.module.pub.PublisherLib
Inserts images into a page entry.
insertPage(Connection, int, String, String, String, String, String, String) - Static method in class org.locomotive.module.pub.PublisherLib
Creates a page entry into the database for the first time.
insertRequestID(HandlerData) - Static method in class org.locomotive.loco.StandardInsertions
Inserts the request id for this handler.
insertSessionID(HandlerData) - Static method in class org.locomotive.loco.StandardInsertions
Inserts the current session id.
insertSystemTags(HandlerData) - Static method in class org.locomotive.loco.StandardInsertions
Inserts two tags that unquely identify the Locomotive the that is handling the request.
insertTemplate(HandlerData, String) - Static method in class org.locomotive.module.discuss.DiscussionHandler
evaluate a template using the template path from the template hash and flush the template through hd.resp.
insertTemplate(String, HttpServletResponse, Hashtable) - Static method in class org.locomotive.module.discuss.DiscussionServlet
evaluate a template using the template path from the template hash and flush the template to our response object.
insertUserID(HandlerData) - Static method in class org.locomotive.loco.StandardInsertions
Inserts the current User's ID.
insertUserName(HandlerData) - Static method in class org.locomotive.loco.StandardInsertions
Insters the current user's name, if the session is not anonymous.
insertVersion(HandlerData) - Static method in class org.locomotive.loco.StandardInsertions
Inserts the current Locomotive Version.
instance - Static variable in class org.locomotive.loco.store.id.LocoId
 
instantiateServlet() - Method in class org.locomotive.loco.servlet.ServletFactory
Instantiates a new servlet and returns a reference to it.
intArrayToString(int[], String) - Static method in class org.locomotive.util.StringUtil
Given an array of ints, convert it to one string with the separator as given.
INTEGER - Static variable in class org.locomotive.server.MultiConfig
 
IntegerConverter - class org.locomotive.directory.IntegerConverter.
Convert an object to Integer.
IntegerConverter() - Constructor for class org.locomotive.directory.IntegerConverter
 
invalidate() - Method in class org.locomotive.loco.Session
Expires this session
is - Variable in class org.locomotive.loco.handler.HandlerData
The input stream associated with sock.
IS_EMPTY - Static variable in class org.locomotive.util.ParseStringException
 
IS_EMPTY - Static variable in class org.locomotive.loco.FormData
 
IS_NULL - Static variable in class org.locomotive.util.ParseStringException
 
IS_NULL - Static variable in class org.locomotive.loco.FormData
 
isAlphanum(String) - Static method in class org.locomotive.util.StringUtil
tells whether string_containing_alphanum contains only alphanumerics.
isAnonymous() - Method in class org.locomotive.loco.Session
returns a true if this session does not have a specific user associated with it.
isAnonymous() - Method in class org.locomotive.loco.User
checks whether this user is an anonymous user.
isComment(String) - Method in class org.locomotive.server.Config
returns true if the first character of the string is '#'
isDigits(String) - Static method in class org.locomotive.util.StringUtil
tells whether string_containing_digits contains only digits.
isDirty() - Method in interface org.locomotive.util.cache.RelationalObject
 
isEmailAddress(String) - Static method in class org.locomotive.util.StringUtil
Will tell you whether the email address is a valid SMTP email address.
isEmpty() - Method in class org.locomotive.util.data.DataTree
returns true if the tree is empty, false if otherwise
isEmpty() - Method in class org.locomotive.util.data.Stack
returns true if empty, false otherwise
isEmpty() - Method in class org.locomotive.util.data.Heap
returns true if the heap is empty
isEmpty() - Method in class org.locomotive.loco.FormData
tells whether the form is empty (contains no fields).
isExpired() - Method in class org.locomotive.loco.Session
True if session has expired
isFromFile() - Method in class org.locomotive.server.MultiConfig
Tells us if this config file came from a file path that we loaded.
isFromString() - Method in class org.locomotive.server.MultiConfig
Tells us if this config file came from string information given to it in the constructor method call.
isInt(String) - Static method in class org.locomotive.util.StringUtil
tells whether this string contains an int.
isNew() - Method in class org.locomotive.loco.Session
true if the browser has not been sent by some notification about the session.
isOwner(Connection, int, int) - Static method in class org.locomotive.module.pub.PublisherLib
Verifies if a user is the owner of this page or not.
isRequestedSessionIdFromCookie() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Checks whether the session id specified by this request came in as a cookie.
isRequestedSessionIdFromUrl() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Deprecated. in favor of isRequestSessionIdFromURL()
isRequestedSessionIdFromURL() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Checks whether the session id specified by this request came in as part of the URL.
isRequestedSessionIdValid() - Method in class org.locomotive.loco.servlet.LocoServletRequest
Checks whether this request is associated with a session that is valid in the current session context.
isRunning - Variable in class org.locomotive.util.ObjectPool
 
isRunning() - Method in class org.locomotive.util.ObjectPool
Check if the object pool is started.
isRunning() - Method in class org.locomotive.router.Router
Return true if this service is running, false otherwise.
isRunning() - Method in class org.locomotive.directory.loco.ServiceList
 
isRunning() - Static method in class org.locomotive.directory.loco.BeanDirectory
 
isRunning() - Method in interface org.locomotive.directory.LocomotiveService
Return true if this service is running, false otherwise.
isRunning() - Method in class org.locomotive.server.Log
Check if the service is running.
isRunning() - Method in class org.locomotive.server.ThreadPoolManager
Check if the service running.
isSet(int) - Method in class org.locomotive.loco.perm.PermissionSet
a handy little method for package internal use in UserPerm
isSet(Permission) - Method in class org.locomotive.loco.perm.PermissionSet
Checks if a permission is set in the permission set.
isSet(String) - Method in class org.locomotive.loco.perm.PermissionSet
Checks if a permission is set in the permission set.
isSubsetOf(PermissionSet) - Method in class org.locomotive.loco.perm.PermissionSet
Sees if this PermissionSet is a subset of another PermissionSet.
isTemporary() - Method in class org.locomotive.loco.Session
Deprecated. in favor of isNew()
isValidCreditCard(long) - Static method in class org.locomotive.util.Commerce
Decide if a given credit card number is in good form or not using Luhn Checksum algorithm.

K

key - Variable in class org.locomotive.util.data.NumberKey
 

L

last_availability_event_timestamp - Variable in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
The date/timestamp of when the last availability reporting event occurred.
lastErrorMsg(int) - Method in class org.locomotive.loco.FormData
if the last get...() method generated an error matching error_code, this method will return the error message.
lastLogin - Variable in class org.locomotive.module.userpref.UserPref
 
lastName - Variable in class org.locomotive.util.data.NameKey
 
lastReadTime - Variable in class org.locomotive.directory.BeanConfiguration
 
leafNode() - Method in class org.locomotive.util.data.DataTree.TreeNode
returns true if node is a leaf node (if node has < 2 children)
length() - Method in class org.locomotive.util.GrowableChar
 
lib - Variable in class org.locomotive.module.discuss.DiscussionServlet
 
lib - Static variable in class org.locomotive.module.discuss.DiscussionHandler
 
lib - Variable in class org.locomotive.module.discuss.DiscussionAdminServlet
 
lName - Variable in class org.locomotive.module.userpref.UserPref
 
load(Connection, int) - Method in class org.locomotive.loco.store.user.UserStore
used by constructor above - loads User based on uid from db
load(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
used by constructor above - loads User based on uid from db
load(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInterbase
used by constructor above - loads User based on uid from db
load(Connection, Object) - Method in interface org.locomotive.util.cache.RelationalObject
The GlobalDBCache calls this method to load your object from the database.
load(Connection, String, boolean) - Method in class org.locomotive.loco.store.user.UserStore
used by constructor above - loads User based on un from db
load(Connection, String, boolean) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
used by constructor above - loads User based on un from db
load(Connection, String, boolean) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInterbase
used by constructor above - loads User based on un from db
load(Connection, String, boolean) - Method in class org.locomotive.loco.store.user.UserStoreJdbcCloudscape
used by constructor above - loads User based on un from db
load(Connection, String, boolean) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInformix
used by constructor above - loads User based on un from db
load(Log) - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
This will load the config path and create the class object.
load(ResultSet, boolean) - Method in class org.locomotive.util.SortableTable
loads data into the table from a ResultSet, starting at the first row and first column in the table
load(ResultSet, int, int, boolean) - Method in class org.locomotive.util.SortableTable
loads data into the table from a ResultSet, beginning at the row whose index is specified, into the columns beginning with and following the columns whose index is specified.
loadAllTags(Connection) - Static method in class org.locomotive.module.graffiti.Tag
loads in all rows from the db, sorted by date in desc order.
loadAllUserNames(Connection) - Static method in class org.locomotive.loco.User
Returns an array of all the user names in the database.
loadAllUserNames(Connection) - Method in class org.locomotive.loco.store.user.UserStore
Returns an array of all the user names in the database.
loadAllUserNames(Connection) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
Returns an array of all the user names in the database.
loadClass(String, boolean) - Method in class org.apache.java.lang.AdaptiveClassLoader
Resolves the specified name to a Class.
loadConfigsFromFile(String) - Method in class org.locomotive.server.Config
actually reads in the file and loads the configs.
loadFromQuery(Connection, String) - Static method in class org.locomotive.util.SortableTable
loads a query specified by the string into the SortableTable that's returned.
loadObject(MetaDataEntry, Object) - Method in class org.locomotive.util.cache.DBCache
 
loadQuery(Connection, String) - Static method in class org.locomotive.util.SortableTable
loads a query specified by the string into the SortableTable that's returned.
loadRunnable(Runnable) - Method in class org.locomotive.server.PooledThread
 
loadSerializedObjectFromDB(MetaDataEntry, Object) - Method in class org.locomotive.util.cache.DBCache
 
LoadUserException - exception org.locomotive.loco.LoadUserException.
This is thrown when a user cannot be loaded from the database.
LoadUserException(String) - Constructor for class org.locomotive.loco.LoadUserException
 
loadUsers(Connection, int[]) - Static method in class org.locomotive.loco.User
Searches the user database and returns a list of Users, based upon userid.
loadUsers(Connection, int[]) - Method in class org.locomotive.loco.store.user.UserStore
Searches the user database and returns a list of Users, based upon userid.
loadUsers(Connection, int[]) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
Searches the user database and returns a list of Users, based upon userid.
loadUsers(Connection, int[]) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInterbase
Searches the user database and returns a list of Users, based upon userid.
Loco - class org.locomotive.loco.Loco.
The org.locomotive.loco.Loco is the primary entry point for the Org.Locomotive.
LOCO_BSTAMP - Static variable in class org.locomotive.loco.store.id.LocoId
 
LOCO_FLAGS_CAN_CHANGE_LOCO_VARS - Static variable in class org.locomotive.loco.User
 
LOCO_FLAGS_CAN_EDIT_USER_PREFS - Static variable in class org.locomotive.loco.User
 
LOCO_FLAGS_CAN_SHUT_DOWN_LOCO - Static variable in class org.locomotive.loco.User
 
LOCO_FLAGS_CAN_VIEW_SERVER_STATUS - Static variable in class org.locomotive.loco.User
 
LOCO_FLAGS_CAN_VIEW_USER_PREFS - Static variable in class org.locomotive.loco.User
 
LOCO_FLAGS_DEFAULT - Static variable in class org.locomotive.loco.User
 
LOCO_SESSIONS - Static variable in class org.locomotive.loco.store.id.LocoId
 
LOCO_USERS - Static variable in class org.locomotive.loco.store.id.LocoId
 
Loco() - Constructor for class org.locomotive.loco.Loco
a basic wrapper for the constructor
LocoConfig - class org.locomotive.loco.LocoConfig.
The config object for the Locomotive.
LocoConfig() - Constructor for class org.locomotive.loco.LocoConfig
 
LocoConfig(String[], String) - Constructor for class org.locomotive.loco.LocoConfig
This creates a LocoConfig object.
LocoId - class org.locomotive.loco.store.id.LocoId.
 
LocoId() - Constructor for class org.locomotive.loco.store.id.LocoId
 
LocoIdJdbc - class org.locomotive.loco.store.id.LocoIdJdbc.
 
LocoIdJdbc() - Constructor for class org.locomotive.loco.store.id.LocoIdJdbc
 
LocomotiveService - interface org.locomotive.directory.LocomotiveService.
Interface implemented by components acting as services in the locomotive system.
LocoRequestDispatcher - class org.locomotive.loco.servlet.LocoRequestDispatcher.
Performs all the required functions for forwarding or including a request for the present request
LocoServlet - class org.locomotive.loco.servlet.LocoServlet.
The LocoServlet class is a Servlet class you can use as a superclass for Servlets you're writing to use with the Locomotive.
LocoServlet() - Constructor for class org.locomotive.loco.servlet.LocoServlet
 
LocoServletConfig - class org.locomotive.loco.servlet.LocoServletConfig.
 
LocoServletConfig(Properties, ServletRoutingTable) - Constructor for class org.locomotive.loco.servlet.LocoServletConfig
 
LocoServletContext - class org.locomotive.loco.servlet.LocoServletContext.
This class is instantiated for each servlet that the Locomotive initializes.
LocoServletContext(ServletRoutingTable) - Constructor for class org.locomotive.loco.servlet.LocoServletContext
 
LocoServletRequest - class org.locomotive.loco.servlet.LocoServletRequest.
The Locomotive Servlet Request class provides all the methods in ServletRequest and HttpServletRequest, and also provides a number of useful attributes.
LocoServletRequest.RequestInputStream - class org.locomotive.loco.servlet.LocoServletRequest.RequestInputStream.
Simple InputStream class that implements ServletInputStream
LocoServletRequest.RequestInputStream(LocoServletRequest, InputStream) - Constructor for class org.locomotive.loco.servlet.LocoServletRequest.RequestInputStream
 
LocoServletRequest(int, Socket, Hashtable, Hashtable, InputStream, LocoServletResponse, Hashtable, Session) - Constructor for class org.locomotive.loco.servlet.LocoServletRequest
Package protected constructor should be called only by ServletRoutingTable
LocoServletResponse - class org.locomotive.loco.servlet.LocoServletResponse.
The response class for the servlet interface provides us all the methods required for both ServletResponses and HttpServletResponses.
LocoServletResponse(OutputStream, int, int) - Constructor for class org.locomotive.loco.servlet.LocoServletResponse
 
LocoSessionRow - class org.locomotive.loco.store.session.LocoSessionRow.
 
LocoSessionRow(int, int, Timestamp, Timestamp, Timestamp) - Constructor for class org.locomotive.loco.store.session.LocoSessionRow
 
LocoUserRow - class org.locomotive.loco.store.user.LocoUserRow.
 
LocoUserRow(int, String, String, int) - Constructor for class org.locomotive.loco.store.user.LocoUserRow
 
log - Variable in class org.locomotive.util.ObjectPool
 
Log - class org.locomotive.server.Log.
A simple logging facility.
log_level - Variable in class org.locomotive.util.ObjectPool
 
Log() - Constructor for class org.locomotive.server.Log
Default constructor for the Log class.
log(Exception, String) - Method in class org.locomotive.loco.servlet.LocoServletContext
Logs the message and the stack trace at log level 0
log(int, String) - Method in class org.locomotive.util.cache.DBCache
log to the DBCache server log
log(int, String) - Method in class org.locomotive.loco.servlet.LocoServlet
writes a message to the locomotive's global server log.
log(int, String) - Method in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Writes a message to the Locomotive's global server log.
log(int, String) - Method in class org.locomotive.loco.HTTPServer
log to the HTTPServer log
log(int, String) - Static method in class org.locomotive.loco.Loco
log to the Loco server log
log(int, String) - Method in class org.locomotive.directory.loco.BeanDirectory
 
log(int, String) - Method in class org.locomotive.server.ServiceRoutingTable
Log with the correct class name
log(int, String) - Method in class org.locomotive.server.Log
logs an line to the logfile, containing the string s.
log(int, String) - Method in class org.locomotive.server.FormParser
logs the message to the log specifed in the constructor, using the specified log level
log(int, String) - Method in class org.locomotive.loco.handler.GenericHandler
writes a message to the locomotive's global server log.
Log(int, String, String) - Constructor for class org.locomotive.server.Log
Create a new Log.
log(String) - Method in class org.locomotive.util.ObjectPool
Log a statement.
log(String) - Method in class org.locomotive.loco.servlet.LocoServletContext
Currently logs to the server log- log level 5
log(String, Throwable) - Method in class org.locomotive.loco.servlet.LocoServletContext
Logs the message and the stack trace at log level 0
logAccess(String, String, String, String, int, int) - Method in class org.locomotive.loco.HTTPServer
Log a request to the HTTPServer access log

logDebug(BeanConfiguration, String) - Method in class org.locomotive.directory.NameService
Log a debug message for the bean directory.
logError(String, Throwable) - Method in class org.locomotive.util.ObjectPool
Log an error.
logEvent(int, HandlerData, String, String, String) - Static method in class org.locomotive.loco.Loco
log to the Loco event log - simplified version
logEvent(int, int, Session, User, String, String, String) - Method in class org.locomotive.loco.HTTPServer
log to the HTTPServer event log
logEvent(int, int, Session, User, String, String, String) - Static method in class org.locomotive.loco.Loco
log to the Loco event log
logEvent(String, String, String) - Method in class org.locomotive.loco.servlet.LocoServlet
write one event to the global locomotive event log.
logEvent(String, String, String) - Method in class org.locomotive.loco.handler.GenericHandler
write one event to the global locomotive event log.
logEvent(String, String, String, HttpServletRequest) - Method in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Write one event to the global Locomotive event log.
LoginHandler - class org.locomotive.module.base.LoginHandler.
A sample login form module.
LoginHandler() - Constructor for class org.locomotive.module.base.LoginHandler
 
LoginServlet - class org.locomotive.module.base.LoginServlet.
A Sample login handling Servlet
LoginServlet() - Constructor for class org.locomotive.module.base.LoginServlet
 
LogoutHandler - class org.locomotive.module.base.LogoutHandler.
A sample Logout handler.
LogoutHandler() - Constructor for class org.locomotive.module.base.LogoutHandler
 
LogoutServlet - class org.locomotive.module.base.LogoutServlet.
A sample Logout servlet.
LogoutServlet() - Constructor for class org.locomotive.module.base.LogoutServlet
 
LowNumberKeeper - class org.locomotive.util.LowNumberKeeper.
manages a pool of numbers.
LowNumberKeeper(int, int) - Constructor for class org.locomotive.util.LowNumberKeeper
creates a new keeper.

M

main(String[]) - Static method in class org.locomotive.util.DoubleHashtable
 
main(String[]) - Static method in class org.locomotive.util.cache.DBCache
 
main(String[]) - Static method in class org.locomotive.router.Router
Startup method to use the router as a standalone application.
main(String[]) - Static method in class org.locomotive.module.codegen.CodeGeneratorServlet
To be implemented in the future: read a class definition from the standard input and generate a Java class and HTML form on the output.
main(String[]) - Static method in class org.locomotive.module.codegen.CodeGenerator
 
main(String[]) - Static method in class org.locomotive.loco.StopLoco
This attempts to stop a locomotive remotely.
main(String[]) - Static method in class org.locomotive.loco.Loco
This method is called by the JVM at server startup.
main(String[]) - Static method in class org.locomotive.directory.loco.BeanDirectory
 
main(String[]) - Static method in class org.locomotive.module.discuss.DiscussionLib
This sample app will go ahead and delete all the discussions, topics and posts marked as 'DEAD'.
main(String[]) - Static method in class org.locomotive.directory.NameParse
 
main(String[]) - Static method in class org.locomotive.directory.DirectoryContext
 
makeAndFireStatusEvent() - Method in class org.locomotive.loco.servlet.ServletFactory
Regardless of the current availability status of the servlets, this method instantiates a new ServletFactoryEvent with the servlet_class, availability, unavailable_seconds, and unavailability_reason values, and then fires that event to the listeners.
makeServlet() - Method in class org.locomotive.loco.servlet.ServletFactory
Tries to instantiate and initialize a servlet.
mark(int) - Method in class org.locomotive.loco.servlet.LocoServletRequest.RequestInputStream
 
markServiceForReloading(String) - Method in class org.locomotive.server.ServiceRoutingTable
Marks a service for reloading, which means it will be reloaded on the next request for it, as opposed to right now, which is what the reloadService() method does.
markSupported() - Method in class org.locomotive.loco.servlet.LocoServletRequest.RequestInputStream
 
markToQuitRunning() - Method in class org.locomotive.server.PooledThread
 
matches(String) - Method in class org.locomotive.util.ExpressionSearch
returns true if the input string contains the expression
max_open - Variable in class org.locomotive.util.ObjectPool
 
max_pool_size - Variable in class org.locomotive.loco.servlet.ServletFactory
This member variable stores the maximum number of servlets that this ServletFactory's primary listener can hold or use.
MAXIMUM_NUMBER_OF_ENTRIES - Variable in class org.locomotive.util.cache.AlarmThread
 
message - Variable in class org.locomotive.directory.DirectoryEvent
 
MIN_ID - Static variable in class org.locomotive.loco.User
 
min_open - Variable in class org.locomotive.util.ObjectPool
 
min_pool_size - Variable in class org.locomotive.loco.servlet.ServletFactory
This member variable stores the minimum number of servlets that this ServletFactory's primary listener needs to keep on hand.
mName - Variable in class org.locomotive.module.userpref.UserPref
 
modifyCategory(Connection, int, String, String, String) - Method in class org.locomotive.module.discuss.DiscussionLib
Modify the topic.
modifyDiscUsers(int) - Method in class org.locomotive.module.discuss.DiscussionAdminServlet
 
modifyDiscUsers(int) - Method in class org.locomotive.module.discuss.DiscussionAdminHandler
 
modifyPost(Connection, int, int, String, String, String, String, String, String) - Method in class org.locomotive.module.discuss.DiscussionLib
modifies an existing post with the new fields passed in as parameters.
modifyTopic(Connection, int, String, String) - Method in class org.locomotive.module.discuss.DiscussionLib
Modify the topic.
MultiConfig - class org.locomotive.server.MultiConfig.
A handy config file that allows the specification of multiple values per name and the reading of data either from the method call data passed in or from a file path specified.
MultiConfig(String, boolean) - Constructor for class org.locomotive.server.MultiConfig
Make the config object with the file path or the string data as specified.
MultiThreadedHang - class org.locomotive.servlets.test.MultiThreadedHang.
This servlet is a test servlet that always prints a random number and then makes the request Thread sleep for five minutes, thereby hanging the Thread.
MultiThreadedHang() - Constructor for class org.locomotive.servlets.test.MultiThreadedHang
 
MultiThreadedHttpServlet - class org.locomotive.servlets.MultiThreadedHttpServlet.
The MultiThreadedHttpServlet class is a Servlet class you can use as a superclass for multithreaded servlet-container-independant servlets you're writing.
MultiThreadedHttpServlet() - Constructor for class org.locomotive.servlets.MultiThreadedHttpServlet
 
MultiThreadedLocoServlet - class org.locomotive.loco.servlet.MultiThreadedLocoServlet.
The MultiThreadedLocoServlet class is a Servlet class you can subclass if you want to write a servlet for use with the Locomotive (maybe one that uses STEAM).
MultiThreadedLocoServlet() - Constructor for class org.locomotive.loco.servlet.MultiThreadedLocoServlet
 

N

NameKey - class org.locomotive.util.data.NameKey.
this class provides a comparison key for names.
NameKey(String, String) - Constructor for class org.locomotive.util.data.NameKey
Constructor creates a new NameKey from a full name
NameParse - class org.locomotive.directory.NameParse.
NameParse provides a static method for parsing component references.
NameParse() - Constructor for class org.locomotive.directory.NameParse
 
names() - Static method in class org.locomotive.loco.perm.Permission
Returns an Vector of all permission names presently in the cache.
names() - Static method in class org.locomotive.loco.perm.PermissionSet
Deprecated. in favor of Permission.getPermissions()
NameService - class org.locomotive.directory.NameService.
A naming service for Java components.
NameService() - Constructor for class org.locomotive.directory.NameService
 
NameService(BeanParser, String[]) - Constructor for class org.locomotive.directory.NameService
Create a new NameService.
NameService(String[]) - Constructor for class org.locomotive.directory.NameService
Create a new NameService.
need_more_servlets - Variable in class org.locomotive.loco.servlet.ServletFactory
This member variable is used when we've created the minimum number of servlets and they're all in use, and more requests come in needing more servlets.
needMoreServlets() - Method in class org.locomotive.loco.servlet.ServletFactory
Increments the need_more_servlets int member variable, and then notifies the ServletFactory's Thread that the value has changed.
next() - Method in class org.locomotive.util.data.Heap.HeapIterator
Move iterator to point to next node in heap and return the item Should throw a NoSuchElementException if already at end of heap
nextElement() - Method in class org.locomotive.util.data.Heap.HeapIterator
Return the next item in the heap
NO_ERROR - Static variable in class org.locomotive.util.ParseStringException
 
NO_ERROR - Static variable in class org.locomotive.loco.FormData
 
NO_LOGGING - Static variable in class org.locomotive.server.Log
If you don't want to do any logging at all, set the logging level of the Log instance to this value.
NO_USERS - Static variable in class org.locomotive.loco.perm.ACLManager
 
NORMAL - Static variable in class org.locomotive.loco.servlet.LocoServlet
log level to use for normal activities
NORMAL - Static variable in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Log level to use for normal activities
NORMAL - Static variable in class org.locomotive.loco.handler.GenericHandler
log level to use for normal activities
NOT_YET_APPROVED - Static variable in class org.locomotive.module.pub.PublisherLib
 
NOTICE - Static variable in class org.locomotive.server.Log
Important information, including the URL tokens for each request.
NULL_USERID - Static variable in class org.locomotive.loco.User
 
num_listings_per_index_page - Static variable in class org.locomotive.module.pub.PublisherServlet
Constant used to determine how many page listings to show per index page.
num_listings_per_index_page - Static variable in class org.locomotive.module.pub.PublisherHandler
Constant used to determine how many page listings to show per index page.
NUMBER - Static variable in class org.locomotive.util.SortableTable
used to denote a number comparison for sorting
NumberKey - class org.locomotive.util.data.NumberKey.
this class provides a comparison key for most primitive data types
NumberKey(byte) - Constructor for class org.locomotive.util.data.NumberKey
Constructor creates a new NumberKey from a byte
NumberKey(char) - Constructor for class org.locomotive.util.data.NumberKey
Constructor creates a new NumberKey from a char
NumberKey(double) - Constructor for class org.locomotive.util.data.NumberKey
Constructor creates a new NumberKey from a double
NumberKey(float) - Constructor for class org.locomotive.util.data.NumberKey
Constructor creates a new NumberKey from a float
NumberKey(int) - Constructor for class org.locomotive.util.data.NumberKey
Constructor creates a new NumberKey from a int
NumberKey(long) - Constructor for class org.locomotive.util.data.NumberKey
Constructor creates a new NumberKey from a long
NumberKey(Number) - Constructor for class org.locomotive.util.data.NumberKey
Constructor creates a new NumberKey from a Number object
NumberKey(short) - Constructor for class org.locomotive.util.data.NumberKey
Constructor creates a new NumberKey from a short
numPostsToDisplay - Variable in class org.locomotive.module.discuss.DiscussionServlet
SET THIS TO DETERMINE THE NUMBER OF POSTS TO DISPLAY ON THE PAGE
numPostsToDisplay - Static variable in class org.locomotive.module.discuss.DiscussionHandler
SET THIS TO DETERMINE THE NUMBER OF POSTS TO DISPLAY ON THE PAGE
NYA_AND_APPR - Static variable in class org.locomotive.module.pub.PublisherLib
 

O

object - Variable in class org.locomotive.util.ObjectPool.PoolEntry
 
ObjectPool - class org.locomotive.util.ObjectPool.
Manages a pool of objects.
ObjectPool.PoolEntry - class org.locomotive.util.ObjectPool.PoolEntry.
The internal class to use as our Object entry.
ObjectPool.PoolEntry(ObjectPool, Object) - Constructor for class org.locomotive.util.ObjectPool.PoolEntry
 
ObjectPool() - Constructor for class org.locomotive.util.ObjectPool
Default constructor for the object pool
ObjectPool(int, int) - Constructor for class org.locomotive.util.ObjectPool
creates a new pool, and fills it with the specified minumum number of objects
ObjectPool(int, int, Log, int) - Constructor for class org.locomotive.util.ObjectPool
creates a new pool, and fills it with the specified minumum number of objects
Offer - class org.locomotive.commerce.ics.Offer.
Offer is a wrapper class for the ICS Offer field of an ICS Message.
Offer(String, String, String, String, String, int) - Constructor for class org.locomotive.commerce.ics.Offer
Creates a new Offer.
ONE_EMAIL_TYPE - Static variable in class org.locomotive.server.MultiConfig
 
ONE_INT_TYPE - Static variable in class org.locomotive.server.MultiConfig
 
ONE_STRING_TYPE - Static variable in class org.locomotive.server.MultiConfig
These three members are the type arrays, provided for convenience only. I.e.
oneString(String) - Method in class org.locomotive.server.MultiConfig
Give a string array of one element as provided.
or(PermissionSet) - Method in class org.locomotive.loco.perm.PermissionSet
'Ors' this PermissionSet with another PermissionSet.
org.apache.java.lang - package org.apache.java.lang
 
org.locomotive.commerce.ics - package org.locomotive.commerce.ics
 
org.locomotive.directory - package org.locomotive.directory
 
org.locomotive.directory.loco - package org.locomotive.directory.loco
 
org.locomotive.loco - package org.locomotive.loco
 
org.locomotive.loco.handler - package org.locomotive.loco.handler
 
org.locomotive.loco.perm - package org.locomotive.loco.perm
 
org.locomotive.loco.servlet - package org.locomotive.loco.servlet
 
org.locomotive.loco.store - package org.locomotive.loco.store
 
org.locomotive.loco.store.bstamp - package org.locomotive.loco.store.bstamp
 
org.locomotive.loco.store.id - package org.locomotive.loco.store.id
 
org.locomotive.loco.store.session - package org.locomotive.loco.store.session
 
org.locomotive.loco.store.user - package org.locomotive.loco.store.user
 
org.locomotive.module.base - package org.locomotive.module.base
 
org.locomotive.module.btrack - package org.locomotive.module.btrack
 
org.locomotive.module.codegen - package org.locomotive.module.codegen
 
org.locomotive.module.discuss - package org.locomotive.module.discuss
 
org.locomotive.module.display - package org.locomotive.module.display
 
org.locomotive.module.graffiti - package org.locomotive.module.graffiti
 
org.locomotive.module.pub - package org.locomotive.module.pub
 
org.locomotive.module.userpref - package org.locomotive.module.userpref
 
org.locomotive.router - package org.locomotive.router
 
org.locomotive.server - package org.locomotive.server
 
org.locomotive.servlets - package org.locomotive.servlets
 
org.locomotive.servlets.test - package org.locomotive.servlets.test
 
org.locomotive.steam - package org.locomotive.steam
 
org.locomotive.util - package org.locomotive.util
 
org.locomotive.util.cache - package org.locomotive.util.cache
 
org.locomotive.util.data - package org.locomotive.util.data
 
os - Variable in class org.locomotive.loco.Response
 
os - Variable in class org.locomotive.loco.handler.HandlerData
A java.io.OutputStream, associated with Socket sock.
overrideMessage(String, String) - Method in class org.locomotive.util.StringConstraint
Deprecated. Use the specified message instead of the default.

P

parseBeanConfiguration(String, BeanConfiguration) - Method in interface org.locomotive.directory.BeanParser
Parse a bean property configuration file and build the approriate BeanConfiguration structure.
parseBeanConfiguration(String, BeanConfiguration) - Method in class org.locomotive.directory.XmlBeanParser
Parse a bean property configuration file and build the approriate BeanConfiguration structure.
parseCCExpMonth(String) - Static method in class org.locomotive.util.Commerce
Given the expiration string of a credit card number, try to figure out the month.
parseCCExpYear(String) - Static method in class org.locomotive.util.Commerce
Given the expiration string of a credit card number, try to figure out the year.
parseCCNum(String) - Static method in class org.locomotive.util.Commerce
Checks basic syntax stuff for a creit card string.
parseClassDefinition(String) - Method in class org.locomotive.module.codegen.CodeGeneratorServlet
 
parseClassDefinition(String) - Method in class org.locomotive.module.codegen.CodeGenerator
 
parseForm() - Method in class org.locomotive.server.FormParser
this method returns a hashtable with all the data from the form it will figure out whether the form is normal or mulitpart, and handle it accordingly.
ParseFormException - exception org.locomotive.server.ParseFormException.
A basic exception class used by FormParser
ParseFormException() - Constructor for class org.locomotive.server.ParseFormException
 
ParseFormException(String) - Constructor for class org.locomotive.server.ParseFormException
 
parseName(DirectoryContext, String) - Static method in class org.locomotive.directory.NameParse
Parse a component name relative to a directory context, and return a NameParse object containing the different segments of the parse.
ParseStringException - exception org.locomotive.util.ParseStringException.
This Exception class is used primarily by the StringUtil class for signaling when a string value does not fit a particular format.
ParseStringException(int) - Constructor for class org.locomotive.util.ParseStringException
 
passHint - Variable in class org.locomotive.module.userpref.UserPref
 
passWd - Variable in class org.locomotive.module.userpref.UserPref
 
pattern - Variable in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
 
pe_in_use_hash - Variable in class org.locomotive.util.ObjectPool
This holds objects in use.
pe_stack - Variable in class org.locomotive.util.ObjectPool
the stack to use to hold the objects
peek() - Method in class org.locomotive.util.data.Heap
Look at maximum element without removing it.
peek() - Method in class org.locomotive.util.data.Heap.HeapIterator
Return the object stored at the current node in the heap Should throw a NoSuchElementException if no current node.
PERMANENT_STRING - Static variable in class org.locomotive.loco.servlet.UnavailableServlet
 
PERMANENTLY_UNAVAILABLE - Static variable in class org.locomotive.loco.servlet.ServletFactory
If the instance member availability is set to PERMANENTLY_UNAVAILABLE, that means that a ServletFactory won't try to create servlets of the class servlet_class.
PERMANENTLY_UNAVAILABLE - Static variable in class org.locomotive.server.ServiceRoutingTable
If the instance member availability is set to PERMANENTLY_UNAVAILABLE, that means that this ServiceEntry's service is unavailable, and probably won't be available again until the system administrator(s) restart the Locomotive.
PermanentlyUnavailable1 - class org.locomotive.servlets.test.PermanentlyUnavailable1.
This servlet is a test servlet that always throws a permanent UnavailableException during initialization in an attempt to tell the servlet container that this multithreaded servlet should be permanently unavailable.
PermanentlyUnavailable1() - Constructor for class org.locomotive.servlets.test.PermanentlyUnavailable1
 
PermanentlyUnavailable2 - class org.locomotive.servlets.test.PermanentlyUnavailable2.
This servlet is a test servlet that always throws a permanent UnavailableException during any call to the service() method in an attempt to tell the servlet container that this multithreaded servlet instance should be taken out of service.
PermanentlyUnavailable2() - Constructor for class org.locomotive.servlets.test.PermanentlyUnavailable2
 
PermanentlyUnavailable3 - class org.locomotive.servlets.test.PermanentlyUnavailable3.
This servlet is a test servlet that always throws a permanent UnavailableException during calls to the service() method in an attempt to tell the servlet container that this single-threaded servlet instance is permanently unavailable, and should be destroyed and removed.
PermanentlyUnavailable3() - Constructor for class org.locomotive.servlets.test.PermanentlyUnavailable3
 
PermanentlyUnavailable4 - class org.locomotive.servlets.test.PermanentlyUnavailable4.
This servlet is a test servlet that always throws a permanent UnavailableException during any call to the service() method in an attempt to tell the servlet container that this servlet instance should be taken out of service.
PermanentlyUnavailable4() - Constructor for class org.locomotive.servlets.test.PermanentlyUnavailable4
 
PermHandler - class org.locomotive.loco.perm.PermHandler.
Handler for the optional permissions module of the Locomotive.
PermHandler() - Constructor for class org.locomotive.loco.perm.PermHandler
 
Permission - class org.locomotive.loco.perm.Permission.
Creates and maintains a single atomic permission.
Permission(Connection, String) - Constructor for class org.locomotive.loco.perm.Permission
Loads the permission object with the given name from the database, and puts it in the cache.
Permission(String, int) - Constructor for class org.locomotive.loco.perm.Permission
Creates a permission associated by a name and id.
permissions() - Static method in class org.locomotive.loco.perm.Permission
Returns an enumeration of all the permissions currently in the cache
PermissionSet - class org.locomotive.loco.perm.PermissionSet.
Provides a data structure to store a set of permissions.
PermissionSet() - Constructor for class org.locomotive.loco.perm.PermissionSet
Creates an empty permission set.
PermissionSet(boolean[]) - Constructor for class org.locomotive.loco.perm.PermissionSet
Creates a permission set initialized to the bitfield contained in the array of booleans.
PermissionSet(int) - Constructor for class org.locomotive.loco.perm.PermissionSet
Creates an empty permission set with the specified userid
PermissionSet(Vector) - Constructor for class org.locomotive.loco.perm.PermissionSet
Creates a permission set initialized to the bitfield contained in the Vector of Integers.
permit(int, String, int, Connection) - Static method in class org.locomotive.loco.perm.ACLManager
Returns a boolean indicating whether a particular user, identified by the userid, is allowed the permission in question (indicated by its name) in the ACL specified by the id.
permPruneCategoriesTable(SortableTable) - Method in class org.locomotive.module.discuss.DiscussionServlet
Permission prune the categories table, removing the categories for which this user does not have read permission.
permPruneCategoriesTable(SortableTable) - Method in class org.locomotive.module.discuss.DiscussionHandler
Permission prune the categories table, removing the categories for which this user does not have read permission.
permPruneTopicsTable(SortableTable) - Method in class org.locomotive.module.discuss.DiscussionServlet
 
permPruneTopicsTable(SortableTable) - Method in class org.locomotive.module.discuss.DiscussionHandler
 
PermServlet - class org.locomotive.loco.perm.PermServlet.
Servlet for the optional permissions module of the Locomotive.
PermServlet() - Constructor for class org.locomotive.loco.perm.PermServlet
 
PersonalPrefHandler - class org.locomotive.module.userpref.PersonalPrefHandler.
A simple User Preference System.
PersonalPrefHandler() - Constructor for class org.locomotive.module.userpref.PersonalPrefHandler
 
PersonalPrefServlet - class org.locomotive.module.userpref.PersonalPrefServlet.
A simple User Preference System.
PersonalPrefServlet() - Constructor for class org.locomotive.module.userpref.PersonalPrefServlet
 
PooledThread - class org.locomotive.server.PooledThread.
 
PooledThread(ThreadPoolManager, Log, int) - Constructor for class org.locomotive.server.PooledThread
 
poolentry_id_sequence - Variable in class org.locomotive.util.ObjectPool
 
pop() - Method in class org.locomotive.util.data.Stack
pops an item off of the stack.
pred() - Method in class org.locomotive.util.data.Heap.HeapIterator
Move iterator to point to previous node in heap and return the item.
prepopulate(Connection) - Static method in class org.locomotive.module.graffiti.Tag
This is called from the init() method of the graffitiWallHandler to make sure the graffitiWall has a few entries to start out with.
primary_listener - Variable in class org.locomotive.loco.servlet.ServletFactory
This member variable stores a reference to this ServletFactory's "primary listener" -- an instance of an Object (like ServletEntry or ServletPool) that this ServletFactory gives the ready-to-serve servlets to.
print(String) - Method in class org.locomotive.util.cache.AlarmThread
 
printData() - Method in class org.locomotive.module.userpref.UserPref
 
printPriceFromCentValue(int) - Static method in class org.locomotive.util.Commerce
Pass in an int representing the number of cents (== the number of dollars * 100), and you'll get back a String representing it in money format.
printSQLType(int) - Static method in class org.locomotive.util.SortableTable
takes an int from java.sql.Types and returns it's name
printsyntax(String) - Static method in class org.locomotive.server.Config
prints the usage for arguments accepted by the constructor for this object
PropertyConverter - interface org.locomotive.directory.PropertyConverter.
PropertyConverter defines an interface for converting values of one object to another object.
props - Variable in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
 
PUB_ADMIN - Static variable in class org.locomotive.module.pub.PublisherServlet
Permission that allows a user to allow or censor newly user-created web pages.
PUB_ADMIN - Static variable in class org.locomotive.module.pub.PublisherHandler
Permission that allows a user to allow or censor newly user-created web pages.
PublisherHandler - class org.locomotive.module.pub.PublisherHandler.
This class is the main handler for the Locomotive Personal Website Publisher.
PublisherHandler() - Constructor for class org.locomotive.module.pub.PublisherHandler
 
PublisherLib - class org.locomotive.module.pub.PublisherLib.
This class provides a series of static methods which return Database information used by the Locomotive Publisher system.
PublisherLib() - Constructor for class org.locomotive.module.pub.PublisherLib
 
PublisherServlet - class org.locomotive.module.pub.PublisherServlet.
This class is the main Servlet for the Locomotive Personal Website Publisher.
PublisherServlet() - Constructor for class org.locomotive.module.pub.PublisherServlet
 
push(Object) - Method in class org.locomotive.util.data.Stack
pushes an item onto the stack
put(Object, Object, Object) - Method in class org.locomotive.util.DoubleHashtable
 
put(String, Object, Object) - Method in class org.locomotive.util.cache.DBCache
This method puts an object in the cache.
putBackDBConnection(Connection) - Static method in class org.locomotive.loco.Loco
Returns a Connection object back to the RequestManager DBConnection Pool.
putComponent(DirectoryContext, String, Object) - Method in class org.locomotive.directory.ScopeStore
Put a specific component into the scope store.
putInDefaults() - Method in class org.locomotive.loco.servlet.ServletRoutingTable
Overrides the superclass to put in the default handlers.
putInDefaults() - Method in class org.locomotive.server.ServiceRoutingTable
Override this to put in service defaults.
putInDefaults() - Method in class org.locomotive.loco.handler.HandlerRoutingTable
Overrides the superclass to put in the default handlers.
putValue(String, Object) - Method in class org.locomotive.loco.Session
Stores the object persistently, keyed by the name.

Q

quoteString(String) - Static method in class org.locomotive.util.SQL
quotes a String so it can be used in a statement, putting it within single quotes, '...'.
quoteStringEndLike(String) - Static method in class org.locomotive.util.SQL
creates a quoted String, enclosing the String argument within '..%', to be used in a LIKE '...%' clause for searching for prefixes.
quoteStringMidLike(String) - Static method in class org.locomotive.util.SQL
creates a quoted String, enclosing the String argument within '%..%', to be used in a LIKE '%...%' clause.

R

read() - Method in class org.locomotive.loco.servlet.LocoServletRequest.RequestInputStream
our required method
read(byte[]) - Method in class org.locomotive.loco.servlet.LocoServletRequest.RequestInputStream
 
read(byte[], int, int) - Method in class org.locomotive.loco.servlet.LocoServletRequest.RequestInputStream
 
readBeanConfiguration(DirectoryContext, String) - Method in class org.locomotive.directory.NameService
Search the config path for a bean configuration file matching a name, and return a BeanConfiguration object describing the configuration.
REASON_ATTRIBUTE_NAME - Static variable in class org.locomotive.loco.servlet.UnavailableServlet
The request attribute name String for the unavailability reason.
redirect(String, HandlerData) - Static method in class org.locomotive.loco.Loco
Redirects a given request to a new handler for completion.
register(String, Class) - Method in class org.locomotive.util.cache.DBCache
the default register method is:
register(String, Class, long, long, boolean) - Method in class org.locomotive.util.cache.DBCache
The register() method allows you to register your Objects that you want to store in the database, with the DBCache.
registerComponent(ScopeLookup, String, String, Object) - Method in class org.locomotive.directory.NameService
Register a component with a given name and scope.
RegistrationHandler - class org.locomotive.module.base.RegistrationHandler.
A sample Registration form handler.
RegistrationHandler() - Constructor for class org.locomotive.module.base.RegistrationHandler
 
RegistrationServlet - class org.locomotive.module.base.RegistrationServlet.
A sample Registration form servlet.
RegistrationServlet() - Constructor for class org.locomotive.module.base.RegistrationServlet
 
reInsertPage(Connection, int, String, String, String, String, String, String, String, String) - Static method in class org.locomotive.module.pub.PublisherLib
Re-inserts a page entry into the database.
reinstantiate() - Method in class org.apache.java.lang.AdaptiveClassLoader
Re-instantiate this class loader.
RelationalObject - interface org.locomotive.util.cache.RelationalObject.
 
reloadCache(Connection) - Static method in class org.locomotive.loco.perm.Permission
Reloads the permissions from the database.
reloadDBConnectionPool() - Static method in class org.locomotive.loco.Loco
Wipes all the current database connections from the DBConnectionPool and reloads it with new ones.
reloadHandler(String) - Static method in class org.locomotive.loco.Loco
Marks the Handler class specified by the string for reloading, which means that upon the next request for that handler, the handler's properties file will be reloaded and the handler's init() method will be called.
reloadHandlerRoutingTable() - Static method in class org.locomotive.loco.Loco
Reloads the hrt.conf file, then reinitializes all the handlers and reloads each of their properties files.
reloadService(String) - Method in class org.locomotive.server.ServiceRoutingTable
reloads a single service - that is, creates a new Service routing table entry, attempts to reload the properties, and if all goes well, replaces the old service with the new one.
reloadServlet(String) - Static method in class org.locomotive.loco.Loco
Marks the Servlet class specified by the string for reloading, which means that upon the next request for that Servlet, the Servlet's properties file will be reloaded and the Servlet's init() method will be called.
reloadServletRoutingTable() - Static method in class org.locomotive.loco.Loco
Reloads the hrt.conf file, then reinitializes all the Servlets and reloads each of their properties files.
remove() - Method in class org.locomotive.util.data.Heap
this method removes the highest-valued element from the heap
remove(int, int) - Method in class org.locomotive.util.SortableTable
removes an object stored at the specified indexes from the table
remove(Object, Object) - Method in class org.locomotive.util.DoubleHashtable
 
remove(String, Object) - Method in class org.locomotive.util.cache.DBCache
This method removes an object from the cache.
removeACL(int, Connection) - Static method in class org.locomotive.loco.perm.ACLManager
Removes an ACL from the database.
removeAllElements() - Method in class org.locomotive.util.SearchableVector
 
removeAttribute(String) - Method in class org.locomotive.loco.servlet.LocoServletContext
Removes a server attribute.
removeChildTable(Object) - Method in class org.locomotive.util.DoubleHashtable
 
removeDirectoryEventListener(DirectoryEventListener) - Method in class org.locomotive.directory.NameService
Remove a directory event listener.
removeElement(Object) - Method in class org.locomotive.util.SearchableVector
 
removeElements(Object) - Method in class org.locomotive.util.SearchableVector
 
removeElements(Object[]) - Method in class org.locomotive.util.SearchableVector
 
removeField(String) - Method in class org.locomotive.commerce.ics.SCMPMessage
removes a field of the specified name
removeGroup(String, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Removes an existing group from the database.
removeGroup(String, String) - Method in class org.locomotive.loco.perm.AccessControlList
Removes a group from a particular permission in the ACL.
removeObjects(Connection) - Method in class org.locomotive.loco.Session
Removes the objects for this session, either from the cache, if it's being used, or from the database
removeObjects(Connection, long) - Method in class org.locomotive.loco.store.session.SessionStore
Removes the objects for this session, either from the cache, if it's being used, or from the database
removeObjects(Connection, long) - Method in class org.locomotive.loco.store.session.SessionStoreJdbc
 
removePermission(String) - Method in class org.locomotive.loco.perm.AccessControlList
Removes a permission from the ACL.
removeRole(String, Connection) - Static method in class org.locomotive.loco.perm.RoleManager
Removes an existing role from the database.
removeRoleFromUser(int, String, Connection) - Static method in class org.locomotive.loco.perm.RoleManager
Removes an existing role from a user.
removeScope(Object) - Method in class org.locomotive.directory.NameService
Remove a scope from the NameService.
removeServletFactoryListener(ServletFactoryListener) - Method in class org.locomotive.loco.servlet.ServletFactory
Removes the specified ServletFactoryListener from the list of listeners to which this ServletFactory will broadcast events.
removeUser(String) - Method in class org.locomotive.loco.perm.Group
Removes an existing user from the group.
removeUser(String, String) - Method in class org.locomotive.loco.perm.AccessControlList
Removes a user corresponding to a permission in the ACL.
removeUserFromGroup(int, int, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Removes an existing user from a group.
removeValue(String) - Method in class org.locomotive.loco.Session
Removes the object keyed by the name from the persistent store.
removeWhitespaces(String) - Static method in class org.locomotive.util.StringUtil
This method removes all whitespace in string_value.
reply_type - Variable in class org.locomotive.loco.Response
 
REPLY_TYPE_CGI - Static variable in class org.locomotive.loco.Response
 
REPLY_TYPE_ISAPI - Static variable in class org.locomotive.loco.Response
 
REPLY_TYPE_NSAPI - Static variable in class org.locomotive.loco.Response
 
req - Variable in class org.locomotive.loco.servlet.LocoServlet
The request object we received for this request
request_id - Variable in class org.locomotive.loco.Response
 
requestBill(String) - Method in class org.locomotive.commerce.ics.ICSRequest
request the ICS service "ics_bill"
requestBill(String, String) - Method in class org.locomotive.commerce.ics.ICSRequest
request the ICS service "ics_bill" for the specified amount
requestCredit(String, String) - Method in class org.locomotive.commerce.ics.ICSRequest
request the ICS service "ics_credit"
requestDownload() - Method in class org.locomotive.commerce.ics.ICSRequest
 
requestExportCheck() - Method in class org.locomotive.commerce.ics.ICSRequest
request the ICS service "ics_export"
requestFraudScore(String) - Method in class org.locomotive.commerce.ics.ICSRequest
request that the fraud score be generated.
requestFulfillmentNotify(String) - Method in class org.locomotive.commerce.ics.ICSRequest
request that the fulfillment house be notified.
requestPreApp() - Method in class org.locomotive.commerce.ics.ICSRequest
request the ICS service "ics_preapp" Requesting this service is necessary before any funds can be transferred from customer credit cards to the account of the merchant.
requestTaxCalculation() - Method in class org.locomotive.commerce.ics.ICSRequest
request the tax calculation service.
reset() - Method in class org.locomotive.loco.servlet.LocoServletRequest.RequestInputStream
 
reset() - Method in class org.locomotive.loco.Response.ResponseOutputStream
 
resetExpiration(Connection, int) - Method in class org.locomotive.loco.Session
Advances the expiration time of the session by exp_seconds if the session is persistant, the new time will be committed to the session database
resetExpiration(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStore
Advances the expiration time of the session by exp_seconds if the session is persistant, the new time will be committed to the session database
resetExpiration(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbc
 
resetExpiration(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcInterbase
 
resetExpiration(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcMysql
 
resetExpiration(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcOracle
 
resetExpiration(Connection, long, Timestamp) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcPostgresql
 
resize() - Method in class org.locomotive.util.GrowableChar
 
resolve(HttpServletRequest, String) - Static method in class org.locomotive.directory.loco.BeanDirectory
 
resolve(ScopeLookup, DirectoryContext, String) - Method in class org.locomotive.directory.NameService
Resolve a component relative to a given directory context.
resolve(ScopeLookup, String) - Method in class org.locomotive.directory.NameService
Resolve a component with a given scope.
resolve(String) - Static method in class org.locomotive.directory.loco.BeanDirectory
 
resos - Variable in class org.locomotive.loco.Response
 
resp - Variable in class org.locomotive.loco.servlet.LocoServlet
The response object to use for this request
resp - Variable in class org.locomotive.loco.handler.HandlerData
A Loco response.
Response - class org.locomotive.loco.Response.
This object encapsulates a response from the Locomotive back to the browser.
Response.ResponseOutputStream - class org.locomotive.loco.Response.ResponseOutputStream.
our little ServletOutputStream.
Response.ResponseOutputStream(Response, OutputStream) - Constructor for class org.locomotive.loco.Response.ResponseOutputStream
 
Response(OutputStream, int, int) - Constructor for class org.locomotive.loco.Response
constructs a new response.
resw - Variable in class org.locomotive.loco.servlet.LocoServletResponse
 
resw - Variable in class org.locomotive.loco.HTTPResponse
 
returnData() - Method in class org.locomotive.util.data.DataTree.TreeNode
returns the data contained in the node: either node.data or node.key if node.data is null
returnToPool(Object) - Method in class org.locomotive.util.ObjectPool
returns this object to the pool, allowing other threads to have access to it.
returnToPool(Object) - Method in class org.locomotive.loco.servlet.ServletPool
Checks to make sure that the Object you're trying to return is an instance of a Servlet, and if so this method returns that Servlet instance to the pool.
returnToPool(Object) - Method in class org.locomotive.server.DBConnectionPool
returns this connection to the pool, allowing other threads to have access to it.
returnToPool(PooledThread) - Method in class org.locomotive.server.ThreadPoolManager
 
Role - class org.locomotive.loco.perm.Role.
Provides a data structure for a role (a set of permissions).
Role(String) - Constructor for class org.locomotive.loco.perm.Role
Creates a role associated with a name.
Role(String, int, Vector) - Constructor for class org.locomotive.loco.perm.Role
Creates a role with complete role information.
RoleManager - class org.locomotive.loco.perm.RoleManager.
Maintains all database transactions dealing with roles.
RoleManager() - Constructor for class org.locomotive.loco.perm.RoleManager
 
root - Variable in class org.locomotive.util.data.DataTree
 
root() - Method in class org.locomotive.util.data.DataTree
returns the root node of the tree.
Router - class org.locomotive.router.Router.
The router provides a mechanism for handling HTTP requests from clients and dispatching them to a locomotive, thereby eliminating the need for a web server to be able to run the locomotive.
routeRequest(int, Socket, InputStream, OutputStream, Hashtable, Hashtable, Hashtable, String[], String, long, Response, Connection, Session, Hashtable) - Method in class org.locomotive.loco.servlet.ServletRoutingTable
This gets called on every request by the loco, once it determines it has a servlet in its hands.
routeRequest(int, Socket, InputStream, OutputStream, Hashtable, Hashtable, Hashtable, String[], String, long, Response, Connection, Session, Hashtable) - Method in class org.locomotive.server.ServiceRoutingTable
This is the method which actually routes a request to a particular service.
routeRequest(int, Socket, InputStream, OutputStream, Hashtable, Hashtable, Hashtable, String[], String, long, Response, Connection, Session, Hashtable) - Method in class org.locomotive.loco.handler.HandlerRoutingTable
This gets called on every request by the loco, once it determines it has a handler in its hands.
routeToClass(LocoConfig, String) - Method in class org.locomotive.server.ServiceRoutingTable
returns the service class for the specified pattern NOTE: I think this is only used for Handlers! --JB
routeToService(LocoConfig, String, String) - Method in class org.locomotive.loco.servlet.ServletRoutingTable
Finds and returns the service Object associated with the specified request uri.
routeToService(LocoConfig, String, String) - Method in class org.locomotive.server.ServiceRoutingTable
Finds and returns the service Object associated with the specified request uri.
routeToServiceEntry(LocoConfig, String, String) - Method in class org.locomotive.server.ServiceRoutingTable
Returns the ServiceEntry Object appropriate for the given config, URI, and first token.
routeToSubServlet(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.userpref.UserPrefServlet
This will route a request to the PersonalPrefServlet or UserMgtServlet class.
rows() - Method in class org.locomotive.util.SortableTable
returns an Enumeration of the rows in the table.
run() - Method in class org.locomotive.util.cache.AlarmThread
The run() method only takes care of sleeping and waking up.
run() - Method in class org.locomotive.loco.servlet.ServletFactory
After another Object calls the ServletFactory.start() method, this class's run() method is called.
run() - Method in class org.locomotive.loco.HTTPServer
This method is called by the Loco Object
run() - Method in class org.locomotive.server.SMTPClient
required to implement Runnable, to allow sending mail messages on their own thread.
run() - Method in class org.locomotive.server.PooledThread
 

S

save(Connection) - Method in class org.locomotive.loco.User
Updates the User data in the database if changes have been made, silently ignored on anonymous users
save(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStore
Updates the User data in the database if changes have been made, silently ignored on anonymous users
save(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
Updates the User data in the database if changes have been made, silently ignored on anonymous users
save(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcMysql
Updates the User data in the database if changes have been made, silently ignored on anonymous users
save(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcOracle
Updates the User data in the database if changes have been made, silently ignored on anonymous users
save(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInterbase
Updates the User data in the database if changes have been made, silently ignored on anonymous users
save(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcPostgresql
Updates the User data in the database if changes have been made, silently ignored on anonymous users
save(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcSolid
Updates the User data in the database if changes have been made, silently ignored on anonymous users
save(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcCloudscape
Updates the User data in the database if changes have been made, silently ignored on anonymous users
save(Connection, int, String, String, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInformix
Updates the User data in the database if changes have been made, silently ignored on anonymous users
saveFormValuesToUserPref(FormData, UserPref, StringBuffer) - Static method in class org.locomotive.module.userpref.PersonalPrefServlet
 
saveFormValuesToUserPref(FormData, UserPref, StringBuffer) - Static method in class org.locomotive.module.userpref.PersonalPrefHandler
 
saveLoginTime(Connection) - Method in class org.locomotive.loco.User
Updates the user.last_login field in the database.
saveLoginTime(Connection, int) - Method in class org.locomotive.loco.store.user.UserStore
Updates the user.last_login field in the database.
saveLoginTime(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbc
Updates the user.last_login field in the database.
saveLoginTime(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcMysql
Updates the user.last_login field in the database.
saveLoginTime(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcOracle
Updates the user.last_login field in the database.
saveLoginTime(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInterbase
Updates the user.last_login field in the database.
saveLoginTime(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcPostgresql
Updates the user.last_login field in the database.
saveLoginTime(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcSolid
Updates the user.last_login field in the database.
saveLoginTime(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcCloudscape
Updates the user.last_login field in the database.
saveLoginTime(Connection, int) - Method in class org.locomotive.loco.store.user.UserStoreJdbcInformix
Updates the user.last_login field in the database.
saveRelationalObjectIfDirty(InstanceCacheEntry) - Method in class org.locomotive.util.cache.DBCache
This is just a convenience method for ExpirationThread and AutoSaveThread.
sayBadURL() - Method in class org.locomotive.loco.servlet.LocoServlet
simply tells the user that they typed a bad URL, by sending the message: "I'm sorry, I don't understand that URL."
sayBadURL() - Method in class org.locomotive.loco.handler.GenericHandler
simply tells the user that they typed a bad URL, by sending the message: "I'm sorry, I don't understand that URL."
sayBadURL(HttpServletResponse) - Method in class org.locomotive.servlets.MultiThreadedHttpServlet
Simply tells the user that they typed a bad URL, by sending the message: "I'm sorry, I don't understand that URL."

SCMPException - exception org.locomotive.commerce.ics.SCMPException.
This exception is thrown whenever their is an error sending or receiving information from Cybersource.
SCMPException(String) - Constructor for class org.locomotive.commerce.ics.SCMPException
 
SCMPMessage - class org.locomotive.commerce.ics.SCMPMessage.
A wrapper for the CyberSource C-Library ics_msg API funtions essentially mirror their C counterparts.
SCMPMessage(boolean) - Constructor for class org.locomotive.commerce.ics.SCMPMessage
Creates a new SCMPMessage.
ScopeLookup - interface org.locomotive.directory.ScopeLookup.
This interface is provided so clients of NameService can provide an appropriate object for the requested scope type.
ScopeLookupImpl - class org.locomotive.directory.loco.ScopeLookupImpl.
An implementation of the scope lookup interface that implements scope lookup for request, session and global scoped components.
ScopeLookupImpl(HttpServletRequest, BeanDirectory) - Constructor for class org.locomotive.directory.loco.ScopeLookupImpl
Constructor for the scope lookup class.
ScopeStore - class org.locomotive.directory.ScopeStore.
Data structure for storing and looking up components in a specific scope.
ScopeStore() - Constructor for class org.locomotive.directory.ScopeStore
 
SearchableVector - class org.locomotive.util.SearchableVector.
 
SearchableVector() - Constructor for class org.locomotive.util.SearchableVector
 
SECONDS_ATTRIBUTE_NAME - Static variable in class org.locomotive.loco.servlet.UnavailableServlet
The request attribute name String for the unavailability seconds.
SECONDS_IN_PERIOD - Variable in class org.locomotive.util.cache.AlarmThread
 
send() - Method in class org.locomotive.commerce.ics.ICSRequest
sends the request to the
send() - Method in class org.locomotive.commerce.ics.SCMPMessage
sends a message to the ICS gateway.
sendError(int) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Sends an error back to the requestor with the specified status code.
sendError(int, String) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Sends an error back to the requestor with the specified status code and error message.
sendErrorMsg(HandlerData, String) - Static method in class org.locomotive.module.base.BaseHandler
Deprecated. in favor of Loco.sendErrorMsg
sendErrorMsg(int, String, ServletRequest, HttpServletResponse) - Static method in class org.locomotive.loco.servlet.ServletRoutingTable
Displays and error page with Standard insertions, plus the error string for the class.
sendErrorMsg(String, HandlerData) - Static method in class org.locomotive.loco.Loco
Displays and error page with Standard insertions, plus a the error string for the class.
sendRedirect(String) - Method in class org.locomotive.loco.servlet.LocoServletResponse
sends a redirect response to client.
server_log - Variable in class org.locomotive.server.ServiceRoutingTable
 
server_log - Variable in class org.locomotive.loco.handler.HandlerRoutingTable
 
server_log - Variable in class org.locomotive.loco.handler.HandlerData
a org.locomotive.server.Log referencing the Loco server log
ServerHandler - class org.locomotive.loco.ServerHandler.
The Server Handler.
ServerHandler() - Constructor for class org.locomotive.loco.ServerHandler
 
ServerServlet - class org.locomotive.loco.ServerServlet.
The Server Servlet provides bare bones administration facilities for the Locomotive.
ServerServlet() - Constructor for class org.locomotive.loco.ServerServlet
 
service - Variable in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
 
service_configs - Variable in class org.locomotive.server.ServiceRoutingTable
The Hashtable that stores service-to-propsfile mappings
service_extensions_hash - Variable in class org.locomotive.server.ServiceRoutingTable
The Hashtable that stores extension-to-service mappings
service_tokens_hash - Variable in class org.locomotive.server.ServiceRoutingTable
The Hashtable that stores token-to-service mappings
service(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.pub.PublisherServlet
main entry point called by RequestManager for each new request.
service(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.loco.servlet.LocoServlet
The service method is the main entry point for Servlets.
service(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
The service method is the main entry point for Servlets.
service(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.loco.servlet.DefaultServlet
 
service(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.display.DisplayPageServlet
main entry point.
service(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.discuss.DiscussionServlet
The main method to call for this Servlet.
service(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.module.discuss.DiscussionAdminServlet
This handles the administration for communities discussions, topics, and posts.
service(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.servlets.MultiThreadedHttpServlet
The service method is the main entry point for Servlets.
ServiceException - exception org.locomotive.directory.ServiceException.
This exception is thrown if a LocomotiveService failed to start or stop.
ServiceException() - Constructor for class org.locomotive.directory.ServiceException
Default constructor for ServiceException.
ServiceException(String) - Constructor for class org.locomotive.directory.ServiceException
Constructor for ServiceException.
ServiceList - class org.locomotive.directory.loco.ServiceList.
This class is configured with array of services names that will be started when this component is resolved.
ServiceList() - Constructor for class org.locomotive.directory.loco.ServiceList
 
ServiceRoutingTable - class org.locomotive.server.ServiceRoutingTable.
An abstract way to route services to pattern Strings.
ServiceRoutingTable.ServiceEntry - class org.locomotive.server.ServiceRoutingTable.ServiceEntry.
This little class is the companion to the ServiceRoutingTable.
ServiceRoutingTable.ServiceEntry(ServiceRoutingTable, String, String, String) - Constructor for class org.locomotive.server.ServiceRoutingTable.ServiceEntry
Creates a new ServiceEntry.
ServiceRoutingTable(String, Log, Vector, boolean) - Constructor for class org.locomotive.server.ServiceRoutingTable
creates a new (but uninitialized) HanderRouting Table
servlet - Variable in class org.locomotive.loco.servlet.ServletFactoryEvent
A reference to a servlet that the ServletFactory is passing to the listener(s)..
servlet_class - Variable in class org.locomotive.loco.servlet.ServletFactoryEvent
The Class of servlets that the ServletFactory creates.
servlet_class - Variable in class org.locomotive.loco.servlet.ServletFactory
This is the Class of servlet(s) that this ServletFactory is responsible for instantiating, initializing, and handing out.
servlet_factory - Variable in class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry
We keep a reference to our ServletFactory -- it makes servlets for us in another Thread.
servlet_factory_listeners - Variable in class org.locomotive.loco.servlet.ServletFactory
A collection of Objects listening for ServletFactoryEvents.
servlet_factorys_thread - Variable in class org.locomotive.loco.servlet.ServletFactory
This member variable simply holds a reference to this ServletFactory's own Thread instance.
ServletFactory - class org.locomotive.loco.servlet.ServletFactory.
This class is the Thread subclass that makes Servlets for another Object (like ServletEntry or ServletPool) that needs new servlet instances.
ServletFactory(ServletFactoryListener, Class, ServletConfig) - Constructor for class org.locomotive.loco.servlet.ServletFactory
Creates a new ServletFactory Object (not yet started, though).
ServletFactoryEvent - class org.locomotive.loco.servlet.ServletFactoryEvent.
Instances of this class are used by ServletFactory Threads to make Servlet instances available to ServletEntry and to ServletPool.
ServletFactoryEvent(Object, Class, int, int, String) - Constructor for class org.locomotive.loco.servlet.ServletFactoryEvent
Constructs a ServletFactoryEvent for specifying that servlets of the specified class are unavailable.
ServletFactoryEvent(Object, Servlet) - Constructor for class org.locomotive.loco.servlet.ServletFactoryEvent
Constructs a ServletFactoryEvent with a Servlet that is ready to serve requests.
ServletFactoryListener - interface org.locomotive.loco.servlet.ServletFactoryListener.
A ServletFactoryListener is any Object that implements this interface and is interested in the events (and Objects) generated by a ServletFactory.
ServletPool - class org.locomotive.loco.servlet.ServletPool.
Holds a pool of servlets.
ServletPool(Class, ServletConfig, ServletRoutingTable.ServletEntry) - Constructor for class org.locomotive.loco.servlet.ServletPool
Creates the new ServletPool.
ServletRoutingTable - class org.locomotive.loco.servlet.ServletRoutingTable.
This class controls servlet activity for a particular servlet routing table.
ServletRoutingTable.ServletEntry - class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry.
 
ServletRoutingTable(String, Log, Vector, boolean) - Constructor for class org.locomotive.loco.servlet.ServletRoutingTable
Initializes the servletRoutingTable and loads the servlets.
session - Variable in class org.locomotive.loco.servlet.LocoServlet
the session associated with this request.
session - Variable in class org.locomotive.loco.handler.GenericHandler
the session associated with this request.
session - Variable in class org.locomotive.loco.handler.HandlerData
The current session
Session - class org.locomotive.loco.Session.
The Locomotive is able to keep track of a user from one page-view to the next, by sending a cookie to that user's browser and then using that cookie to identify that user.
Session() - Constructor for class org.locomotive.loco.Session
create a temporary anonymous session (no database persistance) with a default expiration time of one hour.
Session(Connection, long) - Constructor for class org.locomotive.loco.Session
Loads a Session from the session database using the session id.
Session(Connection, String) - Constructor for class org.locomotive.loco.Session
instantiates a session using session data stored persistantly in the session database.
Session(int) - Constructor for class org.locomotive.loco.Session
create a temporary anonymous session (no database persistance)
Session(int, Connection) - Constructor for class org.locomotive.loco.Session
creates a persistant session, with corresponding db entry
SessionStore - class org.locomotive.loco.store.session.SessionStore.
 
SessionStore() - Constructor for class org.locomotive.loco.store.session.SessionStore
 
SessionStoreJdbc - class org.locomotive.loco.store.session.SessionStoreJdbc.
 
SessionStoreJdbc() - Constructor for class org.locomotive.loco.store.session.SessionStoreJdbc
 
SessionStoreJdbcCloudscape - class org.locomotive.loco.store.session.SessionStoreJdbcCloudscape.
 
SessionStoreJdbcCloudscape() - Constructor for class org.locomotive.loco.store.session.SessionStoreJdbcCloudscape
 
SessionStoreJdbcInformix - class org.locomotive.loco.store.session.SessionStoreJdbcInformix.
 
SessionStoreJdbcInformix() - Constructor for class org.locomotive.loco.store.session.SessionStoreJdbcInformix
 
SessionStoreJdbcInterbase - class org.locomotive.loco.store.session.SessionStoreJdbcInterbase.
 
SessionStoreJdbcInterbase() - Constructor for class org.locomotive.loco.store.session.SessionStoreJdbcInterbase
 
SessionStoreJdbcMysql - class org.locomotive.loco.store.session.SessionStoreJdbcMysql.
 
SessionStoreJdbcMysql() - Constructor for class org.locomotive.loco.store.session.SessionStoreJdbcMysql
 
SessionStoreJdbcOracle - class org.locomotive.loco.store.session.SessionStoreJdbcOracle.
 
SessionStoreJdbcOracle() - Constructor for class org.locomotive.loco.store.session.SessionStoreJdbcOracle
 
SessionStoreJdbcPostgresql - class org.locomotive.loco.store.session.SessionStoreJdbcPostgresql.
 
SessionStoreJdbcPostgresql() - Constructor for class org.locomotive.loco.store.session.SessionStoreJdbcPostgresql
 
SessionStoreJdbcSolid - class org.locomotive.loco.store.session.SessionStoreJdbcSolid.
 
SessionStoreJdbcSolid() - Constructor for class org.locomotive.loco.store.session.SessionStoreJdbcSolid
 
set(Permission) - Method in class org.locomotive.loco.perm.PermissionSet
Sets a permission in the permission set.
set(String) - Method in class org.locomotive.loco.perm.PermissionSet
Sets a permission in the permission set.
setAll() - Method in class org.locomotive.loco.perm.PermissionSet
Sets all permissions in the permission set.
setAttribute(String, Object) - Method in class org.locomotive.loco.servlet.LocoServletRequest
Sets an attribute with the specified name to the specified object.
setAttribute(String, Object) - Method in class org.locomotive.loco.servlet.LocoServletContext
Sets a server attribute.
setAttributes(Hashtable) - Method in class org.locomotive.loco.handler.HandlerData
Set the value of attributes.
setAutoflush(boolean) - Method in class org.locomotive.loco.Response
setting this to true will cause the Response to flush automatically during every addString() or addBytes ()
setAutoSaveSleepInterval(int) - Method in class org.locomotive.util.cache.DBCache
how long the AutoSaveThread sleeps before waking up to check dirty data in objects, expressed in number of seconds
setAutoSessionHandling(boolean) - Static method in class org.locomotive.loco.Loco
toggle auto session handling
If true, which is the default, the RequestManager will automatically sense expired sessions.
setAvailability(int) - Method in class org.locomotive.loco.servlet.ServletFactory
Sets the availability code for this ServletFactory's class of servlets.
setAvailability(int) - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
Sets the availability code for this ServiceEntry's service.
setBacklog(int) - Method in class org.locomotive.router.Router
Sets the maximum length of the queue of clients waiting at any given time.
setBeanParser(BeanParser) - Method in class org.locomotive.directory.NameService
Set the parser to use when parsing bean configuration files.
setBeanProperty(Object, BeanProperty, ScopeLookup, BeanConfiguration) - Method in class org.locomotive.directory.BeanInstantiator
Set a given bean property in an object.
setBitfield(boolean[]) - Method in class org.locomotive.loco.perm.PermissionSet
takes an array of booleans and sets them as our new bitfield.
setBitfield(Vector) - Method in class org.locomotive.loco.perm.PermissionSet
Takes a Vector of Integers (in the format created by the toInts<\code> method), and sets it as our new bitfield.
setBuyerInfo(String, String, String, String, String, String, String, String, String, String, String, String) - Method in class org.locomotive.commerce.ics.ICSRequest
Necessary for any order.
setCheckIntervalSeconds(int) - Method in class org.locomotive.directory.NameService
Check seconds defines how many seconds a BeanConfiguration read from file is valid before it will be reread if changed.
setClassName(String) - Method in class org.locomotive.directory.BeanConfiguration
Set the fully qualified classname for this bean configuration.
setClazz(Class) - Method in class org.locomotive.directory.BeanConfiguration
Set the class for this bean configuration.
setColumnCapacity(int) - Method in class org.locomotive.util.SortableTable
sets the number of columns to the specified size.
setColumnName(int, String) - Method in class org.locomotive.util.SortableTable
sets the name of the column at the specified column index.
setComment(String, int) - Method in class org.locomotive.commerce.ics.ICSRequest
set one of the 8 comment fields.
setComments(String) - Method in class org.locomotive.commerce.ics.ICSRequest
set the comment field.
setComputedValue(Object) - Method in class org.locomotive.directory.BeanPropertyValue
Set the computed value for this property value.
setConfigPath(String[]) - Method in class org.locomotive.directory.NameService
 
setConnectionPool(DBConnectionPool) - Method in class org.locomotive.util.cache.DBCache
Set the connection pool this cache.
setConnectionPool(DBConnectionPool) - Static method in class org.locomotive.loco.Loco
Set the connection pool to use for this loco.
setContentLength(int) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Here for the servlet implementation- don't like this, though.
setContentType(String) - Method in class org.locomotive.loco.Response
sets the content type HTTP header to the the input string.
setCurPoolSize(int) - Method in class org.locomotive.loco.servlet.ServletFactory
Sets the ServletFactory's copy of the value of the primary ServletFactoryListener's current pool size.
setData(Object) - Method in class org.locomotive.util.data.DataTree.TreeNode
Change data
setDateHeader(String, long) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Sets a response header with the specified name and date.
setDefaultAutoSaveInterval(int) - Method in class org.locomotive.util.cache.DBCache
how long the AutoSaveThread sleeps before waking up to check dirty data in objects, expressed in number of seconds
setDefaultExpirationTime(int) - Method in class org.locomotive.util.cache.DBCache
the default frequency for how long an object can remain in the cache (used primarily by the ExpirationThread) expressed in number of seconds.
setDirectoryContext(DirectoryContext) - Method in class org.locomotive.directory.BeanConfiguration
Set the directory context for this configuration.
setDriverClassName(String) - Method in class org.locomotive.server.DBConnectionPool
Set the driver class name for this connection pool.
setELicenseFields(String, String, String, String, String) - Method in class org.locomotive.commerce.ics.Offer
These fields are used when requesting the "ics_elc" (Electronic License) service.
setEventLog(Log) - Static method in class org.locomotive.loco.Loco
set the event log for this loco.
setExpirationSleepInterval(int) - Method in class org.locomotive.util.cache.DBCache
how long the ExpirationThread sleeps before waking up to check whether objects have expired, expressed in number of seconds
setFullName(String) - Method in class org.locomotive.directory.BeanConfiguration
Set the full name of this configuration.
setHeader(String, String) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Sets a response header with the specified name and value.
setId(int) - Method in class org.locomotive.loco.perm.Role
Sets the id of the role.
setId(int) - Method in class org.locomotive.loco.perm.Group
Sets the id of the group.
setIntHeader(String, int) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Sets a response header with the specified name and integer value.
setKey(ComparisonKey) - Method in class org.locomotive.util.data.DataTree.TreeNode
Change key
setLastAvailabilityEventTimestamp(long) - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
Sets the timestamp of the last availability event.
setLastReadTime(long) - Method in class org.locomotive.directory.BeanConfiguration
Set the time this configuration last was read from the file system.
setLeftChild(DataTree.TreeNode) - Method in class org.locomotive.util.data.DataTree.TreeNode
Set left child of this node and parent pointer of new left child.
setLevel(int) - Method in class org.locomotive.server.Log
Adjusts the logging level to the specified level.
setLocoFlags(int) - Method in class org.locomotive.loco.User
sets the loco_flags value for this User
setLocoInstId(Integer) - Method in class org.locomotive.loco.LocoConfig
 
setLocomotive(String, int) - Method in class org.locomotive.router.Router
Sets the address of the locomotive.
setLocoPort(Integer) - Method in class org.locomotive.loco.LocoConfig
 
setLocoPortBacklog(Integer) - Method in class org.locomotive.loco.LocoConfig
 
setLocoTemplateRootPath(String) - Method in class org.locomotive.loco.LocoConfig
 
setLocoUploadPath(String) - Method in class org.locomotive.loco.LocoConfig
 
setLocoUrlHomepage(String) - Method in class org.locomotive.loco.LocoConfig
 
setLocoUrlMain(String) - Method in class org.locomotive.loco.LocoConfig
 
setLog(Log) - Method in class org.locomotive.util.ObjectPool
Set the log for this object pool.
setLog(Log) - Method in class org.locomotive.server.ThreadPoolManager
Set the server log for this pool.
setLogDebug(boolean) - Method in class org.locomotive.directory.NameService
Control logging of debug messages for the bean directory.
setLogLevel(int) - Method in class org.locomotive.util.ObjectPool
Set the log level for this object pool.
setLogPath(String) - Method in class org.locomotive.server.Log
Relative path name to the log file.
setMaxEntries(int) - Method in class org.locomotive.util.cache.DBCache
 
setMaxExpirationTime(int) - Method in class org.locomotive.util.cache.DBCache
The maximum time that any object can remain in this cache, expressed in number of seconds.
setMaxInactiveInterval(int) - Method in class org.locomotive.loco.Session
Sets the expire time for this session to the number of seconds into the future specified by the interval.
setMaxPooledThreads(int) - Method in class org.locomotive.router.Router
Sets the maximum number of threads used by the router.
setMaxPoolSize(int) - Method in class org.locomotive.loco.servlet.ServletFactory
Sets the ServletFactory's copy of the value of the primary ServletFactoryListener's maximum pool size.
setMaxSize(int) - Method in class org.locomotive.util.ObjectPool
Set the maximum size of the object pool.
setMaxSize(int) - Method in class org.locomotive.loco.servlet.ServletPool
Set the maximum size of the object pool.
setMaxThreads(int) - Method in class org.locomotive.server.ThreadPoolManager
Set the maximum number of threads this pool can have.
setMinPooledThreads(int) - Method in class org.locomotive.router.Router
Sets the minimum number of threads used by the router.
setMinPoolSize(int) - Method in class org.locomotive.loco.servlet.ServletFactory
Sets the ServletFactory's copy of the value of the primary ServletFactoryListener's minimum pool size.
setMinSize(int) - Method in class org.locomotive.util.ObjectPool
Set the minimum size of the object pool.
setMinSize(int) - Method in class org.locomotive.loco.servlet.ServletPool
Set the minimum size of the ServletPool.
setMinThreads(int) - Method in class org.locomotive.server.ThreadPoolManager
Set the minimum number of threads this pool can have.
setMsgForError(int, String) - Method in class org.locomotive.loco.FormData
allows you to set the error message for a particular error code.
setName(String) - Method in class org.locomotive.directory.BeanProperty
Set the property name.
setNexus(String) - Method in class org.locomotive.commerce.ics.Offer
nexus is optional and used by the "ics_tax" service
setNsapiTunnelUriTokenPrefix(String) - Method in class org.locomotive.loco.LocoConfig
 
setOnOrOff(Permission, boolean) - Method in class org.locomotive.loco.perm.PermissionSet
Sets a permission in the permission set.
setOnOrOff(String, boolean) - Method in class org.locomotive.loco.perm.PermissionSet
Sets a permission in the permission set.
setOptionalBuyerInfo(String, String) - Method in class org.locomotive.commerce.ics.ICSRequest
Optional information to accompany an order.
setPassword(String) - Method in class org.locomotive.loco.User
sets the password value for this User
setPassword(String) - Method in class org.locomotive.server.DBConnectionPool
Set the password for the username.
setPermissions(int, PermissionSet, Connection) - Static method in class org.locomotive.loco.perm.UserPerm
Deprecated. - the userid should be in the perms, so we don't need it here
setPermissions(PermissionSet[], Connection) - Static method in class org.locomotive.loco.perm.UserPerm
Lets you insert multiple permissions for of the users associated with each of the perms' userid.
setPermissions(PermissionSet, Connection) - Static method in class org.locomotive.loco.perm.UserPerm
Sets the users's permissions in the database
setPolarity(boolean, String) - Method in class org.locomotive.loco.perm.AccessControlList
Sets the polarity (allow or deny list) of a permission in the ACL.
setPort(int) - Method in class org.locomotive.router.Router
Sets the port this router will use.
setPrependDate(boolean) - Method in class org.locomotive.server.Log
Call this method with a prepend value of false to turn off the automatic prepending of the date on each log output line.
setProperties(ScopeLookup, Object, BeanConfiguration) - Method in class org.locomotive.directory.BeanInstantiator
Set the properties of a component according to properties set in a BeanConfiguration object.
setRightChild(DataTree.TreeNode) - Method in class org.locomotive.util.data.DataTree.TreeNode
Set right child of this node and parent pointer of new right child.
setRootPath(String) - Method in class org.locomotive.server.Log
Set the root path of that the log file will be written relative to.
setRowCapacity(int) - Method in class org.locomotive.util.SortableTable
sets the number of rows to the specified size.
setScopeType(String) - Method in class org.locomotive.directory.BeanConfiguration
Set the scope type for this bean.
setScoreMetric(String) - Method in class org.locomotive.commerce.ics.Offer
Overrides the default score metric for this offer.
setServerLog(Log) - Static method in class org.locomotive.loco.Loco
Set the log for this loco.
setServerRoot(String) - Method in class org.locomotive.loco.Loco
Set the server root.
setServiceClasspath(String) - Method in class org.locomotive.loco.LocoConfig
 
setServices(Object[]) - Method in class org.locomotive.directory.loco.ServiceList
 
setServletFactory(ServletFactory) - Method in class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry
 
setServletFactory(ServletFactory) - Method in class org.locomotive.loco.servlet.ServletPool
 
setServletRoutingTable(ServletRoutingTable) - Method in class org.locomotive.loco.servlet.LocoServletContext
 
setShipAddress(String, String, String, String, String, String) - Method in class org.locomotive.commerce.ics.ICSRequest
Set optional Shipping address information.
setShipAmount(String) - Method in class org.locomotive.commerce.ics.Offer
shipamount is optional and is used by the "ics_tax" and "ics_preapp" services
setSQLType(int, int) - Method in class org.locomotive.util.SortableTable
Sets the column SQL Type.
setStatus(int) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Deprecated. no no apparent reason...
setStatus(int, String) - Method in class org.locomotive.loco.servlet.LocoServletResponse
Deprecated. for no apparent reason
setStopAccepting() - Method in class org.locomotive.loco.HTTPServer
for shutting down the HTTPServer.
setStopAccepting() - Static method in class org.locomotive.loco.Loco
for shutting down the Loco.
setSubRefNumber(String) - Method in class org.locomotive.commerce.ics.ICSRequest
the SubRefNumber will be passed along to the fulfillment house.
setSystemInstanceId(String) - Method in class org.locomotive.loco.LocoConfig
 
setSystemServerRootPath(String) - Method in class org.locomotive.loco.LocoConfig
 
setSystemTag(String) - Method in class org.locomotive.loco.LocoConfig
 
setTaxAmount(String) - Method in class org.locomotive.commerce.ics.Offer
taxamount is optional and is used by the "ics_tax" and "ics_preapp" services
setTaxClass(String) - Method in class org.locomotive.commerce.ics.Offer
taxclass is optional and is used by the "ics_tax" service
setThreadPoolManager(ThreadPoolManager) - Static method in class org.locomotive.loco.Loco
Set the thread pool manager for this loco.
setTimeout(int) - Method in class org.locomotive.server.SMTPClient
set the number of seconds before the Mail client will stop trying the send the message
setType(int) - Method in class org.locomotive.directory.BeanPropertyValue
Set the type of this property value declaration.
setUnavailabilityReason(String) - Method in class org.locomotive.loco.servlet.ServletFactory
Sets the reason for the unavailability.
setUnavailabilityReason(String) - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
Sets the reason for the unavailability.
setUnavailableSeconds(int) - Method in class org.locomotive.loco.servlet.ServletFactory
Sets the number of seconds that this ServletFactory should wait before trying to make more servlets.
setUnavailableSeconds(int) - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
Sets the number of seconds that this ServiceEntry's service is unavailable for.
setup(HttpServletRequest, HttpServletResponse) - Method in class org.locomotive.loco.servlet.LocoServlet
This will set up the various fields the class requires.
setupDefaults() - Method in class org.locomotive.loco.HTTPServerConfig
This establishes the default setting for all the Locomotive configs.
setupDefaults() - Method in class org.locomotive.loco.LocoConfig
This establishes the default setting for all the Locomotive configs.
setupDefaults() - Method in class org.locomotive.server.Config
Override this method to set up your own defaults.
setupDefaults() - Method in class org.locomotive.server.MultiConfig
Override this method as shown below to set up your own configs.
setUrl(String) - Method in class org.locomotive.server.DBConnectionPool
Set the url to the database in this connection pool.
setUserid(int) - Method in class org.locomotive.loco.perm.PermissionSet
sets the userid for this permission set
setUsername(String) - Method in class org.locomotive.loco.User
sets the username value for this User Note: this may be made package friendly only in the future
setUserName(String) - Method in class org.locomotive.server.DBConnectionPool
Set the database username to use for connections in this pool.
setValue(BeanPropertyValue) - Method in class org.locomotive.directory.BeanProperty
Set the property value.
setValue(String) - Method in class org.locomotive.directory.BeanPropertyValue
Set the value as a String.
setWebServer(String, int) - Method in class org.locomotive.router.Router
Sets the address of the web server.
setWildcardMode(boolean) - Method in class org.locomotive.util.ExpressionSearch
 
shellEscape(String) - Static method in class org.locomotive.util.StringUtil
Shell escapes a given string.
shellEscape(String) - Static method in class org.locomotive.steam.SteamServlet
Shell escapes a given string.
shouldReload() - Method in class org.apache.java.lang.AdaptiveClassLoader
Check whether the classloader should be reinstantiated.
shouldReload(String) - Method in class org.apache.java.lang.AdaptiveClassLoader
Check to see if a given class should be reloaded because of a modification to the original class.
showApprove() - Method in class org.locomotive.module.pub.PublisherServlet
Displays a page showing the list of not-yet-approved published pages.
showApprove() - Method in class org.locomotive.module.pub.PublisherHandler
Displays a page showing the list of not-yet-approved published pages.
showCategory() - Method in class org.locomotive.module.discuss.DiscussionServlet
This method displays the Discussion cateogory page, which shows a list of the topics in that category.
showCategory() - Method in class org.locomotive.module.discuss.DiscussionHandler
This method displays the Discussion cateogory page, which shows a list of the topics in that category.
showCensor() - Method in class org.locomotive.module.pub.PublisherServlet
Displays a page showing the list of censored published pages.
showCensor() - Method in class org.locomotive.module.pub.PublisherHandler
Displays a page showing the list of censored published pages.
showCreate() - Method in class org.locomotive.module.pub.PublisherServlet
Displays the page used to create a web page.
showCreate() - Method in class org.locomotive.module.pub.PublisherHandler
Displays the page used to create a web page.
showDefault() - Method in class org.locomotive.module.discuss.DiscussionServlet
This method displays the default Discussion Page, which contains a list of categories to choose from along with choices on where to go.
showDefault() - Method in class org.locomotive.module.discuss.DiscussionHandler
This method displays the default Discussion Page, which contains a list of categories to choose from along with choices on where to go.
showDefaultIndex() - Method in class org.locomotive.module.pub.PublisherServlet
Shows the index of published pages that are not-yet-approved and approved.
showDefaultIndex() - Method in class org.locomotive.module.pub.PublisherHandler
Shows the index of published pages that are not-yet-approved and approved.
showFinal() - Method in class org.locomotive.module.pub.PublisherServlet
Displays the final published version of a page.
showFinal() - Method in class org.locomotive.module.pub.PublisherHandler
Displays the final published version of a page.
showIndex(int) - Method in class org.locomotive.module.pub.PublisherServlet
Displays a page showing a list of published pages.
showIndex(int) - Method in class org.locomotive.module.pub.PublisherHandler
Displays a page showing a list of published pages.
showMain() - Method in class org.locomotive.module.pub.PublisherServlet
Displays the main start page for this module.
showMain() - Method in class org.locomotive.module.pub.PublisherHandler
Displays the main start page for this module.
showOwn() - Method in class org.locomotive.module.pub.PublisherServlet
Shows the index of published pages owned by a user.
showOwn() - Method in class org.locomotive.module.pub.PublisherHandler
Shows the index of published pages owned by a user.
showPreview() - Method in class org.locomotive.module.pub.PublisherServlet
Displays a preview of a published page.
showPreview() - Method in class org.locomotive.module.pub.PublisherHandler
Displays a preview of a published page.
showSummary() - Method in class org.locomotive.module.discuss.DiscussionServlet
This method shows a summary of posts for a given topic.
showSummary() - Method in class org.locomotive.module.discuss.DiscussionHandler
This method shows a summary of posts for a given topic.
showTopic() - Method in class org.locomotive.module.discuss.DiscussionServlet
This method displays the topic page, which contains a set of the posts for that topic.
showTopic() - Method in class org.locomotive.module.discuss.DiscussionHandler
This method displays the topic page, which contains a set of the posts for that topic.
SHUTDOWN - Static variable in class org.locomotive.loco.servlet.ServletFactory
If the instance member availability is set to SHUTDOWN, that means that this ServletFactory has been shut down.
SHUTDOWN - Static variable in class org.locomotive.server.ServiceRoutingTable
If the instance member availability is set to SHUTDOWN, that means that the Object factory for this service has been shut down.
shutdown() - Method in class org.locomotive.util.cache.AlarmThread
Allows you to stop this thread gracefully, without forcing it to die a violent death.
shutdown() - Method in class org.locomotive.loco.servlet.ServletFactory
Call this method to shut down the ServletFactory (it can't be restarted..
shutdown() - Method in class org.locomotive.server.ServiceRoutingTable
Attempts to shut down each of the services
shutdown(Log) - Method in class org.locomotive.module.pub.PublisherServlet
The required shutdown method, as defined in org.locomotive.loco.Servlet.
shutdown(Log) - Method in class org.locomotive.module.pub.PublisherHandler
The required shutdown method, as defined in org.locomotive.loco.Handler.
shutdown(Log) - Method in class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry
Shuts down the service for this ServletEntry.
shutdown(Log) - Method in class org.locomotive.module.display.DisplayPageHandler
DisplayPageHandler doesn't do anything in the shutdown() method, either.
shutdown(Log) - Method in class org.locomotive.loco.ServerHandler
Place holder.
shutdown(Log) - Method in class org.locomotive.loco.perm.PermHandler
The required shutdown method, as defined in org.locomotive.loco.Handler.
shutdown(Log) - Method in class org.locomotive.module.base.BaseHandler
The required shutdown method, as defined in org.locomotive.loco.Handler.
shutdown(Log) - Method in class org.locomotive.module.discuss.DiscussionHandler
The required shutdown method, as defined in org.locomotive.loco.Handler.
shutdown(Log) - Method in class org.locomotive.module.discuss.DiscussionAdminHandler
Nothing to do here either, presently.
shutdown(Log) - Method in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
This should also be overridden to call whatever cleanup/shutdown methods you need.
shutdown(Log) - Method in class org.locomotive.loco.handler.GenericHandler
GenericHandler doesn't do anything in the shutdown() method, either.
shutdown(Log) - Method in class org.locomotive.loco.handler.UnknownHandler
there's nothing to do here but return happily
shutdown(Log) - Method in class org.locomotive.loco.handler.DefaultHandler
Called during handler shutdown.
shutdown(Log) - Method in class org.locomotive.loco.handler.HandlerRoutingTable.HandlerEntry
instantiates the handler for this hrte and calls its shutdown method
shutdown(Log) - Method in interface org.locomotive.loco.handler.Handler
Called by the Locomotive when the server is exiting.
shutdown(Servlet, Log) - Method in class org.locomotive.loco.servlet.ServletRoutingTable.ServletEntry
Shuts down just the specified servlet instance for this ServletEntry.
single_thread_model_class - Static variable in class org.locomotive.loco.servlet.ServletRoutingTable
 
SingleThreadedHang - class org.locomotive.servlets.test.SingleThreadedHang.
This servlet is a test servlet that always prints a random number and then makes the request Thread sleep for five minutes, thereby hanging the Thread.
SingleThreadedHang() - Constructor for class org.locomotive.servlets.test.SingleThreadedHang
 
size() - Method in class org.locomotive.util.SearchableVector
 
size() - Method in class org.locomotive.util.FIFO
current size (number of objects in the FIFO).
size() - Method in class org.locomotive.util.data.DataTree
this method returns the number of elements in the tree
size() - Method in class org.locomotive.loco.Response.ResponseOutputStream
 
size() - Method in class org.locomotive.loco.perm.PermissionSet
returns the size of the permission set
skip(long) - Method in class org.locomotive.loco.servlet.LocoServletRequest.RequestInputStream
 
SMTPClient - class org.locomotive.server.SMTPClient.
This class can be used to have the VM deliver an email to an external SMTP server - typically UNIX sendmail.
SMTPClient(String, int, String, String, String, String) - Constructor for class org.locomotive.server.SMTPClient
Creates a new SMTPClient.
SMTPClient(String, int, String, String, String, String, int) - Constructor for class org.locomotive.server.SMTPClient
Creates a new SMTPClient.
SMTPClient(String, int, String, String, String, String, int, String) - Constructor for class org.locomotive.server.SMTPClient
Deprecated. - This was added to get around bugs that some sites have been having, thought to be a problem with the JDK or Solaris. You probably don't need it.
SMTPClient(String, int, String, String, String, String, int, String, String) - Constructor for class org.locomotive.server.SMTPClient
Creates a new SMTPClient, with an attachment.
sock - Variable in class org.locomotive.loco.handler.HandlerData
The socket connected to the web server/locolink CGI.
sort(int, int, int) - Method in class org.locomotive.util.SortableTable
sorts the table by the specified column index.
sort(String, int, int) - Method in class org.locomotive.util.SortableTable
sorts the table by the specified column name.
SortableTable - class org.locomotive.util.SortableTable.
SortableTable is a data structure that allows for easy and persistent storage of java.sql.ResultSets.
SortableTable() - Constructor for class org.locomotive.util.SortableTable
Creates a SortableTable.
SortableTable(int, int) - Constructor for class org.locomotive.util.SortableTable
Creates a SortableTable whose initial size is given by the specified parameters.
SortableTable(int, int, int, int) - Constructor for class org.locomotive.util.SortableTable
creates a sortable table with the specified number of rows and columns.
SortableTable(SortableTable, int, int) - Constructor for class org.locomotive.util.SortableTable
Creates a new table out of a subset of rows of another table All the columns of the source table are copied to the destination table.
SQL - class org.locomotive.util.SQL.
This class contains some useful utilities for dealing with SQL statements and results of queries.
SQL() - Constructor for class org.locomotive.util.SQL
 
Stack - class org.locomotive.util.data.Stack.
This class contains a basic implementation of a stack using arrays At this point, resizing the array will simply double the present size of the array.
Stack() - Constructor for class org.locomotive.util.data.Stack
Creates a stack with an initial size of 20
Stack(int) - Constructor for class org.locomotive.util.data.Stack
Creates a stack whose initial size is the specified parameter
StandardInsertions - class org.locomotive.loco.StandardInsertions.
This class has methods which insert some standard variables into the steam substitutions for use in HTML templates.
startService() - Method in class org.locomotive.util.ObjectPool
Start the object pool service.
startService() - Method in class org.locomotive.util.cache.DBCache
Startup the service.
startService() - Method in class org.locomotive.router.Router
Start the service.
startService() - Method in class org.locomotive.directory.loco.ServiceList
 
startService() - Method in interface org.locomotive.directory.LocomotiveService
Start the service.
startService() - Method in class org.locomotive.server.DBConnectionPool
Start the DBConnectionPool service.
startService() - Method in class org.locomotive.server.Log
Start the log service.
startService() - Method in class org.locomotive.server.ThreadPoolManager
Start the thread pool manager.
startup(String[]) - Method in class org.locomotive.directory.loco.BeanDirectory
 
startWebServers(String) - Static method in class org.locomotive.loco.Loco
Start up any/all web servers from the space-separated list of instance names passed to this method.
statementToTestBitInNumber(String, int) - Static method in class org.locomotive.util.SQL
Everybody knows that SQL cannot do bit-wise logical operations, such as bit-wise AND or ORs.
status - Variable in class org.locomotive.loco.servlet.LocoServletResponse
 
STATUS_ATTRIBUTE_NAME - Static variable in class org.locomotive.loco.servlet.UnavailableServlet
The request attribute name String for the unavailability status.
steam_vars - Variable in class org.locomotive.loco.servlet.LocoServlet
the substitutions hashtable to be used when evaluating templates.
steam_vars - Variable in class org.locomotive.loco.handler.GenericHandler
the substitutions hashtable to be used when evaluating templates.
SteamServlet - class org.locomotive.steam.SteamServlet.
SteamServlet can be used to interpret and display steam templates.
SteamServlet() - Constructor for class org.locomotive.steam.SteamServlet
 
StopLoco - class org.locomotive.loco.StopLoco.
Java-based stoploco client.
StopLoco() - Constructor for class org.locomotive.loco.StopLoco
 
stopService() - Method in class org.locomotive.util.ObjectPool
Stop the object pool service.
stopService() - Method in class org.locomotive.router.Router
Stop the service.
stopService() - Method in class org.locomotive.directory.loco.ServiceList
 
stopService() - Method in interface org.locomotive.directory.LocomotiveService
Stop the service.
stopService() - Method in class org.locomotive.server.Log
Stop the service.
stopService() - Method in class org.locomotive.server.ThreadPoolManager
Stop the thread pool manager.
StoreFactory - class org.locomotive.loco.store.StoreFactory.
This is a new factory to construct instances of UserStore, SessionStore and BStampStore for the current persistant store Written by David Warnock
StoreFactory() - Constructor for class org.locomotive.loco.store.StoreFactory
 
storeObjects(Connection) - Method in class org.locomotive.loco.Session
Stores the session_objects table in the database.
storeObjects(Connection, long, Hashtable) - Method in class org.locomotive.loco.store.session.SessionStore
Stores the session_objects table in the database.
storeObjects(Connection, long, Hashtable) - Method in class org.locomotive.loco.store.session.SessionStoreJdbc
 
storeObjects(Connection, long, Hashtable) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcMysql
 
storeSessionObjects(Connection) - Static method in class org.locomotive.loco.Session
Clean up the session objects cache- save all the session info that is currently cached to the DB.
storeSessionObjects(Connection, Hashtable) - Method in class org.locomotive.loco.store.session.SessionStore
Saves a new Session and returns its sid
storeSessionObjects(Connection, Hashtable) - Method in class org.locomotive.loco.store.session.SessionStoreJdbc
 
storeSessionObjects(Connection, Hashtable) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcCloudscape
 
storeSessionObjects(Connection, Hashtable) - Method in class org.locomotive.loco.store.session.SessionStoreJdbcMysql
 
storeUserPrefsToDB(Connection, UserPref, StringBuffer) - Static method in class org.locomotive.module.userpref.UserPref
 
STRING - Static variable in class org.locomotive.util.SortableTable
used to denote a String comparison for sorting
STRING - Static variable in class org.locomotive.server.MultiConfig
These three members STRING, INTEGER, and EMAIL are type values you can use when specifying an array of types for the addConfig method.
stringArrayToString(String[], String) - Static method in class org.locomotive.util.StringUtil
Given an array of strings, convert it to one string with the separator as given.
stringArrayToString(String[], String, int) - Static method in class org.locomotive.util.StringUtil
Given an array of strings, convert it to one string with the separator as given.
StringConstraint - class org.locomotive.util.StringConstraint.
Deprecated. in favor of org.locomotive.util.StringUtil.
StringConstraint(String, String) - Constructor for class org.locomotive.util.StringConstraint
Deprecated. See the documentation at the top of this class for an example.
StringConverter - class org.locomotive.directory.StringConverter.
Converter for converting objects to String.
StringConverter() - Constructor for class org.locomotive.directory.StringConverter
 
StringKey - class org.locomotive.util.data.StringKey.
this class provides a comparison key for strings
StringKey(String) - Constructor for class org.locomotive.util.data.StringKey
Constructor creates a new StringKey
stringToIntArray(String, String) - Static method in class org.locomotive.util.StringUtil
This is the opposite of intArrayToString().
stringToStringArray(String, String) - Static method in class org.locomotive.util.StringUtil
This is the opposite of stringArrayToString().
stringToTimestamp(String) - Static method in class org.locomotive.util.SQL
A handy pre-configured format parser for date text fields.
StringUtil - class org.locomotive.util.StringUtil.
Utilities for manipulating strings.
StringUtil() - Constructor for class org.locomotive.util.StringUtil
 
stuff(Object) - Method in class org.locomotive.util.FIFO
Stuffs an object into the FIFO.
subs - Variable in class org.locomotive.loco.handler.HandlerData
This Hashtable contains all the names and values of variables to be inserted into a Steam document.
swapData(DataTree.TreeNode) - Method in class org.locomotive.util.data.DataTree.TreeNode
Swap data with another node

T

Tag - class org.locomotive.module.graffiti.Tag.
Tag - an individual graffiti message.
Tag(Connection, String, String) - Constructor for class org.locomotive.module.graffiti.Tag
saves this Tag into the db table loco_graffiti_rows.
TemporarilyUnavailable1 - class org.locomotive.servlets.test.TemporarilyUnavailable1.
This servlet is a test servlet that always throws UnavailableException during initialization in an attempt to tell the servlet container that this multithreaded servlet should be unavailable for two minutes.
TemporarilyUnavailable1() - Constructor for class org.locomotive.servlets.test.TemporarilyUnavailable1
 
TemporarilyUnavailable2 - class org.locomotive.servlets.test.TemporarilyUnavailable2.
This servlet is a test servlet that always throws UnavailableException during initialization in an attempt to tell the servlet container that this servlet instance is temporarily unavailable.
TemporarilyUnavailable2() - Constructor for class org.locomotive.servlets.test.TemporarilyUnavailable2
 
TemporarilyUnavailable3 - class org.locomotive.servlets.test.TemporarilyUnavailable3.
This servlet is a test servlet that always throws UnavailableException during initialization in an attempt to tell the servlet container that servlets of this kind should be unavailable for two minutes.
TemporarilyUnavailable3() - Constructor for class org.locomotive.servlets.test.TemporarilyUnavailable3
 
TemporarilyUnavailable4 - class org.locomotive.servlets.test.TemporarilyUnavailable4.
This servlet is a test servlet that always throws UnavailableException during initialization in an attempt to tell the servlet container that this single-threaded servlet instance is temporarily unavailable.
TemporarilyUnavailable4() - Constructor for class org.locomotive.servlets.test.TemporarilyUnavailable4
 
TEMPORARY_STRING - Static variable in class org.locomotive.loco.servlet.UnavailableServlet
 
theclass - Variable in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
 
ThreadPoolManager - class org.locomotive.server.ThreadPoolManager.
 
ThreadPoolManager() - Constructor for class org.locomotive.server.ThreadPoolManager
Default constructor for the thread pool manager.
ThreadPoolManager(Log, int, int) - Constructor for class org.locomotive.server.ThreadPoolManager
 
throwable - Variable in class org.locomotive.directory.DirectoryEvent
 
throwException(String) - Method in class org.locomotive.server.ServiceRoutingTable
throw an initializationException with the correct classname
timeFormat - Static variable in class org.locomotive.loco.StandardInsertions
 
TIMESTAMP_ATTRIBUTE_NAME - Static variable in class org.locomotive.loco.servlet.UnavailableServlet
The request attribute name String for the event timestamp.
TITLE - Static variable in class org.locomotive.module.discuss.DiscussionLib
used by the getPostSummaries method specify sorting
toArray() - Method in class org.locomotive.loco.perm.PermissionSet
Transforms the Bitfield into an array of booleans.
toCharArray() - Method in class org.locomotive.util.GrowableChar
 
toHTML() - Method in class org.locomotive.util.SortableTable
returns an HTML representation of the table, for easy data checking of handlers.
toHTMLText() - Method in class org.locomotive.loco.handler.HandlerData
returns a string in HTML format which contains debugging information about the data contained in this instance of HandlerData, so we can print it out on a web browse.
toInts() - Method in class org.locomotive.loco.perm.PermissionSet
Transforms the BitSet's bitfield into a Vector of Integers.
TOO_LARGE - Static variable in class org.locomotive.util.ParseStringException
 
TOO_LARGE - Static variable in class org.locomotive.loco.FormData
 
TOO_LONG - Static variable in class org.locomotive.util.ParseStringException
 
TOO_LONG - Static variable in class org.locomotive.loco.FormData
 
TOO_SHORT - Static variable in class org.locomotive.util.ParseStringException
 
TOO_SHORT - Static variable in class org.locomotive.loco.FormData
 
TOO_SMALL - Static variable in class org.locomotive.util.ParseStringException
 
TOO_SMALL - Static variable in class org.locomotive.loco.FormData
 
TOPIC_TO_ACL_FILTER - Static variable in class org.locomotive.module.discuss.DiscussionAdminServlet
Since categories and topics share the same ids since they both start at 1, we must make a distinction between category and topic ids for the acls.
TOPIC_TO_ACL_FILTER - Static variable in class org.locomotive.module.discuss.DiscussionAdminHandler
Since categories and topics share the same ids since they both start at 1, we must make a distinction between category and topic ids for the acls.
toString() - Method in class org.locomotive.util.SortableTable
Returns a string representation of the table.
toString() - Method in class org.locomotive.util.GrowableChar
 
toString() - Method in class org.locomotive.util.data.NumberKey
 
toString() - Method in class org.locomotive.util.data.DataTree.TreeNode
 
toString() - Method in class org.locomotive.util.data.DateKey
returns a string representation of the DateKey
toString() - Method in class org.locomotive.util.data.StringKey
returns a string representation of the object, of the form: 'value, firstName'
toString() - Method in class org.locomotive.util.data.NameKey
returns a string representation of the object, of the form: 'lastName, firstName'
toString() - Method in interface org.locomotive.util.data.ComparisonKey
to assure a decent string representation of the comparisonKey
toString() - Method in class org.locomotive.loco.Session
returns the Session cookie string
toString() - Method in class org.locomotive.loco.User
Returns the userid and username
toString() - Method in class org.locomotive.loco.perm.Permission
Method for displaying permissions- prints only the name
toString() - Method in class org.locomotive.loco.perm.PermissionSet
Returns the the userid + BitSet's toString().
toString() - Method in class org.locomotive.directory.BeanPropertyValue
 
toString() - Method in class org.locomotive.directory.BeanProperty
 
toString() - Method in class org.locomotive.server.MultiConfig
Calls the other toString with false.
toString() - Method in class org.locomotive.commerce.ics.SCMPMessage
Provides debugging information and complete message contents, as a String.
toString() - Method in class org.locomotive.loco.handler.HandlerData
returns a string which contains debugging information about the data contained in this instance of HandlerData.
toString(boolean) - Method in class org.locomotive.server.MultiConfig
Standard toString with a twist - the boolean determines if the descriptive text comes out as well.
triggerUnavailability(ServletException) - Method in class org.locomotive.loco.servlet.ServletFactory
This method takes a ServletException or an UnavailableException and changes the state of the ServletFactory to an unavailable state (as specified by the exception), and creates and fires an event about the state change to the ServletFactoryListeners.
TWO_EMAIL_TYPE - Static variable in class org.locomotive.server.MultiConfig
 
TWO_INT_TYPE - Static variable in class org.locomotive.server.MultiConfig
 
TWO_STRING_TYPE - Static variable in class org.locomotive.server.MultiConfig
Same as above, only containing two-in-a-row, just in case it's handy.
twoString(String, String) - Method in class org.locomotive.server.MultiConfig
Give a string array of two elements as provided.

U

unavailability_reason - Variable in class org.locomotive.loco.servlet.ServletFactoryEvent
The reason for the unavailability.
unavailability_reason - Variable in class org.locomotive.loco.servlet.ServletFactory
This member variable stores the text reason for the unavailability of these servlets.
unavailability_reason - Variable in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
If the service is either temporarily or permanently unavailable, we should have a reason for the unavailability that we can show to the client.
UNAVAILABLE_AND_WAITING - Static variable in class org.locomotive.loco.servlet.ServletFactory
If the instance member availability is set to UNAVAILABLE_AND_WAITING, that means that a ServletFactory won't try to create servlets of the class servlet_class until unavailable_seconds have elapsed.
UNAVAILABLE_AND_WAITING - Static variable in class org.locomotive.server.ServiceRoutingTable
If the instance member availability is set to UNAVAILABLE_AND_WAITING, that means that this ServiceEntry's service is currently unavailable, but may become available again after unavailable_seconds have elapsed.
unavailable_seconds - Variable in class org.locomotive.loco.servlet.ServletFactoryEvent
The number of seconds that this kind of servlets are unavailable for.
unavailable_seconds - Variable in class org.locomotive.loco.servlet.ServletFactory
If this instance member is non-zero and availability has the value UNAVAILABLE_AND_WAITING, ServletFactory will sleep for unavailable_seconds seconds before trying again to make a new servlet.
unavailable_seconds - Variable in class org.locomotive.server.ServiceRoutingTable.ServiceEntry
We'll keep track of any waiting periods so that we can tell users what to expect.
unavailable_servlet - Static variable in class org.locomotive.loco.servlet.ServletRoutingTable
 
UnavailableServlet - class org.locomotive.loco.servlet.UnavailableServlet.
This servlet is invoked when a servlet being requested is currently unavailable (temporarily or permanently).
UnavailableServlet() - Constructor for class org.locomotive.loco.servlet.UnavailableServlet
 
unblock() - Method in class org.locomotive.util.BlockLock
unblocks the thread that called block()
UnknownHandler - class org.locomotive.loco.handler.UnknownHandler.
This handler is invoked when a url cannot be mapped to a handler by the Locomotive.
UnknownHandler() - Constructor for class org.locomotive.loco.handler.UnknownHandler
 
UnknownServlet - class org.locomotive.loco.servlet.UnknownServlet.
This servlet is invoked when a url cannot be mapped to a Servlet by the Locomotive.
UnknownServlet() - Constructor for class org.locomotive.loco.servlet.UnknownServlet
 
UNLIMITED_RETRIES - Static variable in class org.locomotive.loco.servlet.ServletFactory
If the instance member default_wait_retries is set to UNLIMITED_RETRIES, that means that a ServletFactory will never stop trying to make servlets.
unset(Permission) - Method in class org.locomotive.loco.perm.PermissionSet
Unsets a permission in the permission set.
unset(String) - Method in class org.locomotive.loco.perm.PermissionSet
Unsets a permission in the permission set.
update(Connection) - Method in interface org.locomotive.util.cache.RelationalObject
The GlobalDBCache calls this method to write your object to the database, if your object already exists in the database.
update(Connection, String) - Static method in class org.locomotive.util.SQL
executes a single SQL update (which may be either an insert or an update).
updateACL(AccessControlList, Connection) - Static method in class org.locomotive.loco.perm.ACLManager
Updates an ACL in the database.
updateBeanConfigFromDir(BeanConfiguration, String, String) - Method in class org.locomotive.directory.NameService
Search one directory in the filesystem for a bean configuration file, and update the associated with the values in this file.
updateBrowserCookie(Response) - Method in class org.locomotive.loco.Session
takes the input response object and places in it an outbound cookie to update the browser's knowledge of the current session
updateGroup(Group, Connection) - Static method in class org.locomotive.loco.perm.GroupManager
Updates an existing group in the database with new information.
updateRole(Role, Connection) - Static method in class org.locomotive.loco.perm.RoleManager
Updates an existing role in the database with new information (for instance, new permissions that get removed or added to a role).
url_tokens - Variable in class org.locomotive.loco.servlet.LocoServlet
the url tokens for this request.
url_tokens - Variable in class org.locomotive.loco.handler.GenericHandler
the url tokens for this request.
url_tokens - Variable in class org.locomotive.loco.handler.HandlerData
an ordered list of the url tokens that triggered the current request.
URLDecode(String) - Static method in class org.locomotive.util.StringUtil
Decodes a string encoded with URLEncode.
URLEncode(String) - Static method in class org.locomotive.util.StringUtil
takes an arbitrary string, returns a URLEncoded String everything but letters and numbers are escaped via the "%" sign.
usable - Variable in class org.locomotive.util.ObjectPool.PoolEntry
 
usage_count - Variable in class org.locomotive.util.ObjectPool.PoolEntry
 
usage() - Static method in class org.locomotive.loco.StopLoco
 
used_os - Variable in class org.locomotive.loco.servlet.LocoServletResponse
 
used_os - Variable in class org.locomotive.loco.HTTPResponse
 
used_writer - Variable in class org.locomotive.loco.servlet.LocoServletResponse
 
used_writer - Variable in class org.locomotive.loco.HTTPResponse
 
user - Variable in class org.locomotive.loco.servlet.LocoServlet
the user associated with this request.
user - Variable in class org.locomotive.loco.handler.GenericHandler
the user associated with this request.
user - Variable in class org.locomotive.loco.handler.HandlerData
The current simple user
User - class org.locomotive.loco.User.
The User object encapsulates information stored for a user in the Locomotive User Management system.
User() - Constructor for class org.locomotive.loco.User
create an anonymous User
User(Connection, int) - Constructor for class org.locomotive.loco.User
loads persistant User data from the user database.
User(Connection, int, String, String, int) - Constructor for class org.locomotive.loco.User
creates User and persistantly stores User's data.
User(Connection, int, String, String, String, String, int, int) - Constructor for class org.locomotive.loco.User
Deprecated. thanks to schema changes for the loco_user table. fn, ln, flg are all now ignored.
User(Connection, String) - Constructor for class org.locomotive.loco.User
loads persistant User data from the user database.
User(Connection, String, boolean) - Constructor for class org.locomotive.loco.User
loads persistant User data from the user database.
User(int, String, String, int) - Constructor for class org.locomotive.loco.User
used internally by loadUsers (Connection, int[]) to create the heap of individual User objects.
userId - Variable in class org.locomotive.module.userpref.UserPref
 
UserMgtHandler - class org.locomotive.module.userpref.UserMgtHandler.
A simple User Management System which allows the admin user to view and modify users, user preferences, and permissions.
UserMgtHandler() - Constructor for class org.locomotive.module.userpref.UserMgtHandler
 
UserMgtServlet - class org.locomotive.module.userpref.UserMgtServlet.
A simple User Management System which allows the admin user to view and modify users, user preferences, and permissions.
UserMgtServlet() - Constructor for class org.locomotive.module.userpref.UserMgtServlet
 
userName - Variable in class org.locomotive.module.userpref.UserPref
 
UserNotFoundException - exception org.locomotive.loco.UserNotFoundException.
This is thrown when a user cannot be found in the database.
UserNotFoundException(String) - Constructor for class org.locomotive.loco.UserNotFoundException
 
UserPerm - class org.locomotive.loco.perm.UserPerm.
Maintains users' permissions in the database.
UserPerm() - Constructor for class org.locomotive.loco.perm.UserPerm
 
UserPref - class org.locomotive.module.userpref.UserPref.
This class handles db processing and template interaction (except for saving error messages to template) for UserPref and UserMgt handlers.
UserPref() - Constructor for class org.locomotive.module.userpref.UserPref
 
UserPref(Connection, int) - Constructor for class org.locomotive.module.userpref.UserPref
Inits object from database with userid = userID.
UserPref(int, String) - Constructor for class org.locomotive.module.userpref.UserPref
Returns an object with userId and userName fields
UserPrefHandler - class org.locomotive.module.userpref.UserPrefHandler.
This class must be entered in the handler routing table in order to access the UserPref sample module.
UserPrefHandler() - Constructor for class org.locomotive.module.userpref.UserPrefHandler
 
UserPrefServlet - class org.locomotive.module.userpref.UserPrefServlet.
This class must be entered in the servlet routing table in order to access the UserPref sample module.
UserPrefServlet() - Constructor for class org.locomotive.module.userpref.UserPrefServlet
 
UserStore - class org.locomotive.loco.store.user.UserStore.
 
UserStore() - Constructor for class org.locomotive.loco.store.user.UserStore
 
UserStoreJdbc - class org.locomotive.loco.store.user.UserStoreJdbc.
 
UserStoreJdbc() - Constructor for class org.locomotive.loco.store.user.UserStoreJdbc
 
UserStoreJdbcCloudscape - class org.locomotive.loco.store.user.UserStoreJdbcCloudscape.
 
UserStoreJdbcCloudscape() - Constructor for class org.locomotive.loco.store.user.UserStoreJdbcCloudscape
 
UserStoreJdbcInformix - class org.locomotive.loco.store.user.UserStoreJdbcInformix.
 
UserStoreJdbcInformix() - Constructor for class org.locomotive.loco.store.user.UserStoreJdbcInformix
 
UserStoreJdbcInterbase - class org.locomotive.loco.store.user.UserStoreJdbcInterbase.
 
UserStoreJdbcInterbase() - Constructor for class org.locomotive.loco.store.user.UserStoreJdbcInterbase
 
UserStoreJdbcMysql - class org.locomotive.loco.store.user.UserStoreJdbcMysql.
 
UserStoreJdbcMysql() - Constructor for class org.locomotive.loco.store.user.UserStoreJdbcMysql
 
UserStoreJdbcOracle - class org.locomotive.loco.store.user.UserStoreJdbcOracle.
 
UserStoreJdbcOracle() - Constructor for class org.locomotive.loco.store.user.UserStoreJdbcOracle
 
UserStoreJdbcPostgresql - class org.locomotive.loco.store.user.UserStoreJdbcPostgresql.
 
UserStoreJdbcPostgresql() - Constructor for class org.locomotive.loco.store.user.UserStoreJdbcPostgresql
 
UserStoreJdbcSolid - class org.locomotive.loco.store.user.UserStoreJdbcSolid.
 
UserStoreJdbcSolid() - Constructor for class org.locomotive.loco.store.user.UserStoreJdbcSolid
 
usersWhoHave(Connection, String) - Static method in class org.locomotive.loco.perm.UserPerm
Returns a Vector of userids, which represent the users who have the permission with the specified name.
usersWhoHaveAll(Connection, PermissionSet) - Static method in class org.locomotive.loco.perm.UserPerm
Returns a Vector of userids, which represent the users who have ALL of the permisssions in the specified permission set.
usersWhoHaveAny(Connection, PermissionSet) - Static method in class org.locomotive.loco.perm.UserPerm
Returns a Vector of userids, which represent the users who have any of the permissions in the specified permission set.

V

v - Variable in class org.locomotive.util.SearchableVector
 
value - Variable in class org.locomotive.util.data.StringKey
 
valueBound(HttpSessionBindingEvent) - Method in class org.locomotive.loco.User
If the name of the event is 'locomotive.user', this will go ahead and associate this user with this session in the database.
valueUnbound(HttpSessionBindingEvent) - Method in class org.locomotive.loco.User
We don't really need to do anything here
verifyDomain(String) - Static method in class org.locomotive.util.INet
Verify, via a native DNS call, that the given domain exists.
verifyEmailAddress(String) - Static method in class org.locomotive.util.INet
Expects a full user@domain format address, not just domain.

W

wAddr - Variable in class org.locomotive.module.userpref.UserPref
 
wait_count - Variable in class org.locomotive.loco.servlet.ServletFactory
This variable is used to count how many times this ServletFactory has waited after trying unsuccessfully to instantiate and initialize a servlet.
wait_retries - Variable in class org.locomotive.loco.servlet.ServletFactory
Each class's ServletFactory tries to create servlets this number of times before finally giving up.
WAKE_UP_INTERVAL - Variable in class org.locomotive.util.cache.AlarmThread
 
WARNING - Static variable in class org.locomotive.loco.servlet.LocoServlet
Log level to use for warnings
WARNING - Static variable in class org.locomotive.loco.servlet.MultiThreadedLocoServlet
Log level to use for warnings
WARNING - Static variable in interface org.locomotive.directory.DirectoryEventTypes
Warning - Potential Problem.
WARNING - Static variable in class org.locomotive.server.Log
Potential Problem.
WARNING - Static variable in class org.locomotive.loco.handler.GenericHandler
Log level to use for warnings
wCity - Variable in class org.locomotive.module.userpref.UserPref
 
wCountry - Variable in class org.locomotive.module.userpref.UserPref
 
wipeFromPool(Object) - Method in class org.locomotive.util.ObjectPool
removes the specified object from the pool.
wipeFromPool(Object) - Method in class org.locomotive.loco.servlet.ServletPool
This method overrides ObjectPool.wipeFromPool(Object).
wPhone - Variable in class org.locomotive.module.userpref.UserPref
 
write(byte[]) - Method in class org.locomotive.loco.Response.ResponseOutputStream
 
write(byte[], int, int) - Method in class org.locomotive.loco.Response.ResponseOutputStream
 
write(int) - Method in class org.locomotive.loco.Response.ResponseOutputStream
required
writeHeader(Log) - Method in class org.locomotive.loco.servlet.LocoServletResponse
makes sure the status makes it into the header
writeHeader(Log) - Method in class org.locomotive.loco.Response
This writes the headers to the OutputStream in correct protocol.
writeHeader(Log) - Method in class org.locomotive.loco.HTTPResponse
This writes the headers to the OutputStream in correct protocol.
writeSerializedObjectToDB(String, Object, Object) - Method in class org.locomotive.util.cache.DBCache
 
writeToDB(String, Object, Object) - Method in class org.locomotive.util.cache.DBCache
This method will write an Object into the database, without saving it into the cache.
wState - Variable in class org.locomotive.module.userpref.UserPref
 
wZip - Variable in class org.locomotive.module.userpref.UserPref
 

X

XmlBeanParser - class org.locomotive.directory.XmlBeanParser.
This class is responsible for parsing a single bean configuration file and building the appropriate BeanConfiguration structure.
XmlBeanParser(NameService) - Constructor for class org.locomotive.directory.XmlBeanParser
 
xor(PermissionSet) - Method in class org.locomotive.loco.perm.PermissionSet
'Xors' the PermissionSet with another PermissionSet.

Y

yank() - Method in class org.locomotive.util.FIFO
Grabs the next Object off the FIFO queue.

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