|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Content Server evaluator engine functions. These functions provide an alternative, faster way to interface with Content Server, as well as providing the flexibility and strength of the Java programming language.
Field Summary | |
static java.lang.String |
blobSrvGuid_id
GUID string for the BlobServer |
static java.lang.String |
cacheSrvGuid_id
GUID string for the CacheServer |
static java.lang.String |
catManGuid_id
GUID string for the CatalogManager |
static java.lang.String |
conSrvGuid_id
GUID string for the ContentServer |
static int |
ContentCatalog
|
static java.lang.String |
evalSrvGuid_id
GUID string for the EvalServer |
static int |
ForeignCatalog
|
static int |
HTTPVERSION10
|
static int |
HTTPVERSION11
|
static int |
NoSuchCatalog
Catalog types for use with GetCatalogType |
static int |
ObjectCatalog
|
static java.lang.String |
SQLExpAND
AND type string for use with SQLExp |
static java.lang.String |
SQLExpIN
IN type string for use with SQLExp |
static java.lang.String |
SQLExpOR
OR type string for use with SQLExp |
static int |
SystemCatalog
|
static int |
TempCatalog
|
static int |
TempTreeCatalog
|
static int |
TRACKING_LOCKEDBYOTHER
|
static int |
TRACKING_LOCKEDBYUSER
|
static int |
TRACKING_NOACCESS
|
static int |
TRACKING_NOTLOCKED
|
static int |
TRACKING_NOTTRACKED
|
static int |
TRACKING_UNKNOWN
tracking status codes for getTrackingStatus() |
static int |
TreeCatalog
|
static java.lang.String |
treeManGuid_id
GUID string for the TreeManager |
Method Summary | |
boolean |
AppEvent(java.lang.String name,
java.lang.String guid,
java.lang.String times,
FTValList params)
Create an event which triggers a registered function (via GUID or class) |
boolean |
BlobServer(FTValList args,
COM.FutureTense.Interfaces.IMIMENotifier im,
java.io.OutputStream os)
Invoke the BlobServer to retrieve a blob into an output stream |
boolean |
CallElement(java.lang.String elementname,
FTValList lin)
Executes a registered element. |
IList |
CallSQL(java.lang.String qryname,
java.lang.String listname,
int limit,
boolean bCache,
boolean bLoad,
java.lang.StringBuffer errstr)
Executes a stored SQL statement. |
IList |
CallSQL(java.lang.String qryname,
java.lang.String listname,
int limit,
boolean bLoadCache,
java.lang.StringBuffer errstr)
Executes a stored SQL statement. |
IList |
CatalogDef(java.lang.String from,
java.lang.String listname,
java.lang.StringBuffer errstr)
Queries a catalog for its column definition and stores the results in a list. |
boolean |
CatalogManager(FTValList lin)
Executes the Catalog Manager logic class |
boolean |
CatalogManager(FTValList lin,
java.lang.Object oBatchContext)
Executes the Catalog Manager logic class |
void |
ClearErrno()
Clears the current error code, setting it to 0. |
void |
close()
Method to close and release any resources associated with this object |
boolean |
CommitBatchedCommands(java.lang.Object oBatchContext)
Commit CatalogManager and TreeManager commands queued * to the batch context |
boolean |
CopyList(java.lang.String list,
java.lang.String newname)
Copies a list object. |
boolean |
dbDebug()
Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.DB_DEBUG |
void |
decode(java.lang.String sAttributes,
java.util.Map map)
Method to split the attribute portion of a URL string into a set of attributes. |
boolean |
DeleteSynchronizedHash(java.lang.String name)
Destroy a synchronized hash |
IJSPObject |
deployJSPData(java.lang.String sData,
java.lang.String sZone,
java.lang.StringBuffer sbError)
Deploy JSP data contained in a buffer. |
IJSPObject |
deployJSPFile(java.lang.String sPath,
java.lang.String sZone,
java.lang.StringBuffer sbError)
Deploy a JSP file. |
boolean |
DestroyEvent(java.lang.String name)
Destroy a registered event by name |
void |
DisableCache()
Disables any caching of the current execution thread. |
boolean |
DisableEvent(java.lang.String name)
Disabled a registered event by name |
void |
DisableFragmentCache()
Disable caching on this fragment |
java.lang.String |
diskFileName()
Deprecated. Method is disabled since cached pages are stored in the database now. |
java.lang.String |
diskFileName(java.lang.String pname,
FTValList arguments)
Deprecated. Method is disabled since cached pages are stored in the database now. |
java.lang.String |
diskFileName(java.lang.String pname,
java.lang.String arguments)
Deprecated. Method is disabled since cached pages are stored in the database now. |
boolean |
EmailEvent(java.lang.String name,
java.lang.String tolist,
java.lang.String times,
java.lang.String filespec)
Create an event which triggers an email |
boolean |
EmailEvent(java.lang.String name,
java.lang.String tolist,
java.lang.String times,
java.lang.String filespec,
java.lang.String contenttype,
java.lang.String charset,
FTValList attachments)
Create an event which triggers an email |
boolean |
EnableEvent(java.lang.String name)
Enabled a registered event by name |
java.lang.String |
encode(java.lang.String base,
java.util.Map map,
boolean bSession)
Method to build an encoded URL string from a set of attributes |
boolean |
eventDebug()
Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.EVENT_DEBUG |
boolean |
FlushCatalog(java.lang.String catname)
Flushes any cached information on a named catalog. |
void |
FlushStream()
Flush the output stream of pending data (not stuff in cache for page) |
java.lang.String |
genID(boolean bClusterSafe)
Generate a unique number. |
java.lang.Object |
getAttribute(java.lang.String sName)
Method to get an attribute value from the request |
java.util.Enumeration |
getAttributeNames()
Method to get an enumeration of all the request attribute names |
byte[] |
GetBin(java.lang.String name)
Returns the value of a binary posted value. |
int |
GetCatalogType(java.lang.String catalog)
Gets the type of a catalog. |
FTVAL |
GetCgi(java.lang.String name)
Gets variable value even if the value is binary. |
ftErrors |
getComplexError()
Get error details in the form of COM.FutureTense.Util.ftErrors. |
java.lang.String |
getCookie(java.lang.String sName)
Get the value of a cookie from the header |
int |
GetCounter(java.lang.String counter)
Returns the value of a counter. |
int |
GetErrno()
Returns the current error code as an integer. |
COM.FutureTense.Interfaces.IProperties |
getIProperties()
Return an IProperties object that provides access to the properties that are currently loaded into the CS context. |
IServlet |
getIServlet()
Return the IServlet functionality |
IList |
GetList(java.lang.String listname)
The GetList method retrieves the IList object for the given list name. |
IList |
GetList(java.lang.String listname,
boolean reset)
The GetList method retrieves the IList object for the given list name. |
java.lang.String |
getLocaleString(java.lang.String sName,
java.lang.String sLocale)
Method to get a locale specific string |
java.lang.String |
getNamespace()
The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the generated page. |
java.lang.Object |
GetObj(java.lang.String name)
Retrieve the last object saved earlier in this same thread using #SetObj(String, Object) or #PushObj(String, Object). |
COM.FutureTense.Interfaces.PastramiEngine |
getPastramiEngine()
Method to return a PastramiEngine object based on the value of the propety cs.PastramiEngine or the override class name passed in |
java.lang.String |
GetProperty(java.lang.String name)
Gets a property from the ContentServer property file. |
java.lang.String |
GetProperty(java.lang.String name,
java.lang.String files,
boolean append)
Gets a property from the a property file set. |
COM.FutureTense.Cache.Satellite |
getSatellite(java.lang.String id)
Method to get read-only information about a Satellite server. |
COM.FutureTense.Interfaces.ISearchEngine |
GetSearchEngine(java.lang.String sEngine,
java.lang.String sCharset,
java.lang.StringBuffer errstr)
Get an instance of the specified search engine. |
java.lang.String |
GetSearchEngineList()
Get a string list of the available search engines. |
java.lang.String |
GetSSVar(java.lang.String name)
Returns the value of a session variable. |
java.util.Enumeration |
GetSSVars()
Returns an enumeration of all session variables. |
ISyncHash |
GetSynchronizedHash(java.lang.String name,
boolean bCreate,
int timeout,
int size,
boolean bAbsolute,
boolean bClusterSync)
Locate/create a named synchronized hash |
ISyncHash |
GetSynchronizedHash(java.lang.String name,
boolean bCreate,
int timeout,
int size,
boolean bAbsolute,
boolean bClusterSync,
java.util.Collection linked)
Locate/create a named synchronized hash |
int |
getTrackingStatus(java.lang.String sTable,
java.lang.String sId)
Method to get the tracking status for a row in a table |
java.lang.String |
getURL(com.fatwire.cs.core.uri.Definition definition,
java.lang.String assembler)
Method to generate a URI appropriate for the request |
java.lang.String |
getURL(COM.FutureTense.Interfaces.IURLDefinition oIURLDefinition)
Deprecated. Use #getURI(Definition, String) instead. This method
will be removed after Content Server 6.1 |
java.security.Principal |
getUserPrincipal()
Returns a java.security.Principal object containing the name of the current authenticated user. |
java.lang.String |
GetVar(java.lang.String name)
Returns the value of a variable. |
java.util.Enumeration |
GetVars()
Returns an enumeration of all variables. |
byte[] |
grabCacheStatus()
get the cache status |
FTValList |
grabHeaders()
Get headers set since last call |
boolean |
IndexAdd(java.lang.String sIndex,
java.lang.String sEntryName,
java.lang.String sEntryDetail,
java.lang.String sWordList,
java.lang.String sWordListDelimiters,
java.lang.String sFileList,
java.lang.String sDate,
FTValList vlTextArguments,
FTValList vlFileArguments,
FTValList vlDateArguments,
java.lang.String sEngine,
java.lang.String sCharset,
java.lang.StringBuffer sbError)
Adds an item to the search index. |
boolean |
IndexCreate(java.lang.String sIndex,
FTValList vlFieldArguments,
java.lang.String sEngine,
java.lang.String sCharset,
java.lang.StringBuffer errstr)
Creates a search index. |
boolean |
IndexDestroy(java.lang.String sIndex,
java.lang.String sEngine,
java.lang.String sCharset,
java.lang.StringBuffer sbError)
Deletes a search index. |
boolean |
IndexExists(java.lang.String sIndex,
java.lang.String sEngine,
java.lang.String sCharset,
java.lang.StringBuffer sbError)
Checks for the existence a search index. |
boolean |
IndexRemove(java.lang.String sIndex,
java.lang.String sEntryName,
java.lang.String sEngine,
java.lang.String sCharset,
java.lang.StringBuffer sbError)
Removes a search index entry. |
boolean |
IndexReplace(java.lang.String sIndex,
java.lang.String sEntryName,
java.lang.String sEntryDetail,
java.lang.String sWordList,
java.lang.String sWordListDelimiters,
java.lang.String sFileList,
java.lang.String sDate,
FTValList vlTextArguments,
FTValList vlFileArguments,
FTValList vlDateArguments,
java.lang.String sEngine,
java.lang.String sCharset,
java.lang.StringBuffer sbError)
Replaces an item in the search index. |
boolean |
InsertPage(java.lang.String pagename,
FTValList lin)
Invokes a page inline with the current evaluation. |
boolean |
ioErrorThrown()
Check to see if the http request has registered an io error ie broken pipe |
boolean |
isCacheable(java.lang.String pagename)
Determine if a page is set to cache at this time. |
boolean |
IsElement(java.lang.String element)
Checks for the existance of an element. |
boolean |
IsSystemSecure()
Return if the current thread is running with CS security on or off - depends on property file setting and if off, no access restrictions will be in place at the core catalog level |
boolean |
IsTracked(java.lang.String catalog)
Checks if a catalog is revision tracked. |
java.lang.String |
literal(java.lang.String sTable,
java.lang.String sColumn,
java.lang.String sValue)
Generates a literal value specific to a column in a table. |
boolean |
LoadProperty(java.lang.String name)
Loads a new property set into the system. |
void |
LogMsg(java.lang.String msg)
Deprecated. Use Apache's commons-logging module instead. Logger names are identified in ftMessage |
int |
Mirror(java.util.Vector vILists,
java.lang.String sTarget,
java.lang.String sUsername,
java.lang.String sPassword,
java.lang.String sCGIPrefix,
java.lang.String sTargetIniFile,
int nPort,
boolean bUseProxy,
boolean bUseHTTPS,
int nHTTPVersion,
java.lang.StringBuffer sbOutput)
Mirrors a result set. |
int |
Mirror(java.util.Vector vILists,
java.util.Vector vTreeList,
java.lang.String sTarget,
java.lang.String sUsername,
java.lang.String sPassword,
java.lang.String sCGIPrefix,
java.lang.String sTargetIniFile,
int nPort,
boolean bUseProxy,
boolean bUseHTTPS,
int nHTTPVersion,
java.lang.StringBuffer sbOutput)
Mirrors a result set. |
Seed |
NewSeedFromTagname(java.lang.String tagname)
Deprecated. use ICS.runTag(String, FTValList) instead |
java.lang.String[] |
pageCriteriaKeys(java.lang.String pagename)
Get a String array of page criteria allowable keynames |
java.lang.String |
pageURL()
Return the 'url' of the current execution instance (page) NOT whole thread |
java.lang.String |
pageURL(java.lang.String pname,
FTValList arguments)
Return the 'url' of the current execution instance (page) NOT whole thread |
boolean |
pastramiDebug()
Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.GENERIC_DEBUG |
boolean |
pgCacheDebug()
Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.PAGE_CACHE_DEBUG |
java.lang.Object |
PopObj(java.lang.String name)
Pop the last object saved earlier in this same thread by a given name. |
void |
PopVars()
Pops the variable stack, returning the variables to their previously stacked state. |
boolean |
PushObj(java.lang.String name,
java.lang.Object value)
Save an object by name, and retain any object previously saved by that same name. |
void |
PushVars()
Saves a copy of all the current variables to a stack. |
IList |
QueryEvents(java.lang.String sNamePattern,
java.lang.String sType,
java.lang.Boolean bEnabled,
java.lang.String sList)
Attempt to query for a list of matching events |
IList |
ReadEvent(java.lang.String sEvent,
java.lang.String sList)
Attempt to read an event record |
java.lang.String |
ReadPage(java.lang.String pagename,
FTValList lin)
Invokes a page inline with the current evaluation. |
boolean |
RegisterList(java.lang.String listname,
IList ilist)
Register an IList object with CS for use in XML tagging; this assumes that the IList was created in a manner that did not implicitly register the name, as would be the case with the listname parameter to SQL(), SelectTo(), etc. |
void |
removeAttribute(java.lang.String sName)
Method to remove an attribute from the request |
void |
RemoveCounter(java.lang.String name)
Remove counter |
void |
RemoveSSVar(java.lang.String name)
Removes a session variable. |
void |
RemoveVar(java.lang.String name)
Removes a variable. |
boolean |
RenameList(java.lang.String list,
java.lang.String newname)
Renames a list object. |
java.lang.String |
ResolveVariables(java.lang.String st)
Resolves any variable, query column value, counter or property in this string. |
java.lang.String |
ResolveVariables(java.lang.String st,
boolean bNew)
Resolves any variable, query column value, counter or property in this string. |
boolean |
RestoreProperty(boolean bClose)
Restores the previous property set into the system. |
boolean |
RollbackBatchedCommands(java.lang.Object oBatchContext)
Abort CatalogManager and TreeManager commands queued * to the batch context |
boolean |
rsCacheDebug()
Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.RESULT_SET_CACHE_DEBUG |
int |
RTCommit(java.lang.String sTable,
java.lang.String sAsset,
java.lang.String sAnnotation,
boolean bKeepLocked)
Creates a new revision of a record from a tracked table. |
int |
RTDeleteRevision(java.lang.String sTable,
java.lang.String sAsset,
int nVersion)
Deletes a revision of a row from a tracked table. |
IList |
RTHistory(java.lang.String sTable,
java.lang.String sAsset,
java.lang.String sVersion,
java.lang.String sLocker,
java.lang.String sCreator,
java.lang.String sAnnotation,
java.lang.String sListName)
Returns revision history for rows in a revision tracked table. |
IList |
RTInfo(java.lang.String sTable,
java.lang.String sListName)
Returns information on tracked tables from the RTInfo table |
int |
RTLock(java.lang.String sTable,
java.lang.String sAsset)
Locks a record by the current user in a tracked table. |
int |
RTRelease(java.lang.String sTable,
java.lang.String sAsset)
Release a lock on a row from a tracked table. |
IList |
RTRetrieveRevision(java.lang.String strTableName,
java.lang.String strAsset,
int nVersion,
java.lang.String listName)
This method returns a specific version for a tracked table. |
IList |
RTRetrieveRevision(java.lang.String strTableName,
java.lang.String strAsset,
java.lang.String strVersion,
java.lang.String listName)
This method returns a specific version for a tracked table. |
int |
RTRollback(java.lang.String sTable,
java.lang.String sAsset,
int nVersion)
Reverts a row in a tracked table to a previous revision. |
int |
RTRollback(java.lang.String sTable,
java.lang.String sAsset,
java.lang.String strVersion)
Reverts a row in a tracked table to a previous revision. |
int |
RTSetVersions(java.lang.String sTable,
int nVersions)
Sets the number of revisions stored for each row in a tracked table. |
int |
RTTrackTable(java.lang.String sTable,
java.lang.String sStorage,
int nVersions)
Enables revision tracking operations on a table. |
int |
RTUnlockRecord(java.lang.String sTable,
java.lang.String sAsset)
Unlocks a locked row. |
int |
RTUntrackTable(java.lang.String sTable)
Stops tracking a table. |
java.lang.String |
runTag(java.lang.String sTag,
FTValList vIn)
Method to execute a simple XML tag by name. |
IList |
Search(java.lang.String sIndex,
java.lang.String sWhat,
java.lang.String sRelevence,
java.lang.String sQueryParser,
int nMaxResults,
FTValList vlAdditionalIndexes,
java.lang.String sList,
java.lang.String sEngine,
java.lang.String sCharset,
java.lang.StringBuffer sbError)
Searches an index. |
boolean |
SearchDateToNative(java.lang.String sDate,
java.lang.StringBuffer sbOut,
java.lang.String sEngine,
java.lang.String sCharset,
java.lang.StringBuffer sbError)
Converts a javaSQL date string to native search engine format. |
IList |
SelectTo(java.lang.String from,
java.lang.String what,
java.lang.String where,
java.lang.String orderby,
int limit,
java.lang.String listname,
boolean bCache,
java.lang.StringBuffer errstr)
Performs a simple query by specifing a list of column names to return, and a list of column names to use as filtering. |
boolean |
SendMail(java.lang.String to,
java.lang.String subject,
java.lang.String body)
Sends an email to the specified address. |
boolean |
SendMail(java.lang.String to,
java.lang.String subject,
java.lang.String body,
java.lang.String replyto,
java.lang.String contenttype)
Sends an email to the specified address. |
boolean |
SendMail(java.lang.String to,
java.lang.String subject,
java.lang.String body,
java.lang.String replyto,
java.lang.String contenttype,
java.lang.String charset,
FTValList attachments)
Sends an email to the specified address. |
boolean |
sessionDebug()
Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.SESSION_DEBUG |
boolean |
SessionExists(java.lang.String id)
Deprecated. this always returns false |
java.lang.String |
SessionID()
Find out the session id being used by this user session. |
void |
setAttribute(java.lang.String sName,
java.lang.Object oValue)
Method to set an attribute for the request |
void |
setComplexError(ftErrors error)
Set a complex error using COM.FutureTense.Util.ftErrors |
boolean |
SetCookie(java.lang.String name,
java.lang.String value,
int timeout,
java.lang.String url,
java.lang.String domain,
boolean bSecure)
Sets or removes a cookie. |
void |
SetCounter(java.lang.String counter,
int value)
Set a counter |
void |
SetErrno(int i)
Set the current error code as an integer. |
boolean |
SetObj(java.lang.String name,
java.lang.Object value)
Save an object by name. |
void |
SetSSVar(java.lang.String name,
int value)
Sets a session variable to the specified value. |
void |
SetSSVar(java.lang.String name,
java.lang.String value)
Sets a session variable to the specified value. |
void |
SetVar(java.lang.String name,
FTVAL value)
Sets a variable to the specified value. |
void |
SetVar(java.lang.String name,
int value)
Sets a variable to the specified value. |
void |
SetVar(java.lang.String name,
java.lang.String value)
Sets a variable to the specified value. |
IList |
SQL(com.fatwire.cs.core.db.PreparedStmt stmt,
com.fatwire.cs.core.db.StatementParam data,
boolean bCache)
Executes a given PreparedStmt with supplied data; returns data in the form of an IList. |
IList |
SQL(java.lang.String from,
java.lang.String sqlstmt,
java.lang.String listname,
int limit,
boolean bCache,
boolean bLoad,
java.lang.StringBuffer errstr)
Executes an SQL statement. |
IList |
SQL(java.lang.String from,
java.lang.String sqlstmt,
java.lang.String listname,
int limit,
boolean bLoadCache,
java.lang.StringBuffer errstr)
Executes an SQL statement. |
java.lang.String |
SQLExp(java.lang.String table,
java.lang.String type,
java.lang.String verb,
java.lang.String arg,
java.lang.String column)
Generates an expression for an SQL WHERE clause |
java.lang.String |
SQLExp(java.lang.String table,
java.lang.String type,
java.lang.String verb,
java.lang.String arg,
java.lang.String column,
java.lang.String expression)
Generates an expression for an SQL WHERE clause |
java.lang.Object |
StartBatchContext()
Fetch Batch context object to queue CatalogManager and TreeManager commands |
void |
StreamBinary(byte[] b,
int offset,
int length)
Immediately streams binary out to the ICS context (RIGHT NOW). |
void |
StreamEvalBytes(java.lang.String msg)
Writes a string to the current element evaluation stream; it will be appended to the current element output buffer. |
void |
StreamHeader(java.lang.String header,
java.lang.String text)
Immediately stream header data. |
void |
StreamText(java.lang.String text)
Immediately streams text out to the ICS context (RIGHT NOW). |
boolean |
syncDebug()
Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.SYNC_DEBUG |
boolean |
systemDebug()
Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.GENERIC_DEBUG |
boolean |
systemSession()
Are sessions enabled? |
void |
ThrowException()
Interface to xml THROWEXCEPTION functionality - this effects the entire thread ie http request |
boolean |
timeDebug()
Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.TIME_DEBUG |
boolean |
TreeManager(FTValList lin)
Executes the Tree Manager logic class |
boolean |
TreeManager(FTValList lin,
java.lang.Object oBatchContext)
Executes the Tree Manager logic class |
boolean |
UserIsMember(java.lang.String grouplist)
Determines if the currently logged in user is a member of a supplied group. |
boolean |
xmlDebug()
Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.XML_DEBUG |
Field Detail |
public static final int HTTPVERSION10
public static final int HTTPVERSION11
public static final java.lang.String conSrvGuid_id
public static final java.lang.String catManGuid_id
public static final java.lang.String treeManGuid_id
public static final java.lang.String blobSrvGuid_id
public static final java.lang.String evalSrvGuid_id
public static final java.lang.String cacheSrvGuid_id
public static final java.lang.String SQLExpAND
public static final java.lang.String SQLExpOR
public static final java.lang.String SQLExpIN
public static final int NoSuchCatalog
public static final int SystemCatalog
public static final int ContentCatalog
public static final int ForeignCatalog
public static final int TreeCatalog
public static final int ObjectCatalog
public static final int TempCatalog
public static final int TempTreeCatalog
public static final int TRACKING_UNKNOWN
public static final int TRACKING_NOTTRACKED
public static final int TRACKING_NOTLOCKED
public static final int TRACKING_LOCKEDBYOTHER
public static final int TRACKING_LOCKEDBYUSER
public static final int TRACKING_NOACCESS
Method Detail |
public void PushVars()
PopVars()
public void PopVars()
PushVars()
public void SetVar(java.lang.String name, java.lang.String value)
This method provides the same functionality as the XML <SETVAR> command.
name
- The name of the variable you wish to set.value
- The value to set the variable to.GetVar(String)
,
RemoveVar(String)
public boolean SetObj(java.lang.String name, java.lang.Object value)
name
- name of objectvalue
- object to save, setting to null removes object
GetObj(String)
,
PopObj(String)
,
PushObj(String, Object)
public java.lang.Object GetObj(java.lang.String name)
name
- name of object
PopObj(String)
,
PushObj(String, Object)
,
SetObj(String, Object)
public java.lang.Object PopObj(java.lang.String name)
name
- String name of the object
GetObj(String)
,
PushObj(String, Object)
,
SetObj(String, Object)
public boolean PushObj(java.lang.String name, java.lang.Object value)
name
- String name of the objectvalue
- Object to be pushed
GetObj(String)
,
PopObj(String)
,
SetObj(String, Object)
public java.lang.String GetVar(java.lang.String name)
This method provides the same functionality as the XML <CSVAR> command.
name
- The name of the variable.
SetVar(String, String)
,
SetVar(String, int)
,
RemoveVar(String)
public byte[] GetBin(java.lang.String name)
name
- The name of the variable.
public int GetCounter(java.lang.String counter) throws java.lang.Exception
counter
- name
java.lang.Exception
- if failurepublic void SetCounter(java.lang.String counter, int value) throws java.lang.Exception
counter
- namevalue
- integer value
java.lang.Exception
- if failurepublic void RemoveCounter(java.lang.String name)
name
- of counterpublic java.util.Enumeration GetVars()
for(Enumeration e=cs.GetVars(); e.hasMoreElements();)
String value = GetVar(e.nextElement());
SetVar(String, String)
,
SetVar(String, int)
,
GetVar(String)
,
RemoveVar(String)
public void SetVar(java.lang.String name, int value)
This method provides the same functionality as the XML <SETVAR> command.
name
- The name of the variable you wish to set.value
- The value to set the variable to.GetVar(String)
,
RemoveVar(String)
public void RemoveVar(java.lang.String name)
This method provides the same functionality as the XML <REMOVEVAR> command.
name
- The name of the variable to delete.SetVar(String, String)
,
SetVar(String, int)
,
GetVar(String)
public void SetSSVar(java.lang.String name, java.lang.String value)
This method provides the same functionality as the XML <SETSSVAR> command.
name
- The name of the session variable you wish to set.value
- The value to set the session variable to.GetSSVar(String)
,
RemoveSSVar(String)
public java.lang.String GetSSVar(java.lang.String name)
This method provides the same functionality as the XML <CSVAR> command.
name
- The name of the session variable.
SetSSVar(String, String)
,
SetSSVar(String, int)
,
RemoveSSVar(String)
public java.util.Enumeration GetSSVars()
SetSSVar(String, String)
,
SetSSVar(String, int)
,
GetSSVar(String)
,
RemoveSSVar(String)
public void SetSSVar(java.lang.String name, int value)
This method provides the same functionality as the XML <SETSSVAR> command.
name
- The name of the session variable you wish to set.value
- The value to set the session variable to.GetSSVar(String)
,
RemoveSSVar(String)
public void RemoveSSVar(java.lang.String name)
This method provides the same functionality as the XML <REMOVESSVAR> command.
name
- The name of the session variable to delete.SetSSVar(String, String)
,
SetSSVar(String, int)
,
GetSSVar(String)
public java.lang.String SessionID()
public boolean IsSystemSecure()
public void SetVar(java.lang.String name, FTVAL value)
name
- The name of the variable you wish to set.value
- The value to set the variable to.GetCgi(String)
,
RemoveVar(String)
public FTVAL GetCgi(java.lang.String name)
name
- The name of the variable you wish to get.
GetVar(String)
,
SetVar(String, FTVAL)
public java.lang.String GetProperty(java.lang.String name)
This method provides the same functionality as the XML <CSVAR NAME="CS.Property.PROPERTY_NAME"/> command.
name
- The name of the property you wish to get.
GetProperty(String, String, boolean)
,
LoadProperty(String)
,
RestoreProperty(boolean)
public java.lang.String GetProperty(java.lang.String name, java.lang.String files, boolean append)
This method provides the same functionality as the XML <CSVAR NAME="CS.Property.PROPERTY_NAME"/> command.
name
- The name of the property you wish to get.files
- The semicolon separated list of property files.append
- Set to true to append to the current property files.
GetProperty(String)
,
LoadProperty(String)
,
RestoreProperty(boolean)
public boolean IsElement(java.lang.String element)
This method provides the same functionality as the XML <IF COND="IsElement.ELEMENT_NAME=true"/> command.
element
- The name of the element.
public int GetCatalogType(java.lang.String catalog)
This method provides the similar functionality as the XML <IF COND="IsTree.CATALOG_NAME=true"/> commands.
catalog
- The name of the catalog.
public boolean IsTracked(java.lang.String catalog)
catalog
- The name of the catalog.
public int getTrackingStatus(java.lang.String sTable, java.lang.String sId)
sTable
- name of the tablesId
- row identifier
public boolean FlushCatalog(java.lang.String catname)
This method is analogous to the XML <FLUSH> command.
catname
- The name of the catalog to flush.
public int GetErrno()
ClearErrno()
public ftErrors getComplexError()
ftErrors.getError()
,
ftErrors.detail(int)
(with ftErrors.details()
) and ftErrors.getReason()
.
ftErrors.getError()
,
ftErrors.getReason()
,
ftErrors.details()
,
ftErrors.detail(int)
public void setComplexError(ftErrors error)
error
- ftErrors error objectpublic void SetErrno(int i)
i
- the integer error code to setClearErrno()
,
GetErrno()
public void ClearErrno()
GetErrno()
public java.lang.String ResolveVariables(java.lang.String st)
This method has similar functionality to the XML <CSVAR> command.
st
- The String to resolve variable references for.
public java.lang.String ResolveVariables(java.lang.String st, boolean bNew)
This method has similar functionality to the XML <CSVAR> command.
st
- The String to resolve variables forbNew
- true to use the newer variable resolution syntax, false to use the older.
public IList SelectTo(java.lang.String from, java.lang.String what, java.lang.String where, java.lang.String orderby, int limit, java.lang.String listname, boolean bCache, java.lang.StringBuffer errstr)
This method is analogous to the XML <SELECTO> command.
from
- Tablename to select.what
- Column list, as in "tblname,systable"; * is all columns.where
- Comma-separated list of catalog columns to select against. For each item in the WHERE
string, the value of the corresponding variable is used to construct a SQL WHERE
clause.orderby
- Column list defining the ordering of the results.limit
- Maximum number of results, -1 means no limit.listname
- List name to present to XML side for processing; if
null is passed, a generic name will be assigned.bCache
- True to cache the results; false otherwise.errstr
- For return values; may contain error information.
CallSQL(String, String, int, boolean, boolean, StringBuffer)
,
SQL(String, String, String, int, boolean, boolean, StringBuffer)
public IList CallSQL(java.lang.String qryname, java.lang.String listname, int limit, boolean bLoadCache, java.lang.StringBuffer errstr)
This method is analagous to the XML <CALLSQL> command.
qryname
- The name of the SQL element
in the SystemSQL table.listname
- List name to present to XML side for processing; if
null is passed, a generic name will be assigned.limit
- Maximum number of results, -1 means no limit.bLoadCache
- True to completely load and cache the result set;
otherwise the database connection is left open.errstr
- For return values; may contain error information.
SelectTo(String, String, String, String, int, String, boolean,
StringBuffer)
,
SQL(String, String, String, int, boolean, boolean, StringBuffer)
public IList CallSQL(java.lang.String qryname, java.lang.String listname, int limit, boolean bCache, boolean bLoad, java.lang.StringBuffer errstr)
This method is analagous to the XML <CALLSQL> command.
qryname
- The name of the SQL element
in the SystemSQL table.listname
- List name to present to XML side for processing; if
null is passed, a generic name will be assigned.limit
- Maximum number of results, -1 means no limit.bCache
- True to cache the result set; false otherwise.bLoad
- True to completely load the result set; otherwise
the database connection is left open.errstr
- For return values; may contain error information.
SelectTo(String, String, String, String, int, String, boolean,
StringBuffer)
,
SQL(String, String, String, int, boolean, boolean, StringBuffer)
public IList SQL(java.lang.String from, java.lang.String sqlstmt, java.lang.String listname, int limit, boolean bLoadCache, java.lang.StringBuffer errstr)
This method is analgous to the XML <EXECSQL> command.
from
- Comma separated list of table names this query will be cached againstsqlstmt
- The SQL statement to execute.listname
- List name to present to XML side for processing; if
null is passed, a generic name will be assigned.limit
- Maximum number of results, -1 means no limit.bLoadCache
- True to completely load and cache the result set;
otherwise the database connection is left open.errstr
- For return values; may contain error information.
public IList SQL(java.lang.String from, java.lang.String sqlstmt, java.lang.String listname, int limit, boolean bCache, boolean bLoad, java.lang.StringBuffer errstr)
This method is analgous to the XML <EXECSQL> command.
from
- Comma separated list of table names this query will be cached againstsqlstmt
- The SQL statement to execute.listname
- List name to present to XML side for processing; if
null is passed, a generic name will be assigned.limit
- Maximum number of results, -1 means no limit.bCache
- True to cache the result set; false otherwise.bLoad
- True to completely load the result set; otherwise
the database connection is left open.errstr
- For return values; may contain error information.
public IList SQL(com.fatwire.cs.core.db.PreparedStmt stmt, com.fatwire.cs.core.db.StatementParam data, boolean bCache)
stmt
- Instance of PreparedStmt that will be executed (aftre resolving all SQL types for its placeholders)data
- Instance of StatementParam belonging to the PreparedStmt. null is acceptable when PreparedStmt
instance contains no placeholders (no ? characters in its statement).bCache
- true to cache the result set; false otherwise (data will always be read from cache, when
available, regardless of the value for bCache.
java.lang.IllegalArgumentException
- - if PreparedStmt, StatementParam are null (when not allowed) or
incomplete (isComplete() = false) or number of placeholders are not equal
( PreparedStmt.getNumberOfPostions != StatementParam.getNumberOfPostions)
IllegalStateException - if the current user does not have permission (ACLs) to the tables used in
the prepared statement or if table/column name specified could not be found.
app.setError() is set for situations that results in any of these errors.
RuntimeException if execution of statement fails.
Exceptions simply communicate the failure to the caller.
***************** Important Note *********************
Usage of this API is slightly different from other database accesss methods in this class.
Please consider the following before using this method.
public java.lang.String literal(java.lang.String sTable, java.lang.String sColumn, java.lang.String sValue)
sTable
- the table which contains the columnsColumn
- the name of the columnsValue
- the value to be converted to a literal
SQLExp(String, String, String, String, String)
,
SQLExp(String, String, String, String, String, String)
public java.lang.String SQLExp(java.lang.String table, java.lang.String type, java.lang.String verb, java.lang.String arg, java.lang.String column)
This method is analgous to the XML <SQLExp> command.
table
- The table for which the statement is being executed.type
- The expression type. Legal values are:
verb
- The verb for the where clause (e.g. "LIKE", "=", "!=", "IN", "NOT IN")arg
- Comma separated list of values for the expressioncolumn
- The column for which the expression is being generated
public java.lang.String SQLExp(java.lang.String table, java.lang.String type, java.lang.String verb, java.lang.String arg, java.lang.String column, java.lang.String expression)
This method is analgous to the XML <SQLExp> command.
table
- The table for which the statement is being executed.type
- The expression type. Legal values are:
verb
- The verb for the where clause (e.g. "LIKE", "=", "!=", "IN", "NOT IN")arg
- Comma separated list of values for the expressioncolumn
- The column for which the expression is being generatedexpression
- The optional column expression for which the expression is being generated
public IList CatalogDef(java.lang.String from, java.lang.String listname, java.lang.StringBuffer errstr)
This method is analagous to the XML <CATALOGDEF> command.
from
- The name of the catalog.listname
- List name to present to XML side for processing; if
null is passed, a generic name will be assigned.errstr
- For return values; may contain error information.
public IList GetList(java.lang.String listname)
listname
- The name of the list you wish to return.
GetList(String, boolean)
,
RegisterList(String, IList)
public IList GetList(java.lang.String listname, boolean reset)
listname
- The name of the list you wish to return.reset
- set to true to position at first row, otherwise
the current list position will be maintained.
GetList(String)
,
RegisterList(String, IList)
public boolean RenameList(java.lang.String list, java.lang.String newname)
Renaming to a list that already exists destroys the existing list. Cached resultsets corresponding to the list, however, are not destroyed, and are accesible to other threads. To delete cached resultsets, use FlushCatalog(String).
list
- The list to rename.newname
- The new name for the list.
public boolean CopyList(java.lang.String list, java.lang.String newname)
Copying to a list that already exists destroys the existing list. Cached resultsets corresponding to the list, however, are not destroyed, and are accesible to other threads. To delete cached resultsets, use FlushCatalog(String).
list
- The list to copy.newname
- The new name for the list.
public boolean CatalogManager(FTValList lin)
This method is analogous to the XML <CATALOGMANAGER> command.
lin
- FTValList values to use for new engine, a null indicates to use
CGI values of Content Server
public boolean CatalogManager(FTValList lin, java.lang.Object oBatchContext)
This method is analogous to the XML <CATALOGMANAGER> command.
lin
- FTValList values to use for new engine, a null indicates to use
CGI values of Content ServeroBatchContext
- Object handle to the batch context object
public boolean TreeManager(FTValList lin)
This method is analogous to the XML <TREEMANAGER> command.
lin
- FTValList values to use for new engine, a null indicates to use
CGI values of Content Server
public boolean TreeManager(FTValList lin, java.lang.Object oBatchContext)
This method is analogous to the XML <TREEMANAGER> command.
lin
- FTValList values to use for new engine, a null indicates to use
CGI values of Content ServeroBatchContext
- Object handle to the batch context object
public boolean CallElement(java.lang.String elementname, FTValList lin)
This method is analogous to the XML <CALLELEMENT> command.
elementname
- The name of the element to call.lin
- Name/value pairs to be passed to the element as arguments.
public void StreamEvalBytes(java.lang.String msg)
msg
- String msgpublic java.lang.String ReadPage(java.lang.String pagename, FTValList lin)
This method is similar to the XML <INSERT> command.
pagename
- pagename entry in the SiteCatalog.lin
- Name/Value pairs to be passed as input parameters to the page.
public boolean InsertPage(java.lang.String pagename, FTValList lin)
This method is similar to the XML <INSERT> command.
pagename
- pagename entry in the SiteCatalog.lin
- Name/Value pairs to be passed as input parameters to the page.
public Seed NewSeedFromTagname(java.lang.String tagname)
tagname
- (caseless)
runTag(String, FTValList)
public java.lang.String runTag(java.lang.String sTag, FTValList vIn)
sTag
- name of the tagvIn
- input key/value pairs
public void StreamText(java.lang.String text)
Bytes that are output through this method are not subject to page caching.
text
- The text to stream.public void FlushStream()
public void StreamBinary(byte[] b, int offset, int length)
Bytes that are output through this method are not subject to page caching.
b
- byte array to streamoffset
- offset into byte arraylength
- number of bytes to streampublic void StreamHeader(java.lang.String header, java.lang.String text)
header
- String name of header (ie content-type)text
- String header data (ie image/gif)public FTValList grabHeaders()
public byte[] grabCacheStatus()
public boolean LoadProperty(java.lang.String name)
This method is analogous to the XML <LOADPROPERTY> command.
name
- The name of the property set to load (i.e. "futuretense.ini").
public boolean RestoreProperty(boolean bClose)
This method is analogous to the XML <RESTOREPROPERTY> command.
bClose
- Whether to close the connection to a database opened using
the current properties.
Possible values are "true" or "false". If bClose is set to "true" any open database
connection specified by the current properties will be closed before
restoring the defaults.
This invalidates any resultsets cached against that database. If
access to those resultsets is required after restoreProperty(), bClose
should be set to "false". This will keep the connection open and
resultsets against the database will be available.
public java.lang.String getCookie(java.lang.String sName)
sName
- cookie name
public boolean SetCookie(java.lang.String name, java.lang.String value, int timeout, java.lang.String url, java.lang.String domain, boolean bSecure)
This method is analogous to the XML <REMOVECOOKIE> , <SETCOOKIE> command.
name
- The name of the cookie you wish to set.value
- The value to set the cookie to. Setting the value to
null REMOVES the cookie.timeout
- The timeout period for the cookie on the client,
in seconds.url
- Valid URL. This value restricts the sending of the cookie
from the client to this URL only.
Defaults to "/" if omitted.domain
- Valid domain name. This value restricts the sending
of the cookie from the client to
addresses in this domain only.bSecure
- Indicates whether security is set on this cookie.
public void DisableCache()
public boolean SendMail(java.lang.String to, java.lang.String subject, java.lang.String body, java.lang.String replyto, java.lang.String contenttype, java.lang.String charset, FTValList attachments)
This method is analogous to the XML <SENDMAIL> command.
to
- A valid TO value, i.e. "joe@somecompany.com".subject
- The subject of the message. May be null if the body
is not null.body
- The message body. May be null if the subject is not null.replyto
- The replyto address for the message. May be null to use
the same address as from.contenttype
- The content-type for the message. May be null to
default to text/plaincharset
- The charset for the message. May be null if body contains only US-ASCII characters or contenttype contains charset.attachments
- The attachments associated with this message. Attachmaent names are passed as keys and actual attachments are passed as values, each attachment is encapsulated in object FTVAL.
public boolean SendMail(java.lang.String to, java.lang.String subject, java.lang.String body, java.lang.String replyto, java.lang.String contenttype)
This method is analogous to the XML <SENDMAIL> command.
to
- A valid TO value, i.e. "joe@somecompany.com".subject
- The subject of the message. May be null if the body
is not null.body
- The message body. May be null if the subject is not null.replyto
- The replyto address for the message. May be null to use
the same address as from.contenttype
- The content-type for the message. May be null to
default to text/plain
public boolean SendMail(java.lang.String to, java.lang.String subject, java.lang.String body)
This method is analogous to the XML <SENDMAIL> command.
to
- A valid TO value, i.e. "joe@somecompany.com".subject
- The subject of the message. May be null if the body
is not null.body
- The message body. May be null if the subject is not null.
public boolean UserIsMember(java.lang.String grouplist)
This method is analogous to the XML <USERISMEMBER> command.
grouplist
- A comma seperated list of groups to check against.
public void LogMsg(java.lang.String msg)
ftMessage
This method is analogous to the XML <LOGMSG> command.
Messages are logged to the generic logger with a severity of INFO.
msg
- The message to send to the Content Server log file.public COM.FutureTense.Interfaces.ISearchEngine GetSearchEngine(java.lang.String sEngine, java.lang.String sCharset, java.lang.StringBuffer errstr)
This method is currently for internal use only.
sEngine
- Search engine name. May be null.sCharset
- Search index charset. May be null.errstr
- For return values; may contain error information.
public java.lang.String GetSearchEngineList()
This method is currently for internal use only.
public boolean IndexCreate(java.lang.String sIndex, FTValList vlFieldArguments, java.lang.String sEngine, java.lang.String sCharset, java.lang.StringBuffer errstr)
This method is analogous to the XML <INDEXCREATE> command.
sIndex
- Full path name to the index to create. May be null.vlFieldArguments
- Field argument names and values. May be null.sEngine
- Search engine name. May be null.sCharset
- Search index charset. May be null.errstr
- For return values; may contain error information.
public boolean IndexDestroy(java.lang.String sIndex, java.lang.String sEngine, java.lang.String sCharset, java.lang.StringBuffer sbError)
This method is analogous to the XML <INDEXDESTROY> command.
sIndex
- Search index to destroy. May be null.sEngine
- Search engine name. May be null.sCharset
- Search index charset. May be null.sbError
- For return values; may contain error information.
public boolean IndexExists(java.lang.String sIndex, java.lang.String sEngine, java.lang.String sCharset, java.lang.StringBuffer sbError)
This method is analogous to the XML <INDEXEXISTS> command.
sIndex
- Search index to destroy. May be null.sEngine
- Search engine name. May be null.sCharset
- Search index charset. May be null.sbError
- For return values; may contain error information.
public boolean IndexAdd(java.lang.String sIndex, java.lang.String sEntryName, java.lang.String sEntryDetail, java.lang.String sWordList, java.lang.String sWordListDelimiters, java.lang.String sFileList, java.lang.String sDate, FTValList vlTextArguments, FTValList vlFileArguments, FTValList vlDateArguments, java.lang.String sEngine, java.lang.String sCharset, java.lang.StringBuffer sbError)
This method is analogous to the XML <INDEXADD> command.
sIndex
- The name of the search index. May be null.sEntryName
- The name of the index entry to add.sEntryDetail
- The detail string associated with entry. May be null.sWordList
- The word list to index. May be null.sWordListDelimiters
- The characters to use as word list delimiters.
May be null.sFileList
- A list of files to add. May be null.sDate
- The date associated with this entry. May be null.vlTextArguments
- The text argument names and values. May be null.vlFileArguments
- The file argument names and values. May be null.vlDateArguments
- The date argument names and values. May be null.sEngine
- The search engine name. May be null.sCharset
- The search index charset. May be null.sbError
- For return values; may contain error information.
public boolean IndexReplace(java.lang.String sIndex, java.lang.String sEntryName, java.lang.String sEntryDetail, java.lang.String sWordList, java.lang.String sWordListDelimiters, java.lang.String sFileList, java.lang.String sDate, FTValList vlTextArguments, FTValList vlFileArguments, FTValList vlDateArguments, java.lang.String sEngine, java.lang.String sCharset, java.lang.StringBuffer sbError)
This method is analogous to the XML <INDEXREPLACE> command.
sIndex
- The name of the search index. May be null.sEntryName
- The name of the index entry to replace.sEntryDetail
- The detail string associated with entry. May be null.sWordList
- The word list to index. May be null.sWordListDelimiters
- The characters to use as word list delimiters.
May be null.sFileList
- A list of files to add. May be null.sDate
- The date associated with this entry. May be null.vlTextArguments
- The text argument names and values. May be null.vlFileArguments
- The file argument names and values. May be null.vlDateArguments
- The date argument names and values. May be null.sEngine
- The search engine name. May be null.sCharset
- The search index charset. May be null.sbError
- For return values; may contain error information.
public boolean IndexRemove(java.lang.String sIndex, java.lang.String sEntryName, java.lang.String sEngine, java.lang.String sCharset, java.lang.StringBuffer sbError)
This method is analogous to the XML <INDEXREMOVE> command.
sIndex
- The name of the index. May be null.sEntryName
- The name of the entry to delete.sEngine
- The search engine name. May be null.sCharset
- The search index charset. May be null.sbError
- For return values; may contain error information.
public boolean SearchDateToNative(java.lang.String sDate, java.lang.StringBuffer sbOut, java.lang.String sEngine, java.lang.String sCharset, java.lang.StringBuffer sbError)
This method is analogous to the XML <SEARCHDATENATIVE> command.
sDate
- The date to convert.sbOut
- Buffer to where the converted string will be returned.sEngine
- The search engine name. May be null.sCharset
- The search index charset. May be null.sbError
- For return values; may contain error information.
public IList Search(java.lang.String sIndex, java.lang.String sWhat, java.lang.String sRelevence, java.lang.String sQueryParser, int nMaxResults, FTValList vlAdditionalIndexes, java.lang.String sList, java.lang.String sEngine, java.lang.String sCharset, java.lang.StringBuffer sbError)
This method is analogous to the XML <SEARCH> command.
sIndex
- The index to search. May be null.sWhat
- The query string.sRelevence
- The Relevence string. May be null.sQueryParser
- The query parser name. May be null.nMaxResults
- The maximum number of results to return. Set this to 0 for unlimited results.vlAdditionalIndexes
- The name, value pairs of additional indexes to search. May be null.sList
- The name of the list. May be null.sEngine
- The search engine name. May be null.sCharset
- The search index charset. May be null.sbError
- For return values; may contain error information.
public IList RTHistory(java.lang.String sTable, java.lang.String sAsset, java.lang.String sVersion, java.lang.String sLocker, java.lang.String sCreator, java.lang.String sAnnotation, java.lang.String sListName)
This method is analogous to the XML <HISTORY> command.
sTable
- Name of the tracked table.sAsset
- Value of the primary key for the row whose history to retrieve.sVersion
- requesed versionsLocker
- Filter rows returned based on a user who has rows locked. If the current user does
not have rtaudit privileges, you must specify a value for LOCKER, CREATOR, or
both. If you specify only LOCKER, the value must be the current users name;
otherwise, no data will be returned.sCreator
- Filter rows returned based on the user who created the row. If the current user
does not have rtaudit privileges, you must specify a value for LOCKER, CREATOR, or
both. If you specify only CREATOR, the value must be the current users name;
otherwise, no data will be returned.sAnnotation
- Filter rows returned based on the annotation of a row.sListName
- Name of the list.
public IList RTInfo(java.lang.String sTable, java.lang.String sListName)
sTable
- Name of the tracked tablesListName
- Name of the IList to register.
public int RTLock(java.lang.String sTable, java.lang.String sAsset)
This method is analogous to the XML <LOCK> command.
sTable
- Name of the tracked table.sAsset
- Value of the primary key of the row to lock.
public int RTCommit(java.lang.String sTable, java.lang.String sAsset, java.lang.String sAnnotation, boolean bKeepLocked)
This method is analogous to the XML <COMMIT> command.
sTable
- Name of the tracked table.sAsset
- Value of the primary key for the record being commited.sAnnotation
- Comment describing the new revision.bKeepLocked
- Indicates lock status of record after commit.
Set value to "true" to indicate the
record will still be locked by user after the commit.
public int RTRelease(java.lang.String sTable, java.lang.String sAsset)
This method is analogous to the XML <RELEASE> command.
sTable
- Name of the tracked table.sAsset
- Value of the primary key of the row to release.
public IList RTRetrieveRevision(java.lang.String strTableName, java.lang.String strAsset, int nVersion, java.lang.String listName)
This method is analogous to the XML <RETRIEVEREVISION> command.
strTableName
- The name of the tracked table.strAsset
- The asset to get the results for.nVersion
- The version number of the edits.listName
- The name of the list to store the results.
public IList RTRetrieveRevision(java.lang.String strTableName, java.lang.String strAsset, java.lang.String strVersion, java.lang.String listName)
This version of the command allows a string version number, "first", "last", or a date (in the format of "YYYY-MM-DD 24HH:MI:SS"). "first" and "last" return the first and last revisions, while a date will return the revision that was or is current as of the specified date.
This method is analogous to the XML <RETRIEVEREVISION> command.
strTableName
- The name of the tracked table.strAsset
- The asset to get the results for.strVersion
- The version number of the edits.listName
- The name of the list that stores the results.
public boolean RegisterList(java.lang.String listname, IList ilist)
listname
- list name to present to XML side for processing;ilist
- list to register, setting to null unregisters
an existing list.
public int RTRollback(java.lang.String sTable, java.lang.String sAsset, int nVersion)
This version of RTRollback takes an integer version number to rollback to.
This method is analogous to the XML <ROLLBACK> command.
sTable
- Name of the table containing row to revert to a previous version.sAsset
- Value of the primary key for the row to revert to a previous version.nVersion
- Version to make current.
public int RTRollback(java.lang.String sTable, java.lang.String sAsset, java.lang.String strVersion)
This version of the command allows a string version number, "first", "last", or a date (in the format of "YYYY-MM-DD 24HH:MI:SS"). "first" and "last" rollback to the first and last revisions, while a date will rollback the revision current as of the specified date.
This method is analogous to the XML <ROLLBACK> command.
sTable
- Name of the table containing row to revert to a previous version.sAsset
- Value of the primary key for the row to revert to a previous version.strVersion
- Version to make current.
public int RTTrackTable(java.lang.String sTable, java.lang.String sStorage, int nVersions)
This method is analogous to the XML <TRACKTABLE> command.
sTable
- Name of the table to track.sStorage
- Location to store revisions associated with a row in the table. This is the root
folder. A folder will be automatically created under the given root folder whose
name is the same as the catalog being trackednVersions
- Maximum number of versions to store for each row. When the maximum is reached,
the oldest version is removed.
public int RTUntrackTable(java.lang.String sTable)
This method is analogous to the XML <UNTRACKTABLE> command.
sTable
- Name of the table to stop tracking.
public int RTUnlockRecord(java.lang.String sTable, java.lang.String sAsset)
This method is analogous to the XML <UNLOCKRECORD> command.
sTable
- Name of the tracked table.sAsset
- Value of the primary key of the row to unlock.
public int RTDeleteRevision(java.lang.String sTable, java.lang.String sAsset, int nVersion)
This method is analogous to the XML <DELETEREVISION> command.
sTable
- Name of the table containing row whose revision is to be deleted.sAsset
- Value of the primary key for the row whose revision is to be deleted.nVersion
- Version of the row to delete.
public int RTSetVersions(java.lang.String sTable, int nVersions)
This method is analogous to the XML <SETVERSIONS> command.
sTable
- Table to modify maximum number of versions.nVersions
- Maximum number of versions to store for each row. When the maximum is reached,
the oldest version is removed. A value of 0 (zero) indicates an unbounded number
of versions will be stored. If the value is smaller than the current number of
versions on the table, those versions will remain and can be removed manually.
public int Mirror(java.util.Vector vILists, java.lang.String sTarget, java.lang.String sUsername, java.lang.String sPassword, java.lang.String sCGIPrefix, java.lang.String sTargetIniFile, int nPort, boolean bUseProxy, boolean bUseHTTPS, int nHTTPVersion, java.lang.StringBuffer sbOutput)
vILists
- Vector of IList objects to mirrorsTarget
- Target server name.sUsername
- Username to use on the remote server. May be null.sPassword
- Password to use on remote server. May be null.sCGIPrefix
- CGI prefix string. May be null to indicate that the remote server is the same type as the source.sTargetIniFile
- String property file to push to target server. May be null if no property filenPort
- int port to use for communication. 0 interpreted the default HTTP port (80)bUseProxy
- TRUE to use proxy server for connection. FALSE otherwise.bUseHTTPS
- TRUE to use secure communcation. FALSE otherwise.nHTTPVersion
- Version of HTTP protocol to be used to connect to remote server.
Valid values are HTTPVERSION10 and
HTTPVERSION11.sbOutput
- Output for return values; may contain error info. May be null.
public int Mirror(java.util.Vector vILists, java.util.Vector vTreeList, java.lang.String sTarget, java.lang.String sUsername, java.lang.String sPassword, java.lang.String sCGIPrefix, java.lang.String sTargetIniFile, int nPort, boolean bUseProxy, boolean bUseHTTPS, int nHTTPVersion, java.lang.StringBuffer sbOutput)
vILists
- Vector of IList objects to mirrorvTreeList
- Vector of FTTreeNode objects to mirrorsTarget
- Target server name.sUsername
- Username to use on the remote server. May be null.sPassword
- Password to use on remote server. May be null.sCGIPrefix
- CGI prefix string. May be null to indicate that the remote server is the same type as the source.sTargetIniFile
- String property file to push to target server. May be null if no property filenPort
- int port to use for communication. 0 interpreted the default HTTP port (80)bUseProxy
- TRUE to use proxy server for connection. FALSE otherwise.bUseHTTPS
- TRUE to use secure communcation. FALSE otherwise.nHTTPVersion
- Version of HTTP protocol to be used to connect to remote server.
Valid values are HTTPVERSION10 and
HTTPVERSION11.sbOutput
- Output for return values; may contain error info. May be null.
public ISyncHash GetSynchronizedHash(java.lang.String name, boolean bCreate, int timeout, int size, boolean bAbsolute, boolean bClusterSync)
name
- String hashnamebCreate
- boolean create - if true and hash not found
it is created using following params. Existing hash always
returned if found.timeout
- timeout in minutessize
- size of entriesbAbsolute
- absolute timeout vs idlebClusterSync
- synchronize over cluster
public ISyncHash GetSynchronizedHash(java.lang.String name, boolean bCreate, int timeout, int size, boolean bAbsolute, boolean bClusterSync, java.util.Collection linked)
name
- String hashnamebCreate
- boolean create - if true and hash not found
it is created using following params. Existing hash always
returned if found.timeout
- timeout in minutessize
- size of entriesbAbsolute
- absolute timeout vs idlebClusterSync
- synchronize over clusterlinked
- Collection of caches that this ISyncHash is "linked" to.
when these linked caches are cleared, this ISyncHash will also get cleared.
public boolean DeleteSynchronizedHash(java.lang.String name)
name
- String name
public boolean AppEvent(java.lang.String name, java.lang.String guid, java.lang.String times, FTValList params)
name
- name to register event under; be cautious
with characters used in event name, { is a bad idea.guid
- to invoke on event firetimes
- coded time string for event firing
(see XML doc for details)params
- vallist of argument names/values; may be
null
public boolean EmailEvent(java.lang.String name, java.lang.String tolist, java.lang.String times, java.lang.String filespec)
name
- name to register event under; be cautious
with characters used in event name, { is a bad idea.tolist
- user list to receive emailtimes
- coded time string for event firing
(see XML doc for details)filespec
- file to send on event trigger
public boolean EmailEvent(java.lang.String name, java.lang.String tolist, java.lang.String times, java.lang.String filespec, java.lang.String contenttype, java.lang.String charset, FTValList attachments)
name
- name to register event under; be cautious
with characters used in event name, { is a bad idea.tolist
- user list to receive emailtimes
- coded time string for event firing
(see XML doc for details)filespec
- file to send on event triggercontenttype
- The content-type for the message. May be null to
default to text/plaincharset
- The charset for the message. May be null if body contains only US-ASCII characters or contenttype contains charset.attachments
- Attachments to send with email
public boolean DestroyEvent(java.lang.String name)
name
- event name
public boolean EnableEvent(java.lang.String name)
name
- event name
public boolean DisableEvent(java.lang.String name)
name
- event name
public IList ReadEvent(java.lang.String sEvent, java.lang.String sList)
sEvent
- event namesList
- list name
public IList QueryEvents(java.lang.String sNamePattern, java.lang.String sType, java.lang.Boolean bEnabled, java.lang.String sList)
sNamePattern
- event name pattern (can contain one % wildcard) or null for allsType
- event type (1 for servlet request or 2 for email) or null for bothbEnabled
- Boolean true for enabled events, false for disabled events, or null for bothsList
- list name or null for system generated name
public boolean SessionExists(java.lang.String id)
id
- session id string
public IJSPObject deployJSPFile(java.lang.String sPath, java.lang.String sZone, java.lang.StringBuffer sbError)
sPath
- Path of the JSP file to deploysZone
- Name of the JSP zone to store the
data (defaults to /) - this is a relative path within server
doc root.sbError
- For return values; may contain error information.
public IJSPObject deployJSPData(java.lang.String sData, java.lang.String sZone, java.lang.StringBuffer sbError)
sData
- The JSP datasZone
- Name of the JSP zone to store
the data (defaults to /) - this is a relative path within server
doc root.sbError
- For return values; may contain error information.
public IServlet getIServlet()
public void ThrowException()
public boolean ioErrorThrown()
public java.lang.String genID(boolean bClusterSafe)
bClusterSafe
- true if the number should be cluster safe.
public java.lang.String getURL(COM.FutureTense.Interfaces.IURLDefinition oIURLDefinition)
#getURI(Definition, String)
instead. This method
will be removed after Content Server 6.1
oIURLDefinition
- object which defines the URL
public java.lang.String getURL(com.fatwire.cs.core.uri.Definition definition, java.lang.String assembler)
definition
- Definition for the URI to generateassembler
- name for the assembler to be used to generate
the URI, or null to use the default assembler for this
installation of Content Server. Most cases will use
null for this argument.
public java.lang.String encode(java.lang.String base, java.util.Map map, boolean bSession)
base
- String base of the URLmap
- Map key and value pairs for attributesbSession
- true to include session id
public void decode(java.lang.String sAttributes, java.util.Map map)
sAttributes
- String attribute string of form k1=v1&k2=v2&...map
- Map set of key/value pairs from the stringpublic java.lang.String diskFileName()
public java.lang.String diskFileName(java.lang.String pname, FTValList arguments)
pname
- pagename, not null else returns null and sets errno
to ftErrors.badparamsarguments
- optional name/value pairs for resargs (ie PageCriteria)
public java.lang.String diskFileName(java.lang.String pname, java.lang.String arguments)
pname
- pagename, not null else returns null and sets errno
to ftErrors.badparamsarguments
- optional URL components ie p1=v1&p2=v2...
public boolean isCacheable(java.lang.String pagename)
pagename
- pagename or null to indicate current page.
DisableCache()
public java.lang.String pageURL()
public java.lang.String[] pageCriteriaKeys(java.lang.String pagename)
pagename
- name of the page
public java.lang.String pageURL(java.lang.String pname, FTValList arguments)
pname
- name of the page to construct the urlarguments
- name/value pairs for resargs (ie PageCriteria); may be
empty but may not be null
public void DisableFragmentCache()
public java.lang.Object StartBatchContext()
public boolean CommitBatchedCommands(java.lang.Object oBatchContext)
oBatchContext
- Object batch context object
public boolean RollbackBatchedCommands(java.lang.Object oBatchContext)
oBatchContext
- Object batch context object
public boolean rsCacheDebug()
ftMessage.RESULT_SET_CACHE_DEBUG
public boolean pgCacheDebug()
ftMessage.PAGE_CACHE_DEBUG
public boolean pastramiDebug()
ftMessage.GENERIC_DEBUG
public boolean xmlDebug()
ftMessage.XML_DEBUG
public boolean syncDebug()
ftMessage.SYNC_DEBUG
public boolean eventDebug()
ftMessage.EVENT_DEBUG
public boolean systemDebug()
ftMessage.GENERIC_DEBUG
public boolean dbDebug()
ftMessage.DB_DEBUG
public boolean sessionDebug()
ftMessage.SESSION_DEBUG
public boolean timeDebug()
ftMessage.TIME_DEBUG
public boolean systemSession()
public boolean BlobServer(FTValList args, COM.FutureTense.Interfaces.IMIMENotifier im, java.io.OutputStream os)
args
- Map of blobserver argumentsim
- IMIMENotifier call back to set header informationos
- OutputStream to capture bytes
public java.lang.String getLocaleString(java.lang.String sName, java.lang.String sLocale)
sName
- name of the stringsLocale
- locale of the string (i.e., EN_US)
public COM.FutureTense.Interfaces.PastramiEngine getPastramiEngine()
public COM.FutureTense.Cache.Satellite getSatellite(java.lang.String id)
id
- String satellite engine id as defined in the SystemSatelites table
public java.lang.Object getAttribute(java.lang.String sName)
sName
- name of the attribute
public java.util.Enumeration getAttributeNames()
public void removeAttribute(java.lang.String sName)
sName
- name of the attributepublic void setAttribute(java.lang.String sName, java.lang.Object oValue)
sName
- name of the attributeoValue
- value to setpublic void close()
public java.lang.String getNamespace()
public java.security.Principal getUserPrincipal()
public COM.FutureTense.Interfaces.IProperties getIProperties()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |