com.sap.it.api.msglog

Interface MessageLog

public interface MessageLog

Supports writing properties and adding attachments and custom header properties to the message log

This interface must not be extended or implemented by clients.

Method Summary

Modifier and Type	Method and Description
void	addAttachmentAsString(String name, String text, String mediaType) Adds the specified text as an attachment.
void	addCustomHeaderProperty(String name, String value) Adds a custom property with name name and value value of String type to the header of the message log.
void	setBooleanProperty(String name, Boolean value) Sets a property of Boolean type
void	setDateProperty(String name, Date value) Sets a property of Date type
void	setDoubleProperty(String name, Double value) Sets a property of Double type
void	setFloatProperty(String name, Float value) Sets a property of Float type
void	setIntegerProperty(String name, Integer value) Sets a property of Integer type
void	setLongProperty(String name, Long value) Sets a property of Long type
void	setStringProperty(String name, String value) Sets a property of String type.

Method Detail

setStringProperty

void setStringProperty(String name,
                       String value)

Sets a property of String type. This method shall be used only for short Strings (one or a few words). For longer, structured documents method addAttachmentAsString(String, String, String) shall be used

Parameters:

name - the name of the property

value - the value of the property

setIntegerProperty

void setIntegerProperty(String name,
                        Integer value)

Sets a property of Integer type

Parameters:

name - the name of the property

value - the value of the property

setLongProperty

void setLongProperty(String name,
                     Long value)

Sets a property of Long type

Parameters:

name - the name of the property

value - the value of the property

setBooleanProperty

void setBooleanProperty(String name,
                        Boolean value)

Sets a property of Boolean type

Parameters:

name - the name of the property

value - the value of the property

setFloatProperty

void setFloatProperty(String name,
                      Float value)

Sets a property of Float type

Parameters:

name - the name of the property

value - the value of the property

setDoubleProperty

void setDoubleProperty(String name,
                       Double value)

Sets a property of Double type

Parameters:

name - the name of the property

value - the value of the property

setDateProperty

void setDateProperty(String name,
                     Date value)

Sets a property of Date type

Parameters:

name - the name of the property

value - the value of the property

addAttachmentAsString

void addAttachmentAsString(String name,
                           String text,
                           String mediaType)

Adds the specified text as an attachment. Adding an attachment for a given name does not overwrite an existing attachment that has the same name, i.e. multiple attachments can be added for the same name. This method shall be used for longer, structured documents instead of setStringProperty(String, String)

Parameters:

name - The name of the attachment

text - the text of the attachment

mediaType - the related media type, for example text/plain, text/xml, text/csv. In case null is specified, the media type defaults to text/plain.

addCustomHeaderProperty

void addCustomHeaderProperty(String name,
                             String value)

Adds a custom property with name name and value value of String type to the header of the message log. The old values of the property, if any, are not overwritten. The value is added to the set of values of the property. It can be used in searches.

Parameters:

name - the name of the property

value - the value of the property