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

Class ChannelsByServerImportResponse

java.lang.Object

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

public class ChannelsByServerImportResponse
extends Object

Response object for the "import channel configuration" 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

Constructor Summary

Constructors

Constructor and Description
ChannelsByServerImportResponse(Map<String,String> addOrUpdateFailed, Set<String> addOrUpdateSucceeded, String errorMessage, Map<String,String> removeFailed, Set<String> removeSucceeded) Creates a new response.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Map<String,String>	getAddOrUpdateFailed() Returns the channels for which an add or update operation failed.
Set<String>	getAddOrUpdateSucceeded() Returns the channels for which an add or update operation succeeded.
String	getErrorMessage() Returns the error message indicating a global error (an error that happened before changed where made to the configuration).
Map<String,String>	getRemoveFailed() Returns the channels for which a remove operation failed.
Set<String>	getRemoveSucceeded() Returns the channels for which a remove operation succeeded.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelsByServerImportResponse

public ChannelsByServerImportResponse(Map<String,String> addOrUpdateFailed,
                                      Set<String> addOrUpdateSucceeded,
                                      String errorMessage,
                                      Map<String,String> removeFailed,
                                      Set<String> removeSucceeded)

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

Parameters:

addOrUpdateFailed - channels for which an add or update operation failed. The keys are the channel names and the values are the respective error messages. null if running in simulation mode or if there is a global error.

addOrUpdateSucceeded - channels for which an add or update operation succeeded. null if there is a global error.

errorMessage - error message indicating a global error (an error that happened before changes where made to the configuration). null if there is no global error (there might still be errors for individual channels).

removeFailed - channels for which a remove operation failed. The keys are the channel names and the values are the respective error messages. null if running in simulation mode or if there is a global error.

removeSucceeded - channels for which a remove operation succeeded. null if there is a global error.

Method Detail

getAddOrUpdateFailed

public Map<String,String> getAddOrUpdateFailed()

Returns the channels for which an add or update operation failed. The keys are the channel names and the values are the respective error messages. null if running in simulation mode or if there is a global error.

Returns:

map containing channel names with a failed add or update operation and the respective error messages.

getAddOrUpdateSucceeded

public Set<String> getAddOrUpdateSucceeded()

Returns the channels for which an add or update operation succeeded. null if there is a global error.

Returns:

channels for which an add or update operation succeeded.

getErrorMessage

public String getErrorMessage()

Returns the error message indicating a global error (an error that happened before changed where made to the configuration). null if there is no global error (there might still be errors for individual channels).

Returns:

global error message.

getRemoveFailed

public Map<String,String> getRemoveFailed()

Returns the channels for which a remove operation failed. The keys are the channel names and the values are the respective error messages. null if running in simulation mode or if there is a global error.

Returns:

map containing channel names with a failed remove operation and the respective error messages.

getRemoveSucceeded

public Set<String> getRemoveSucceeded()

Returns the channels for which a remove operation succeeded. null if there is a global error.

Returns:

channels for which a remove operation succeeded.

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