JAVA Annotated TOC

CacheManager

Introduction	Overview of class
CacheManager	Instantiates a CacheManager object.
RecordItem	Records an item as a cache dependency for a page.
flushCSEngine	Clears items from the Content Server cache.
flushSSEngines	Clears items from the CS-Satellite cache.
refreshCSEngine	Rebuilds the Content Server cache.
refreshSSEngines	Rebuilds the CS-Satellite cache.
setByCachedDate	This API is used to populate CacheManager based on the page or a blob creation time.
setByItemDate	This API is used to populate CacheManager based on item modification time. The CacheManager page and blob inventory list is populated based on the modified time specified by the parameter mtime
setPagesByArg	Creates a page inventory list based on a name/value pair.
setPagesByDate	Creates a page inventory list based on the date and time an item is published. This API has been deprecated
setPagesByID	Creates a page inventory list based on an array of IDs.
streamResults	Controls streaming of status codes.

FTVAL

Introduction	Overview of class
GetInt	Returns the integer value associated with this FTVAL object.
GetObj	Returns the data from the specified object.
GetSize	Deprecated as of version 5.0.
GetType	Deprecated as of version 5.0.
getBlob	Gets the value of a blob.
getFile	Gets a file name that holds the data for this FTVAL.
getStream	Returns an input stream
getString	Returns the string associated with this object.
isEmpty	Determines whether the data in this FTVAL object is empty.
length	Returns the length of the value associated with this FTVAL object.
toString	Returns a string representation of an FTVAL object.

FTValList

Introduction	Overview of class
alphaSortedKeys	Returns an enumeration of keys, sorted alphanumerically. This method is thread safe.
copy	Creates a new FTValList that is a copy of this list.
count	Gets the number of items (name/value pairs) in this FTValList.
equals	Overrides the equals method in the java.util.Hashtable class.
get	Returns the value associated with the specified key, regardless of type. Overrides the get method in the java.util.Hashtable class.
getNextKey	Deprecated. As of version 4.0, replaced by keys
getVal	Gets an FTVAL (value) that corresponds to the specified key name.
getValBLOB	Gets the blob (Binary Large Object), of type byte[], that corresponds to the specified key name.
getValBLOBSize	Gets the size of the blob (Binary Large Object) that is associated with the specified key.
getValInt	Gets the integer value associated with the specified key.
getValString	Gets the string value that is associated with the specified key.
keys	Returns an enumeration of key names.
keysVector	Returns a vector of keys.
parse	Converts a string of form "a=b&c=d&..." to an FTValList.
put	Associates a value with a specified key.
remove	Removes one item from this list.
removeAll	Removes all items from this list.
resetPosition	Deprecated as of version 4.0, use keys
setVal	Adds an FTVal object to an FTValList.
setValBLOB	Adds a blob (Binary Large Object) to the FTValList, using the associated key name.
setValBLOBFile	Adds a blob (Binary Large Object) file to the FTValList, using the associated key name.
setValInt	Adds an integer value to an FTValList, by using the associated key name.
setValString	Adds a String value to the FTValList, using the associated key name.
sortedKeys	Returns an enumeration of key names, sorted longest to shortest.

FormPoster

Introduction	Overview of class
addFile	Adds a file (upload file path specification) to the MIME message under construction, as in INPUT TYPE=FILE.
addFileData	Adds file (upload) data.
addTextValue	Adds a name/value pair to the mime message under construction.
addURL	Adds a URL (http:// or https://) to data for multipart posting operations; as in INPUT TYPE=FILE.
cleanRawResponse	Fetches the raw bytes from the output stream and removes the HTTP header.
cleanResponse	Retrieves the response string from the server and removes the HTTP header.
findAllCookies	Finds the cookies in an HTTP response.
findCookie	Finds a specific cookie in the HTTP response, where the cookie name starts with the specified prefix.
getCookieArray	Finds all cookie values in the HTTP response and returns them in an array.
getCookies	Finds all cookie values in the HTTP response and returns them in an FTValList.
getHTTPStatusCode	Retrieves the HTTP status code from the response.
getHTTPStatusText	Retrieves the HTTP status text from the response.
getLastError	Retrieves the last error code set.
getLastErrorStr	Retrieves any coded message from the status code object.
getLastErrorText	Retrieves the text representation of the error returned by getLastError().
getOutputFileSpec	Fetches the specified file that contains the output from a posting operation.
getRawResponse	Fetches the raw bytes from the output stream.
getResponse	Gets the string response from the server after calling post() to post a request.
getServletCookies	Gets cookies set by the CookieServer servlet.
login	Logs a user in or out.
post	Sends a constructed MIME message via an HTTP POST operation.
postProcessMIMEHeader	Post-processes a MIME header after the postconnector reads it.
registerMIMENotifier	Registers an object that supports the IMIMENotifier interface so that it will be called with MIME header information.
reset	Resets for a new posting operation.
setAction	Sets the action for this request.
setAuthenticationParameters	Sets the certificate parameters used to authenticate the server.
setBodyData	Passes a pre-built MIME body for posting.
setBodyStream	Passes a pre-built MIME body for posting.
setCharacterEncoding	Sets the character coding of string values in subsequent calls to FormPoster.addTextValue.
setCookies	Sets a cookie.
setDump	Controls status logging information.
setEncodeURL	Sets the target URL to which the information will ultimately be transmitted via the HTTP GET mechanism.
setHTTPVersion	Sets the HTTP protocol version to use.
setHeaderInformation	Sets the HTTP header.
setLog	Supplies a logging object for special log types.
setOutputDirectory	Sets the directory where the post results output file should be written.
setOutputStream	Sets an output stream to be used for capturing the response.
setPort	Sets the port to be used to connect to the remote HTTP server.
setProxy	Sets the proxy host when a proxy server is needed to post data through a firewall.
setProxyPort	Specifies a proxy server port when a proxy server is needed to post data through a firewall.
setSecureProtocol	Allows you to communicate in secure (HTTPS) mode.
setTimeout	Sets a network timeout.
setURL	Sets the target URL to which the information will ultimately be transmitted via the HTTP POST mechanism.

ICS

Introduction	Overview of class
AppEvent	Creates an event that triggers a registered application logic.
CallElement	Processes the content of an element.
CallSQL	Executes a SQL statement stored in the SystemSQL table.
CatalogDef	Queries a table for its column definition and stores the results in a list.
CatalogManager	Executes a CatalogManager command.
ClearErrno	Clears the current error state.
CommitBatchedCommands	Commits CatalogManager and TreeManager commands queued to the batch context.
CopyList	Copies a list object.
DeleteSynchronizedHash	Deletes a synchronized hash.
DeployJSPData	Deploys the JSP data contained in a buffer.
DeployJSPFile	Deploys a JSP file.
DestroyEvent	Deletes an event.
DisableCache	Disables caching on the ContentServer and EvalServer servlets for the current page evaluation.
DisableEvent	Disables an event.
EmailEvent
EnableEvent	Enables a disabled registered event.
FlushCatalog	Flushes any cached information for a named table.
FlushStream	Flushes the output stream of pending data. Any data in the cache is untouched.
GetBin	Returns the value of a binary posted value.
GetCatalogType	Determines the type of table.
GetCgi	Returns the value of a specified variable.
GetCounter	Gets the value of a counter.
GetErrno	Gets the current error code as an integer.
GetL	Retrieves the IList object for the given list name.
GetObj	Retrieves an object that was saved using SetObj() or PushObj().
GetProperty	Gets a property value from the currently loaded Content Server property files.
GetSSVar	Gets the value of a session variable.
GetSSVars	Returns an enumeration of all session variables.
GetSynchronizedHash	Locates or creates a named synchronized hash.
GetVar	Returns the value of a Content Server variable.
GetVars	Returns an enumeration of all variable names known to Content Server.
IndexAdd	Adds an item to the search index.
IndexCreate	Creates a search index.
IndexDestroy	Deletes a search index.
IndexExists	Checks for the existence of a search index.
IndexRemove	Removes an entry from an existing search index.
IndexReplace	Replaces an existing item in the search index.
InsertPage	Inserts the results of a Content Server page evaluation at the current position in the output stream.
IsElement	Checks for the existence of an element.
IsTracked	Determines whether Content Server is revision tracking the specified table.
LoadProperty	Loads a property file or set of property files.
LogMsg	Logs a message to the Content Server log file.
Mirror	Copies the rows specified in one or more resultsets to a target Content Server repository.
NewSeedFromTagname	Deprecated. As of version 5.0, use runTag
PopObj	Pops the last object with the specified name in the current thread.
PopVars	Pops the variable stack, returning the variables to their previously stacked state.
PushObj	Saves an object by name, and retains any object previously saved by that same name.
PushVars	Saves a copy of all the current variables to a stack.
QueryEvents	Queries for a list of events matching the specified criteria.
RTCommit	Creates a new revision of a record from a revision-tracked table.
RTDeleteRevision	Deletes a revision of a row from a revision-tracked table.
RTHistory	Gets revision history for rows in a revision-tracked table.
RTLock	Locks a record by the current user in a revision-tracked table.
RTRelease	Releases a lock on a row from a revision-tracked table.
RTRetrieveRevision	Returns a specific version for a revision-tracked table.
RTRollback	Reverts a row in a revision-tracked table to a previous revision.
RTSetVersions	Sets the maximum number of revisions stored for each row in a revision-tracked table.
RTTrackTable	Enables revision tracking operations on a table.
RTUnlockRecord	Unlocks a locked row in a revision-revision-tracked table.
RTUntrackTable	Stops tracking a table.
ReadPage
RegisterList	Registers an IList by name with Content Server.
RemoveCounter	Deletes a counter.
RemoveSSVar	Removes a session variable.
RemoveVar	Deletes a variable.
RenameList	Renames a list.
ResolveVariables	Resolves any variable, built-in function, query column value, counter, or property embedded in an input string.
RestoreProperty	Sets the property file to the default Content Server property file (usually futuretense.ini).
RollbackBatchedCommands	Aborts CatalogManager and TreeManager commands that are queued to the Batch Context object.
SQL	Executes a SQL statement.
SQLExp	Creates a string that can be used as part of an SQL WHERE clause.
Search	Searches an index.
SearchDateToNative	Converts a date string formatted in Java SQL to the date format native to the search engine.
SelectTo	Performs a simple query from a table.
SendMail	Sends an SMTP e-mail message to one or more recipients.
SessionExists	Determines whether a session exists.
SessionID	Returns the current session's ID.
SetCookie	Sets a cookie on the client.
SetCounter	Creates a counter, or changes the value of an existing counter.
SetErrno	Sets an error code.
SetObj	Stores an object by name.
SetSSVar	Sets the value of a session variable.
SetVar	Sets a Content Server variable.
StartBatchContext	Fetches the BatchContext object to queue CatalogManager and TreeManager commands.
StreamBinary	Streams binaries immediately to the ICS context.
StreamEvalBytes	Writes a string to the current element evaluation stream.
StreamHeader	Streams header data immediately.
StreamText	Streams text immediately out to the ICS context.
ThrowException	Halts further processing of the current element.
TreeManager	Executes a TreeManager command.
UserIsMember	Determines whether the current user is a member of one or more access groups (ACLs).
clientIsSS	Discovers whether the current request is coming from a browser or from CS-Satellite.
dbDebug	Determines whether database debugging is enabled.
decode	Splits the attribute portion of a URL string into a set of attributes.
diskFileName	Deprecated at 5.0.
encode	Builds an encoded URL string from a set of attributes.
eventDebug	Determines whether event debugging is enabled.
genID	Generates a unique ID.
getComplexError	Gets error details in the form of a COM.FutureTense.Util.ftErrors object.
getIServlet	Returns IServlet functionality.
getLocaleString	Returns a locale-specific string.
ioErrorThrown	Checks to see if an HTTP request has registered an IO error.
isCacheable	Indicates whether the specified page can be cached.
isSystemSecure	Checks to see if the current thread is running with Content Server security on.
literal	Generates a literal value specific to a column in a table.
pageCriteriaKeys	Gets an array of allowable key names for page criteria.
pageURL	Returns the URL of a page, not the whole thread.
pgCacheDebug	Determines whether page cache debugging is enabled.
rsCacheDebug	Indicates whether resultset cache debugging is turned on.
runTag	Calls an XML tag from within a Java program.
sessionDebug	Determines whether session debugging is enabled.
setComplexError	Sets a complex error using the ftErrors class.
synchDebug	Synchs debug flag.
systemDebug	Determines whether debugging is enabled on the Content Server system.
systemSession	Determines whether sessions are enabled on the Content Server system.
timeDebug	Determines whether the time debug flag is set.
xmlDebug	Determines whether XML debugging is enabled.

IDynamicTag

Introduction	Overview of class
endTag	Evaluates the end tag of a dynamic tag.
isCaseSensitive	Checks whether the tag name and attributes are case-sensitive.
setParent	Sets a tag's parent class.
startTag	Evaluates the start tag of a dynamic tag.

IJSPObject

Introduction	Overview of class
getErrorMsg	Returns the last detected error on this IJSPObject.
release	Deletes the JSP file associated with this object.
reloadIfChanged	Reloads the specified JSP object if the source bits have changed.
run	Runs the specified IJSPObject.

IList

Introduction	Overview of class
atEnd	Determines whether a list has reached the last row (at either end) of this list.
clone	Shallow copies this list object.
currentRow	Returns the row number of the current row.
flush	Flushes a list object, destroying any backing data store.
getColumnName	Returns the name of the column at a specified offset.
getFileData	Returns the data contained in a referenced data file.
getFileString	Returns the string data contained in a referenced data file.
getIndirectColumnName	Supplies the upload column name by index.
getName	Retrieves the name of this list.
getObject	Gets an object from the specified column.
getValue	Retrieves the value at the named column of the current row.
hasData	Checks whether this list contains any data.
moveTo	Changes the "current row" to the specified row number.
moveToRow	Changes the "current row" to the specified row position.
numColumns	Gets the number of columns in this list.
numIndirectColumns	Gets the number of columns that are indirect data pointers.
numRows	Gets the number of rows in this list.
rename	Renames this list.
stringInList	Looks for a string within this list.

IManageUsers

Introduction	Overview of class
AddUser	This method is deprecated as of CS Version 4.0.
DeleteUser	This method is deprecated as of CS Version 4.0.
ModifyUser	This method is deprecated as of CS Version 4.0.

IServlet

Introduction	Overview of class
getServlet	Gets the HttpServlet from the current thread.
getServletRequest	Gets the HttpServletRequest from the current thread.
getServletResponse	Gets the HttpServletResponse from the current thread.

ISynchHash

Introduction	Overview of class
clear	Clears a hash and synchronizes the cluster.
get	Gets the specified object from hash and performs required data validation/VM synchronization checks as needed.
getName	Gets the name of the hash as it is managed.
put	Adds an object to the hash and generates appropriate cluster synchronization methods and least-recently-used behavior.
remove	Removes an item from the hash and synchronizes the cluster as needed.

Seed

Introduction	Overview of class
Execute	This method is invoked as a result of the CALLJAVA or a custom tag.

UserError

Introduction	Overview of class
INIFILE_BADPROPERTY	Generates the appropriate UserError to report a bad value for the specified .ini file property.
INIFILE_NOTFOUND	Generates the appropriate UserError to report that a specified .ini file was not found.
INIFILE_NOTSUPPLIED	Generates the appropriate UserError to report that an .ini file was not supplied by ContentServer.
INIFILE_READ	Generates the appropriate UserError to report that a problem occurred reading the specified .ini file.
UNKNOWNCOMMAND	Generates the appropriate UserError to report that a bad command was specified.
UNSUPPORTEDACTION	Generates the appropriate UserError to report that an unsupported action was not performed.
USEREXCEPTION	Generates the appropriate UserError to report that a generic exception was thrown.
USERMANAGER	Reports that an IUsers object was not created.

Utilities

Introduction	Overview of class
appendFile	Appends data to a disk file.
calendarFromJDBCString	Returns a calendar object from JDBC date/time.
createTempFile	Creates a temporary file.
cryptoEnabled	Checks if encryption is enabled.
deBabble	Replaces the character encoding strings--%20 (space), %22 ("), %12 (
decryptString	Decrypts a string.
deleteFile	Deletes a file from disk.
directoryList	Returns a vector of file names in a given directory that satisfy a specified filter pattern.
empty	Deletes the contents of a folder.
encryptString	Encrypts a string.
ensureFolder	Makes sure a folder exists, creating subfolders as needed.
fileExists	Makes sure a file exists.
fileFromSpec	Returns a file from a file specification.
fileLockLoadOK	Checks to see if the file lock native library loaded successfully.
fileName	Creates a full path, including file name, given a folder and file name.
genID	Generates an ID. T
getPOP3Messages	Gets a vector of mail messages from a POP3 server.
getParams	Creates a map or an FTValList from the name/value pairs that you supply.
goodString	Indicates whether a string is not empty or null.
isFile	Verifies the existence of a file.
isFolder	Verifies the existence of a folder (directory).
itemIsInList	Determines if a given string is in a vector.
jdbcDateFromCal	Returns a string containing JDBC-formatted date and time from a calendar object.
jdbcTimeFrom	Returns a JDBC formatted time from a calendar object.
keysFromMap	Returns a string of keys from a Map.
lockFile	Locks a file for exclusive use by this thread.
osIgnoreFileCase	Indicates whether the server's operating system has case-sensitive file system naming.
osSafeSpec	Returns a file specification where the "/" or "" characters have been replaced by the system specific path character.
pathFromSpec	Returns a path from a file specification.
readByteFile	Reads in the file indicated by the passed file path, and returns the bytes.
readByteURL	Reads the passed URL, and returns its bytes.
readFile	Reads a specified file and either returns its contents or writes the bytes to the I/O stream.
readURL	Reads the passed URL, and returns its contents as a string.
replaceAll	Replaces all occurrences in a string of a specified substring with a new string.
sendMail	Sends an SMTP message to one or more recipients.
sortWords	Sorts a list of strings by length, from longest to shortest.
sortWordsAlpha	Sorts a list of strings alphanumerically.
sqlDate	Returns a string formatted as JDBC date/time from a calendar object.
stringFromValList	Creates a URL-like set of name/value pairs from a map.
unlockFile	Unlocks a file from exclusive use by this thread.
unzipFile	Extracts the files contained in a zip file into a specified folder. .
validateZip	Validates the integrity of a zip file.
words	Parses a string into a vector of words. The separator specifies the character that serves as the delimiter between words. White space is removed from both ends of each word parsed, using String.trim().
writeFile	Writes a file to disk, given a path and the contents of the file.