server.msg

Class SimpleQuitRequest

java.lang.Object

server.msg.SimpleRequest

server.msg.SimpleQuitRequest

All Implemented Interfaces:

org.json.JSONString

public class SimpleQuitRequest
extends SimpleRequest

Request to terminate the server. Only the server administrator is permitted to execute this request.

The request data object is defined as an empty JSON object.

Nested Class Summary

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

SimpleRequest.Type

Constructor Summary

Constructors

Constructor and Description
SimpleQuitRequest(java.lang.String identity, SimpleUser user, org.json.JSONObject data) Create a new quit request.

Method Summary

Methods

Modifier and Type	Method and Description
SimpleRespondMessageContext	execute() Executes the operation and returns the response.
org.json.JSONObject	getData()

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

Constructor Detail

SimpleQuitRequest

public SimpleQuitRequest(java.lang.String identity,
                 SimpleUser user,
                 org.json.JSONObject data)

Create a new quit request.

Parameters:

identity - requesting entity identity.

user - requesting user. May be null.

data -

Method Detail

getData

public org.json.JSONObject getData()

Specified by:

getData in class SimpleRequest

Returns:

the request data object.

execute

public SimpleRespondMessageContext execute()
                                    throws SimpleRequestUserException

Description copied from class: SimpleRequest

Executes the operation and returns the response.

Specified by:

execute in class SimpleRequest

Returns:

the response.

Throws:

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