server.msg

Class SimpleRequest

java.lang.Object

server.msg.SimpleRequest

All Implemented Interfaces:

org.json.JSONString

Direct Known Subclasses:

SimpleEchoRequest, SimpleLogRequest, SimpleProfileRequest, SimpleQueryRequest, SimpleQuitRequest

public abstract class SimpleRequest
extends java.lang.Object
implements org.json.JSONString

Example request type and parser.

Requests are represented as JSON as follows: { request = { "#mandatory" : [ "type", "data" ], "type" : "string", "data" : "object", } } where:

• type is the request type.
• data is the request data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleRequest.Type Request type.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleRequest(SimpleRequest.Type type, java.lang.String identity, SimpleUser user) Create a simple request with the provided data.

Method Summary

Methods

Modifier and Type	Method and Description
abstract SimpleRespondMessageContext	execute() Executes the operation and returns the response.
abstract org.json.JSONObject	getData()
java.lang.String	getIdentity()
SimpleRequest.Type	getType()
SimpleUser	getUser()
static SimpleRequest	parse(java.lang.String identity, SimpleUser user, com.netflix.msl.msg.MessageInputStream request, java.util.Map<java.lang.String,com.netflix.msl.crypto.ICryptoContext> cryptoContexts) Parse a request from the provided input stream.
java.lang.String	toJSONString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleRequest

protected SimpleRequest(SimpleRequest.Type type,
             java.lang.String identity,
             SimpleUser user)

Create a simple request with the provided data.

Parameters:

type - request type.

identity - request entity identity.

user - request user. May be null.

Method Detail

parse

public static SimpleRequest parse(java.lang.String identity,
                  SimpleUser user,
                  com.netflix.msl.msg.MessageInputStream request,
                  java.util.Map<java.lang.String,com.netflix.msl.crypto.ICryptoContext> cryptoContexts)
                           throws SimpleRequestUnknownException,
                                  SimpleRequestParseException,
                                  SimpleRequestUserException,
                                  java.io.IOException

Parse a request from the provided input stream. The requesting entity identity must be provided. The requesting user may be null.

Parameters:

identity - request entity identity.

user - request user. May be null.

request - request data.

cryptoContexts - service token crypto contexts.

Returns:

the parsed request.

Throws:

java.io.IOException - if there is an error reading from the input stream.

SimpleRequestUnknownException - if the request cannot be identified.

SimpleRequestParseException - if the request data fails to parse successfully.

SimpleRequestUserException - if the request type requires a user but there is none provided.

getType

public SimpleRequest.Type getType()

Returns:

the request type.

getIdentity

public java.lang.String getIdentity()

Returns:

the request entity identity.

getUser

public SimpleUser getUser()

Returns:

the request user. May be null.

getData

public abstract org.json.JSONObject getData()

Returns:

the request data object.

execute

public abstract SimpleRespondMessageContext execute()
                                             throws SimpleRequestUserException,
                                                    SimpleRequestExecutionException

Executes the operation and returns the response.

Returns:

the response.

Throws:

SimpleRequestUserException - if the request type requires a user but there is none provided.

SimpleRequestExecutionException - if there is an error executing the request.

toJSONString

public java.lang.String toJSONString()

Specified by:

toJSONString in interface org.json.JSONString