com.sap.netweaver.bc.serialize

Interface ILogger

public interface ILogger

Allows all participants of a serialization or deserialization process to add structured logging data.

The parameters species, status and provider are used for filtering the log for certain kind of entries.

Participant should not log any kind of coding problems or similar. Instead, log entries should refer to items like the following:

• Problems reading/writing data for a serializer
• Problems retrieving a serializer
• Problems accessing/creating IResource instances
• Summary of information about starting/finishing tasks

Note that a logger might combine the results of many serializations in one file, so keep the entries short!

If a participant fails to close a structure and another participant closes its outer structure, all inner structures that have not been closed, will be closed.

Copyright 2004 SAP AG

Nested Class Summary

static class	ILogger.Species
static class	ILogger.Token

Field Summary

static ILogger.Species	HANDLER
static ILogger.Species	SERIALIZER
static ILogger.Species	TRANSPORTSERVICE

Method Summary

void	add(Status status, ILogger.Species species, String provider, String message)
void	end(ILogger.Token token) closes the structure that was opened with the start method.
ILogger.Token	start(Status status, ILogger.Species species, String provider, String message)

Field Detail

SERIALIZER

static final ILogger.Species SERIALIZER

HANDLER

static final ILogger.Species HANDLER

TRANSPORTSERVICE

static final ILogger.Species TRANSPORTSERVICE

Method Detail

add

void add(Status status,
         ILogger.Species species,
         String provider,
         String message)

Parameters:

status - the status information (OK, WARNING,...) for this message. Must not be null

species - the species the caller belongs to. Create a new one, if the ones provided here are not sufficient. Must not be null

provider - a String that represents the calling class. Should always be the same for a caller. Must not be null

message - the actual message. Must not be null.

start

ILogger.Token start(Status status,
                    ILogger.Species species,
                    String provider,
                    String message)

Parameters:

status -

species -

provider -

message -

Returns:

start token

end

void end(ILogger.Token token)

closes the structure that was opened with the start method.

Parameters:

token - the token returned by the start method. Must not be null

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM