/**
* Copyright (C) 2002-2012 The FreeCol Team
*
* This file is part of FreeCol.
*
* FreeCol is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* FreeCol is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with FreeCol. If not, see <http://www.gnu.org/licenses/>.
*/
package net.sf.freecol.common.networking;
import net.sf.freecol.common.model.Game;
import net.sf.freecol.common.model.Player;
import net.sf.freecol.common.model.TradeRoute;
import net.sf.freecol.server.FreeColServer;
import net.sf.freecol.server.model.ServerPlayer;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
/**
* The message sent when updating a trade route.
*/
public class UpdateTradeRouteMessage extends DOMMessage {
/**
* The trade route to update.
*/
private TradeRoute tradeRoute;
/**
* Create a new <code>UpdateTradeRouteMessage</code> with the
* supplied trade route.
*
* @param tradeRoute The <code>TradeRoute</code> to update.
*/
public UpdateTradeRouteMessage(TradeRoute tradeRoute) {
this.tradeRoute = tradeRoute;
}
/**
* Create a new <code>UpdateTradeRouteMessage</code> from a
* supplied element.
*
* @param game The <code>Game</code> this message belongs to.
* @param element The <code>Element</code> to use to create the message.
*/
public UpdateTradeRouteMessage(Game game, Element element) {
tradeRoute = (element.getChildNodes().getLength() != 1) ? null
: SetTradeRoutesMessage.tradeRouteFromElement(game,
(Element) element.getChildNodes().item(0));
}
/**
* Handle a "updateTradeRoute"-message.
*
* @param server The <code>FreeColServer</code> handling the message.
* @param connection The <code>Connection</code> message was received on.
*
* @return An update containing the updateTradeRouted unit,
* or an error <code>Element</code> on failure.
*/
public Element handle(FreeColServer server, Connection connection) {
Game game = server.getGame();
ServerPlayer serverPlayer = server.getPlayer(connection);
if (tradeRoute == null || tradeRoute.getId() == null
|| !SetTradeRoutesMessage.hasPrefix(tradeRoute)) {
return DOMMessage.clientError("Bogus route");
}
String id = SetTradeRoutesMessage.removePrefix(tradeRoute);
if (!(game.getFreeColGameObject(id) instanceof TradeRoute)) {
return DOMMessage.clientError("Not a trade route: " + id);
}
TradeRoute realRoute = (TradeRoute) game.getFreeColGameObject(id);
if (tradeRoute.getOwner() != (Player) serverPlayer) {
return DOMMessage.clientError("Not your trade route: " + id);
}
realRoute.updateFrom(tradeRoute);
tradeRoute.dispose();
return null;
}
/**
* Convert this UpdateTradeRouteMessage to XML.
*
* @return The XML representation of this message.
*/
public Element toXMLElement() {
Element result = createNewRootElement(getXMLElementTagName());
Document doc = result.getOwnerDocument();
result.appendChild(tradeRoute.toXMLElement(null, doc));
return result;
}
/**
* The tag name of the root element representing this object.
*
* @return "updateTradeRoute".
*/
public static String getXMLElementTagName() {
return "updateTradeRoute";
}
}