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

Class ChannelsByServerImportRequest

java.lang.Object

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

public class ChannelsByServerImportRequest
extends Object

Request object for the "import channel configuration" function of the web-service API.

This class is primarily intended to facilitate JSON deserialization of the data provided by an API client. The input data is validated to ensure that it conforms to the API specification.

Author:

Sebastian Marsching

Constructor Summary

Constructors

Constructor and Description
ChannelsByServerImportRequest(Boolean addChannels, byte[] configurationFile, Boolean removeChannels, Boolean simulate, Boolean updateChannels) Creates a new request object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
byte[]	getConfigurationFile() Returns the contents of the configuration file that shall be imported.
int	hashCode()
boolean	isAddChannels() Tells whether channels should be added to the server configuration.
boolean	isRemoveChannels() Tells whether channels that only exist on the server should be removed.
boolean	isSimulate() Tells whether changes should actually be applied (false or should only be simulated (true).
boolean	isUpdateChannels() Tells whether channels on the server should be updated.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelsByServerImportRequest

public ChannelsByServerImportRequest(Boolean addChannels,
                                     byte[] configurationFile,
                                     Boolean removeChannels,
                                     Boolean simulate,
                                     Boolean updateChannels)

Creates a new request object.

Parameters:

addChannels - tells whether channels should be added to the server configuration. If true channels that exist in the configuration file but not on the server are added. If false channels that exist in the configuration file but not on the server are not added. If null, a value of false is assumed.

configurationFile - configuration file contents. These contents must represent a valid XML configuration file. Contents that do not constitute a valid XML configuration file will not lead to this constructor throwing an exception, but will later result in an exception when the file's contents are processed.

removeChannels - tells whether channels that only exist on the server should be removed. If true, channels that exist on the server but not in the configuration file are removed. If false, channels that exist on the server but not in the configuration file are simply ignored. If null, a value of false is assumed.

simulate - tells whether changes should actually be applied (false or should only be simulated (true). If null, a value of false is assumed.

updateChannels - tells whether channels on the server should be updated. If true, channels that exist in the configuration file and on the server are updated with the configuration specified in the configuration file. If false, channels in the configuration file that also exist on the server are not touched. If null, a value of false is assumed.

Throws:

NullPointerException - if configurationFile is null.

Method Detail

isAddChannels

public boolean isAddChannels()

Tells whether channels should be added to the server configuration. If true channels that exist in the configuration file but not on the server are added. If false channels that exist in the configuration file but not on the server are not added.

Returns:

true if missing channels shall be added to the server, false if no new channels shall be added to the server.

getConfigurationFile

public byte[] getConfigurationFile()

Returns the contents of the configuration file that shall be imported.

Returns:

configuration file contents.

isRemoveChannels

public boolean isRemoveChannels()

Tells whether channels that only exist on the server should be removed. If true, channels that exist on the server but not in the configuration file are removed. If false, channels that exist on the server but not in the configuration file are simply ignored.

Returns:

true if channels that are missing in the configuration file shall also be removed from the server, false if no channels shall be removed.

isSimulate

public boolean isSimulate()

Tells whether changes should actually be applied (false or should only be simulated (true).

Returns:

true if the import process should run in simulation mode, false if changes to the server configuration shall actually be made.

isUpdateChannels

public boolean isUpdateChannels()

Tells whether channels on the server should be updated. If true, channels that exist in the configuration file and on the server are updated with the configuration specified in the configuration file. If false, channels in the configuration file that also exist on the server are not touched.

Returns:

true if the configuration for existing channels shall be updated, false if existing channels shall not be touched.

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