Summary Highlights

The syntax rule described in the Javadoc API helps you to validate your syntax. Therefore, this section only explains:

The summary below highlights the semantics.

Note Note

The list is not complete. Therefore, we recommend that you refer to the Javadoc API for the complete semantics.

End of the note.

Summary of Some Classes

Class	Possible Attribute	Reference to API	Multiple entries	Comments
`LogController`		General for both Location, Category
	logs	logController.addLog(Log)	X
	localLogs	logController.addLocalLog(Log)	X
	privateLogs	logController.addPrivateLog(Log)	X
	filters	logController.addFilter(Filter)	X
	bundleName	logController.setResourceBundleName(String)
`Log`		General for all Log subclasses
	encoding	log.setEncoding(String)
	formatter	log.setFormatter(Formatter)
	filters	log.addFilter(Filter)	X
`FileLog`	pattern	new FileLog(String)	X	file name
		limit new FileLog(String, int, int)
`Formatter`	pattern	formatter.setPattern(String)		message format

The following are specific cases:

In case of a primitive data type, you can easily assign an integer or string as an attribute value (except Severity).
In case of an attribute that takes a class, as listed above, such as Log or Formatter, you have to either use the classname directly or the notation of a variable.

More information: Syntax and Semantics of the Properties File.
In case of a Filter interface, assign the fully qualified classname of the user-defined class. For that aim, make sure the class is already included in the classpath, and use an appropriate class loader.

Note

This also applies to user-defined classes for Log and Formatter. Use a full classname if not using the standard classes provided by the SAP Logging API.

End of the note.

Summary of Configurable Attributes

Attribute	Type	Possible Value	Comments
Severity	Integer	`NONE`	Constants are defined in class `Severity` for your convenience. Refers to Javadoc of class `Severity`.
		`FATAL`	Case-sensitive
		`ERROR`	Case-sensitive
		`WARNING`	Case-sensitive
		`INFO`	Case-sensitive
		`PATH`	Case-sensitive
		`DEBUG`	Case-sensitive
		`ALL`	Case-sensitive
Logs (classname)	Log	`FileLog`	Case-sensitive
		`ConsoleLog`
Logs (variable)		`log[id]`	id can be any logical, meaningful name.
Formatter (classname)	Formatter	`TraceFormatter`
		`ListFormatter`
		`XMLFormatter`
Formatter (variable)		`formatter[id]`	id can be any logical, meaningful name.
Filters (classname)	Filter (interface)	`com.sapmarkets.um.logging.Filter`	Actual implementation defined by users. The arbitrary value shown on the left column indicates a class named 'Filter'. This value is defined by user under the package '`com.sapmarkets.um.logging'`.