Internal Console API

InternalSystemLog

Other API in Package

Console

Console System

Console Webservice

List of Classes

InternalConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloud

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmail

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalResponse

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportIncident

InternalSupportProfile

InternalSystemInformation

InternalSystemLog

InternalSystemManager

InternalTunnelManager

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

Provides access to the system log. Note that most of these methods, with the exception of setSignatures return null or fail quietly if you are not connected to the gatekeeper.

Method Summary
DataList checkSignatures(DataList signatures)

Check signatures for triggering event notices. The DataList should have columns regex, sample, and result

  deleteLogFile(File logFile)

Deletes the specified log file.

DataList getEvents()

Returns a list containing all events in the queue. Calling this method will consume the queue.

File getNextLogFile()

Returns the next un-read log file. Read only one log file at a time.

DataList getSignatures()

Returns the signatures for triggering event notices.

  rotateLogFile()

Forces a rotation of the main syslog file. Call getNextLogFile after this to obtain the file.

String setSignatures(DataList signatures)

Sets the signatures for triggering event notices. The signatures list should have three columns: sigId, regex, and type. Accepted values in the type column are 'error' and 'security' indicating which event to trigger.

String toString()

Returns a description of this object.

Method Detail


DataList checkSignatures(DataList signatures)

Check signatures for triggering event notices. The DataList should have columns regex, sample, and result

Parameters:

Returns:  DataList

Since: 11-21-2013

top

deleteLogFile(File logFile)

Deletes the specified log file.

Parameters:

Since: 11-01-2013

top

DataList getEvents()

Returns a list containing all events in the queue. Calling this method will consume the queue.

Returns:  DataList


DataList Name: events
DataList Fields: sigId, type, message, time

Since: 11-01-2013

top

File getNextLogFile()

Returns the next un-read log file. Read only one log file at a time.

Returns:  File

Since: 11-01-2013

top

DataList getSignatures()

Returns the signatures for triggering event notices.

Returns:  DataList


DataList Name: signatures
DataList Fields: sigId, regex, type, status, matches

Since: 11-21-2013

top

rotateLogFile()

Forces a rotation of the main syslog file. Call getNextLogFile after this to obtain the file.

Since: 11-01-2013

top

String setSignatures(DataList signatures)

Sets the signatures for triggering event notices. The signatures list should have three columns: sigId, regex, and type. Accepted values in the type column are 'error' and 'security' indicating which event to trigger.

Parameters:

Returns:  String

Since: 11-21-2013

top

String toString()

Returns a description of this object.

Returns:  String

Since: 11-01-2013

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 18, 2024 01:04 PM