com.sap.smp.client.supportability

Interface ClientLogManager

All Known Implementing Classes:

ClientLogManagerImpl

public interface ClientLogManager

The Client log manager acts as the central access point to loggers; provides setters to common properties used by various loggers.

As to which operations require the Android Context is implementation-dependent. Methods which require the init() method to be invoked beforehand should throw an IllegalStateException in case the context is absent.

Method Summary

Modifier and Type	Method and Description
java.util.List<ClientLogEntry>	getLogEntries(ClientLogLevel level) Deprecated. In case of a large amount of log entries calling this method might cause memory issues, use iterateLogEntries(ClientLogLevel) instead.
java.util.List<ClientLogEntry>	getLogEntriesForLogger(java.lang.String ID, ClientLogLevel level) Deprecated. In case of a large amount of log entries calling this method might cause memory issues, use iterateLogEntriesForLogger(String, ClientLogLevel) instead.
ClientLogger	getLogger(java.lang.String id) Retrieves a logger associated with the given ID.
byte[]	getRawLogData() Deprecated. In case of a large amount of log entries calling this method might cause memory issues, use iterateRawLogData() instead.
java.lang.String	getSMPCorrelationId() Returns the correlation ID used by this manager at the moment.
void	init(android.content.Context ctx) Initializes this manager to use the specified application context.
java.util.Iterator<ClientLogEntry>	iterateLogEntries(ClientLogLevel level) Retrieves an iterator for all entries with the given level produced during the current session till the point the API was called.
java.util.Iterator<ClientLogEntry>	iterateLogEntriesForLogger(java.lang.String ID, ClientLogLevel level) Retrieves an iterator for all log entries with the given level produced by a specific logger associated with the given ID during the current session till the point the API was called.
java.util.Iterator<java.lang.String>	iterateRawLogData() Returns an iterator of log data.
void	setLogDestination(java.util.EnumSet<ClientLogDestination> destinations) Tells where all logger messages should be output; applied to all active loggers, overrides settings made via #setLogDestination(int, String) Accepted values are defined in the ClientLogDestination enumeration; multiple targets can be set by combining these values.
void	setLogDestination(java.util.EnumSet<ClientLogDestination> destinations, java.lang.String id) Tells where all logger messages should be output; applied to the logger associated with the given ID.
void	setLogLevel(ClientLogLevel level) Sets the overall log level; applied to all active loggers and it will be the default for loggers created thereafter.
void	setLogLevel(ClientLogLevel level, java.lang.String ID) Sets the log level for the logger associated with the given ID.
void	setRootContextId(java.lang.String id) Sets the root context id.
void	uploadClientLogs(Uploader uploader, UploadListener uploadListener) Uploads current logs to the server using the uploader.
boolean	wipeClientLogs(WipeLogListener wipeLogListener) Initiates clearing the log entries from the destination that allows such operation (e.g.

Method Detail

init

void init(android.content.Context ctx)

Initializes this manager to use the specified application context.

Parameters:

ctx - the Android application context, must be non-null

Throws:

java.lang.IllegalArgumentException - in case the argument is null

getLogger

ClientLogger getLogger(java.lang.String id)

Retrieves a logger associated with the given ID. If the length of the ID were longer than 32 characters, then the log entries uploaded to the server will contain just the truncated version of the ID in their source field.

Note that this API shall not be used to log sensitive data, such as authentication data (passwords, tokens, crypto keys), personal data (user’s name, address, gender, age etc.), or business confidential data (request data). Only necessary metadata about the client program’s execution behavior and not about server behavior and error information shall be written to the log.

Parameters:

id - logger identifier, must be non-null

Returns:

logger instance, always non-null

Throws:

java.lang.IllegalArgumentException - in case the argument is null

java.lang.IllegalStateException - in case init(Context) was not called and thus there's no Android context to work with

setLogLevel

void setLogLevel(ClientLogLevel level)

Sets the overall log level; applied to all active loggers and it will be the default for loggers created thereafter. Additionally, generates a new global correlation ID used by loggers belonging to this manager. This correlation ID is used whenever a logger is not given trace information to work with.

If the argument is null then it's reset to the initial value set after instantiation of this manager (=which is the ERROR level).

Parameters:

level - overall log level, can be null

setLogLevel

void setLogLevel(ClientLogLevel level,
                 java.lang.String ID)

Sets the log level for the logger associated with the given ID.

If the level argument is null then it's reset to the initial value set after instantiation of this manager (=which is the ERROR level). If the ID argument is null then this method does nothing.

Parameters:

level - log level, can be null

id - logger identifier, can be null

setLogDestination

void setLogDestination(java.util.EnumSet<ClientLogDestination> destinations)

Tells where all logger messages should be output; applied to all active loggers, overrides settings made via #setLogDestination(int, String) Accepted values are defined in the ClientLogDestination enumeration; multiple targets can be set by combining these values. The value set will be the default for loggers created thereafter.

The null argument is treated as if an empty set was specified.

Parameters:

destinations - one or more destinations, can be null

setLogDestination

void setLogDestination(java.util.EnumSet<ClientLogDestination> destinations,
                       java.lang.String id)

Tells where all logger messages should be output; applied to the logger associated with the given ID. Accepted values are defined in the ClientLogDestination enumeration; multiple targets can be set by combining these values.

The null destinations argument is treated as if an empty set was specified. If the ID argument is null then this method does nothing.

Parameters:

destinations - one or more destinations, can be null

id - logger identifier, can be null

getLogEntries

@Deprecated
java.util.List<ClientLogEntry> getLogEntries(ClientLogLevel level)

Deprecated. In case of a large amount of log entries calling this method might cause memory issues, use iterateLogEntries(ClientLogLevel) instead.

Retrieves all entries with the given level produced during the current session till the point the API was called.

If the log level is null it is treated as if level 'ALL' were specified.

Parameters:

level - log level, can be null

Returns:

list of entries, always non-null

getLogEntriesForLogger

@Deprecated
java.util.List<ClientLogEntry> getLogEntriesForLogger(java.lang.String ID,
                                                                  ClientLogLevel level)

Deprecated. In case of a large amount of log entries calling this method might cause memory issues, use iterateLogEntriesForLogger(String, ClientLogLevel) instead.

Retrieves all log entries with the given level produced by a specific logger associated with the given ID during the current session till the point the API was called.

If the logger identifier is null, the iterator will return no element. If the log level is null it is treated as if level 'ALL' were specified.

Parameters:

ID - logger identifier, can be null

level - log level, can be null

Returns:

list of entries, always non-null

iterateLogEntries

java.util.Iterator<ClientLogEntry> iterateLogEntries(ClientLogLevel level)

Retrieves an iterator for all entries with the given level produced during the current session till the point the API was called.

If the log level is null it is treated as if level 'ALL' were specified.

Parameters:

level - log level, can be null

Returns:

iterator of entries, always non-null

iterateLogEntriesForLogger

java.util.Iterator<ClientLogEntry> iterateLogEntriesForLogger(java.lang.String ID,
                                                              ClientLogLevel level)

Retrieves an iterator for all log entries with the given level produced by a specific logger associated with the given ID during the current session till the point the API was called.

If the logger identifier is null, the iterator will return no element. If the log level is null it is treated as if level 'ALL' were specified.

Parameters:

ID - logger identifier, can be null

level - log level, can be null

Returns:

iterator of entries, always non-null

uploadClientLogs

void uploadClientLogs(Uploader uploader,
                      UploadListener uploadListener)

Uploads current logs to the server using the uploader. It notifies about the result in the listener given.

Parameters:

uploader - component doing the upload

uploadListener - listener for the upload result

getRawLogData

@Deprecated
byte[] getRawLogData()

Deprecated. In case of a large amount of log entries calling this method might cause memory issues, use iterateRawLogData() instead.

Returns log data as byte array.

Returns:

log data

iterateRawLogData

java.util.Iterator<java.lang.String> iterateRawLogData()

Returns an iterator of log data.

Returns:

iterator for log data

setRootContextId

void setRootContextId(java.lang.String id)

Sets the root context id. This method is usually invoked by the E2E trace component, At the same time the log level of every loggers is set to DEBUG. At the end of the tracing the method is called with null which resets the log levels to their original values and generates a new global correlation ID.

Parameters:

id - the root context ID, may be null

getSMPCorrelationId

java.lang.String getSMPCorrelationId()

Returns the correlation ID used by this manager at the moment. Note that this ID is independent from E2E tracing and is used only when tracing is not active.

Returns:

the correlation ID, always non-null

wipeClientLogs

boolean wipeClientLogs(WipeLogListener wipeLogListener)

Initiates clearing the log entries from the destination that allows such operation (e.g. file system). The execution is conducted asynchronously. A listener can be given that gets called when the execution has finished. In case an exclusive operation (e.g. log upload, log retrieval) is running when this method is called, the execution won't start, and the method returns false.

Parameters:

wipeLogListener - listener to be called when wiping finished, can be null

Returns:

true if wiping started successfully, false otherwise