server.msg

Class SimpleLogRequest

java.lang.Object

server.msg.SimpleRequest

server.msg.SimpleLogRequest

All Implemented Interfaces:

org.json.JSONString

public class SimpleLogRequest
extends SimpleRequest

Request to log a message.

The request data object is defined as: data = { "#mandatory" : [ "timestamp", "severity", "message" ], "timestamp" : "number", "severity" : enum(ERROR|WARN|INFO), "message" : "string", } where:

• timestamp is the log message time in seconds since the UNIX epoch.
• severity is the log message severity.
• message is the log message text.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleLogRequest.Severity Log message severity.

Nested classes/interfaces inherited from class server.msg.SimpleRequest

SimpleRequest.Type

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERVICETOKEN_LOGDATA_NAME Log data service token name.

Constructor Summary

Constructors

Constructor and Description
SimpleLogRequest(java.lang.String identity, SimpleUser user, org.json.JSONObject data, java.util.Set<com.netflix.msl.tokens.ServiceToken> tokens, java.util.Map<java.lang.String,com.netflix.msl.crypto.ICryptoContext> cryptoContexts) Create a new log request.

Method Summary

Methods

Modifier and Type	Method and Description
SimpleRespondMessageContext	execute() Executes the operation and returns the response.
org.json.JSONObject	getData()
java.lang.String	getMessage()
SimpleLogRequest.Severity	getSeverity()
long	getTimestamp() Returns the log message timestamp in seconds since the UNIX epoch.

Methods inherited from class server.msg.SimpleRequest

getIdentity, getType, getUser, parse, toJSONString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVICETOKEN_LOGDATA_NAME

public static final java.lang.String SERVICETOKEN_LOGDATA_NAME

Log data service token name.

See Also:

Constant Field Values

Constructor Detail

SimpleLogRequest

public SimpleLogRequest(java.lang.String identity,
                SimpleUser user,
                org.json.JSONObject data,
                java.util.Set<com.netflix.msl.tokens.ServiceToken> tokens,
                java.util.Map<java.lang.String,com.netflix.msl.crypto.ICryptoContext> cryptoContexts)
                 throws SimpleRequestParseException

Create a new log request.

Parameters:

identity - requesting entity identity.

user - requesting user. May be null.

data - the request data object.

tokens - service tokens.

cryptoContext - service token crypto contexts.

Throws:

SimpleRequestParseException - if there is an error parsing the request data.

Method Detail

getTimestamp

public long getTimestamp()

Returns the log message timestamp in seconds since the UNIX epoch.

Returns:

the log message timestamp.

getSeverity

public SimpleLogRequest.Severity getSeverity()

Returns:

the log message severity.

getMessage

public java.lang.String getMessage()

Returns:

the log message.

getData

public org.json.JSONObject getData()

Specified by:

getData in class SimpleRequest

Returns:

the request data object.

execute

public SimpleRespondMessageContext execute()

Description copied from class: SimpleRequest

Executes the operation and returns the response.

Specified by:

execute in class SimpleRequest

Returns:

the response.