This class allows user applications to generate an alert using one of the supported external monitoring protocols. More...
Static Public Member Functions | |
_.Library.Status | External (_.Library.String type, _.Library.String appname, _.Library.Integer severity, _.Library.String msg) |
This class allows user applications to generate an alert using one of the supported external monitoring protocols. More... | |
![]() | |
_.Library.Status | DeleteData (_.Library.String id, _.Library.Integer concurrency) |
This method is normally generated by the storage class for persistent classes using. More... | |
_.Library.Status | KillExtentData (_.Library.Boolean killstreams) |
KillExtentData() - kills extent data in storage. More... | |
_.Library.Status | OnAfterBuildIndices (_.Library.String indexlist) |
This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More... | |
_.Library.Status | OnAfterDelete (_.Library.ObjectIdentity oid) |
This callback method is invoked by the <METHOD>Delete</METHOD> method to. More... | |
_.Library.Status | OnAfterPurgeIndices (_.Library.String indexlist) |
This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More... | |
_.Library.Status | OnBeforeBuildIndices (_.Library.String indexlist) |
_.Library.Status | OnBeforePurgeIndices (_.Library.String indexlist) |
_.Library.Status | OnDelete (_.Library.ObjectIdentity oid) |
This callback method is invoked by the <METHOD>Delete</METHOD> method to. More... | |
![]() | |
_.Library.Status | ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value) |
You pass this the <parameter>url</parameter> of the page you are going to and a. More... | |
_.Library.Binary | Decrypt (_.Library.String data) |
Decrypts the input string using the session.Key value that is unique to. More... | |
_.Library.String | Encrypt (_.Library.Binary data) |
Encrypts the input string using the session.Key value that is unique to this. More... | |
_.Library.String | EscapeHTML (in) |
This method converts input HTML text into Escaped HTML text. | |
_.Library.String | EscapeURL (_.Library.String in, _.Library.String charset) |
This method converts the in input URL string into Escaped URL string. More... | |
_.Library.String | HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile) |
This method returns the string that needs to be written to the current. More... | |
_.Library.String | HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker) |
This method returns the string that needs to be written to the current. More... | |
Include (_.Library.String url) | |
Include another csp page or file in the output at this point. More... | |
_.Library.String | InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra) |
Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More... | |
_.Library.String | InsertHiddenFields (_.Library.String url, _.Library.String query) |
Return the string containing the hidden form tags. More... | |
_.Library.Boolean | IsPrivate () |
Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>). | |
_.Library.String | Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ) |
Tranforms the link specified by link into a URL and returns it as a string. More... | |
_.Library.Status | OnHTTPHeader (_.Library.Boolean OutputBody) |
Event handler for PAGE event: this is invoked in order to More... | |
_.Library.Status | OnPage () |
Event handler for PAGE event: this is invoked in order to More... | |
OnPageError (_.Library.Status sc) | |
Event handler for any error that occurs on the page. More... | |
OnPostHTTP () | |
Event handler for POSTPAGE event: this is invoked after the data. More... | |
_.Library.Status | OnPostHyperEvent (_.Library.String class, _.Library.String method) |
Event handler which is invoked after a hyperevent method is called on this page. | |
_.Library.Boolean | OnPreHTTP () |
Event handler for PreHTTP event: this is invoked before. More... | |
_.Library.Status | OnPreHyperEvent (_.Library.String class, _.Library.String method) |
Event handler which is invoked before a hyperevent method is called on this page. More... | |
_.Library.Status | Page (_.Library.Boolean skipheader) |
Process a request to serve a CSPPage. More... | |
_.Library.String | QuoteJS (in) |
This method converts input string into quoted JavaScript literal. | |
_.Library.String | RewriteURL (_.Library.String url) |
This method will rewrite a URL to use #url()# if needed. | |
ShowError (_.Library.Status sc) | |
Display a <class>Status</class> error code to the CSP Page. | |
StartTimer (_.Library.String name) | |
Used to get performance information on your CSP pages. More... | |
StopTimer (_.Library.String name) | |
Used to time performance information on your CSP pages. More... | |
ThrowError (_.Library.Status sc) | |
Passed a <class>Status</class> code this goes to the error page passing this status code. | |
_.Library.String | UnescapeHTML (in) |
This method converts Escaped HTML text into normal HTML text. | |
_.Library.String | UnescapeURL (_.Library.String in, _.Library.String charset) |
This method converts the in Escaped URL string back to its original form. More... | |
Additional Inherited Members | |
![]() | |
_.Library.Status | AcquireLock (_.Library.String locktype) |
Acquires a lock for the current instance. More... | |
_.Library.Status | LoadData (_.Library.String id) |
LoadData() - loads an object from storage. More... | |
_.Library.Status | OnAfterSave (_.Library.Boolean insert) |
This callback method is invoked by the <METHOD>Save</METHOD> method to. More... | |
_.Library.Status | OnBeforeSave (_.Library.Boolean insert) |
This callback method is invoked by the <METHOD>Save</METHOD> method to. More... | |
_.Library.Status | OnOpen () |
This callback method is invoked by the <METHOD>Open</METHOD> method to. More... | |
_.Library.Status | OnReload () |
This callback method is invoked by the <METHOD>Reload</METHOD> method to. More... | |
_.Library.Status | OnRollBack () |
This callback method is invoked by the <METHOD>Save</METHOD> method to. More... | |
_.Library.Status | ReleaseLock (_.Library.String locktype) |
Releases a lock for the current instance. More... | |
_.Library.Status | SaveData (_.Library.String id) |
SaveData() - saves an object to disk, checks uniqueness and referential More... | |
![]() | |
_.Library.Status | OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter) |
This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More... | |
![]() | |
_.Library.Status | OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount) |
This callback method is invoked when the current object is added to the SaveSet,. More... | |
_.Library.Status | OnClose () |
This callback method is invoked by the <METHOD>Close</METHOD> method to. More... | |
_.Library.Status | OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned) |
This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More... | |
_.Library.Status | OnNew () |
This callback method is invoked by the <METHOD>New</METHOD> method to. More... | |
_.Library.Status | OnValidateObject () |
This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More... | |
![]() | |
XCOMPACTANCESTRY | |
XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More... | |
DATALOCATIONGLOBAL = None | |
Global name containing master map data for this class. More... | |
DEFAULTGLOBAL = None | |
DSCONDITION = None | |
DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More... | |
DSINTERVAL = None | |
DSINTERVAL is the number of seconds between one DSTIME value and the next. More... | |
DSTIME = None | |
If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More... | |
EXTENTQUERYSPEC = None | |
The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More... | |
EXTENTSIZE = None | |
The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More... | |
GUIDENABLED = None | |
If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More... | |
IDENTIFIEDBY = None | |
The IDENTIFIEDBY parameter can optionally be set to the name. More... | |
MANAGEDEXTENT = None | |
The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More... | |
READONLY = None | |
READONLY = 1 means that objects can be created, opened but not saved or deleted. More... | |
ROWLEVELSECURITY = None | |
ROWLEVELSECURITY = 1 | <property> means that row level security is active and the list More... | |
SQLPREVENTFULLSCAN = None | |
SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More... | |
STORAGEDEFAULT = None | |
STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More... | |
USEEXTENTSET = None | |
VERSIONCLIENTNAME = None | |
VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More... | |
VERSIONPROPERTY = None | |
VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More... | |
![]() | |
DEFAULTCONCURRENCY = None | |
DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More... | |
JOURNALSTREAM = None | |
If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More... | |
OBJJOURNAL = None | |
if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More... | |
![]() | |
CAPTION = None | |
Optional name used by the Form Wizard for a class when generating forms. More... | |
JAVATYPE = None | |
The Java type to be used when exported. | |
PROPERTYVALIDATION = None | |
This parameter controls the default validation behavior for the object. More... | |
![]() | |
CHARSET = None | |
The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More... | |
CONTENTTYPE = None | |
Specifies the default content type for the page. More... | |
CONVERTINPUTSTREAM = None | |
Specifies if input request.Content or request.MimeData values are converted from their. More... | |
CSPFILE = None | |
If this page was compiled from a .csp file, then this parameter contains the. More... | |
CSPSTRICT = None | |
The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More... | |
CSPURL = None | |
This parameter is used to make sure that if multiple. More... | |
CSPXHTML = None | |
The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More... | |
DOMAIN = None | |
The default domain for csp:text, span and div tags. More... | |
ENCODED = None | |
Controls how the query parameters for this page are passed, it can. More... | |
ERRORPAGE = None | |
Specify a custom error page to call if there are any problems with generating this page. More... | |
EXPIRES = None | |
Specified the default value for the response.Expires. More... | |
NOCHARSETCONVERT = None | |
Specifies if we wish to turn off charset conversion for this page. More... | |
PAGETIMING = None | |
If this parameter is true then we automatically record timing statistics of how long it takes to. More... | |
PRIVATE = None | |
Controls the access to the page, it can be set to one of the following: More... | |
SECURITYRESOURCE = None | |
This is a comma-delimited list of system Resources and associated. More... | |
TIMINGSLOTS = None | |
Used by the timing to decide how many slots a day should be divided up into. More... | |
UseSession = None | |
This parameter controls the CSP session support. More... | |
This class allows user applications to generate an alert using one of the supported external monitoring protocols.
See the External() class method for details.
|
static |
This class allows user applications to generate an alert using one of the supported external monitoring protocols.
See the External() class method for details.
This class method allows a application to send an alert using an external
monitoring or management interface, currently just SNMP. This call may be used within the Alert Evaluation Method to forward alerts generated by the Monitor, or from anywhere within the application itself to simply create an SNMP Trap.
The parameters used are:
type = use 'SNMP' to indicate how to send the alert
appname = a brief string (MAXLEN=20) to identify the source or application creating the alert
severity = a severity code where 0=info, 1=warning, 2=severe, 3=fatal
msg = a text message (MAXLEN=1024) which describes the problem or event
For SNMP, the alert is sent using the cacheAppAlert trap, with each of the parameters attached as auxiliary objects (see the ISC-CACHE.MIB).