HS.IHE.ATNA.SecureApplication.Syslog.Common
class HS.IHE.ATNA.SecureApplication.Syslog.Common extends %Library.RegisteredObject
Create a Syslog message based on RFC5424.The syslog header has the following ABNF [RFC5234] definition:
The syslog field values have the following ABNF [RFC5234] definition:
Property Inventory
Method Inventory
Parameters
parameter SETTINGS = SyslogFacility,SyslogSeverity,ApplicationName,IncludeByteOrderMark,StripWhitespace;
Properties
property ApplicationName as %String [ InitialExpression = "InterSystems_HealthShare" ];
The name of the application to include in the syslog header. Whitespace is not allowed, and will be stripped out of the name entered here before submitting over the wire.
Property methods: ApplicationNameDisplayToLogical(), ApplicationNameGet(), ApplicationNameIsValid(), ApplicationNameLogicalToDisplay(), ApplicationNameLogicalToOdbc(), ApplicationNameNormalize(), ApplicationNameSet()
property IncludeByteOrderMark as %Boolean [ InitialExpression = "0" ];
An optional argument to the syslog header is the Byte Order Mark (BOM). This setting governs whether or not the BOM should be included.
Property methods: IncludeByteOrderMarkDisplayToLogical(), IncludeByteOrderMarkGet(), IncludeByteOrderMarkIsValid(), IncludeByteOrderMarkLogicalToDisplay(), IncludeByteOrderMarkNormalize(), IncludeByteOrderMarkSet()
property StripWhitespace as %Boolean [ InitialExpression = "1" ];
Most ATNA repositories won't handle CR, LF, and TAB characters within the audit event. This setting allows you to filter these characters out.
Property methods: StripWhitespaceDisplayToLogical(), StripWhitespaceGet(), StripWhitespaceIsValid(), StripWhitespaceLogicalToDisplay(), StripWhitespaceNormalize(), StripWhitespaceSet()
property SyslogFacility as %String (DISPLAYLIST = ",kernel,user,mail,system,security1,syslogd,printer,news,UUCP,clock1,security2,FTP,NTP,audit,alert,clock2,local0,local1,local2,local3,local4,local5,local6,local7", VALUELIST = ",0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23") [ InitialExpression = "13" ];
Facilities:
0 kernel messages
1 user-level messages
2 mail system
3 system daemons
4 security/authorization messages (note 1)
5 messages generated internally by syslogd
6 line printer subsystem
7 network news subsystem
8 UUCP subsystem
9 clock daemon (note 2)
10 security/authorization messages (note 1)
11 FTP daemon
12 NTP subsystem
13 log audit (note 1)
14 log alert (note 1)
15 clock daemon (note 2)
16 local use 0 (local0)
17 local use 1 (local1)
18 local use 2 (local2)
19 local use 3 (local3)
20 local use 4 (local4)
21 local use 5 (local5)
22 local use 6 (local6)
23 local use 7 (local7)
Property methods: SyslogFacilityDisplayToLogical(), SyslogFacilityGet(), SyslogFacilityIsValid(), SyslogFacilityLogicalToDisplay(), SyslogFacilityLogicalToOdbc(), SyslogFacilityNormalize(), SyslogFacilitySet()
property SyslogSeverity as %String (DISPLAYLIST = ",Alert,Critical,Debug,Emergency,Error,Informational,Notice,Warning", VALUELIST = ",1,2,7,0,3,6,5,4") [ InitialExpression = "6" ];
Severities:
0 Emergency: system is unusable
1 Alert: action must be taken immediately
2 Critical: critical conditions
3 Error: error conditions
4 Warning: warning conditions
5 Notice: normal but significant condition
6 Informational: informational messages
7 Debug: debug-level messages
Property methods: SyslogSeverityDisplayToLogical(), SyslogSeverityGet(), SyslogSeverityIsValid(), SyslogSeverityLogicalToDisplay(), SyslogSeverityLogicalToOdbc(), SyslogSeverityNormalize(), SyslogSeveritySet()
Methods
method GetByteOrderMark() as %Binary
method GetSyslogHeader() as %String
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()