com.aquenos.cassandra.pvarchiver.server.web.admin.controller.wsapi

Class ChannelsByServerResponse

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.web.admin.controller.wsapi.ChannelsByServerResponse

public class ChannelsByServerResponse
extends Object

Response object for the "list channels for a server" function of the web-service API.

This object is primarily intended to facilitate the JSON serialization of the data provided by the API controller. For this reason, it does not perform any checks on the parameters used to construct the object.

Author:

Sebastian Marsching

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ChannelsByServerResponse.ChannelItem Individual channel item in the ChannelsByServerResponse.

Constructor Summary

Constructors

Constructor and Description
ChannelsByServerResponse(List<ChannelsByServerResponse.ChannelItem> channels, boolean statusAvailable) Creates a new response.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<ChannelsByServerResponse.ChannelItem>	getChannels() Returns the list of all channels that exist for the specified server.
int	hashCode()
boolean	isStatusAvailable() Tells whether status information is available.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelsByServerResponse

public ChannelsByServerResponse(List<ChannelsByServerResponse.ChannelItem> channels,
                                boolean statusAvailable)

Creates a new response. The response simply wraps the list of channels. This constructor does not verify the validity of the arguments and simply uses them as-is.

Parameters:

channels - information about all channels that are defined for the specified server.

statusAvailable - true if channels contains information about the channels' status, false if it only contains configuration information.

Method Detail

getChannels

public List<ChannelsByServerResponse.ChannelItem> getChannels()

Returns the list of all channels that exist for the specified server.

Returns:

list of channels for the specified server.

isStatusAvailable

public boolean isStatusAvailable()

Tells whether status information is available. If status information is not available,the list of channels only contains configuration information and the attributes referring to status information are null.

Returns:

true if status information for the channels is available, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object