/*************************************************************************

"FreePastry" Peer-to-Peer Application Development Substrate 

Copyright 2002, Rice University. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

- Neither  the name  of Rice  University (RICE) nor  the names  of its
contributors may be  used to endorse or promote  products derived from
this software without specific prior written permission.

This software is provided by RICE and the contributors on an "as is"
basis, without any representations or warranties of any kind, express
or implied including, but not limited to, representations or
warranties of non-infringement, merchantability or fitness for a
particular purpose. In no event shall RICE or contributors be liable
for any direct, indirect, incidental, special, exemplary, or
consequential damages (including, but not limited to, procurement of
substitute goods or services; loss of use, data, or profits; or
business interruption) however caused and on any theory of liability,
whether in contract, strict liability, or tort (including negligence
or otherwise) arising in any way out of the use of this software, even
if advised of the possibility of such damage.

********************************************************************************/

package rice.p2p.multiring;

import rice.p2p.commonapi.*;
import rice.p2p.commonapi.rawserialization.*;

import java.io.*;

/**
 * @(#) MultiringRouteMessage.java This wraps a real RouteMessage.
 *
 * @version $Id: MultiringRouteMessage.java 3274 2006-05-15 16:17:47Z jeffh $
 * @author Alan Mislove
 * @author Peter Druschel
 */
public class MultiringRouteMessage implements RouteMessage {

  /**
   * The internal message
   */
  protected RouteMessage message;

  /**
   * The messages's ringId
   */
  protected Id ringId;

  /**
   * Constructor
   *
   * @param ringId DESCRIBE THE PARAMETER
   * @param message DESCRIBE THE PARAMETER
   */
  protected MultiringRouteMessage(Id ringId, RouteMessage message) {
    this.ringId = ringId;
    this.message = message;

    if ((ringId instanceof RingId) || (message instanceof MultiringRouteMessage)) {
      throw new IllegalArgumentException("Illegal creation of MRRouteMessage: " + ringId.getClass() + ", " + message.getClass());
    }
  }

  /**
   * Returns the internal route message
   *
   * @return The internal route message
   */
  protected RouteMessage getRouteMessage() {
    return message;
  }

  /**
   * Returns the destination Id for this message
   *
   * @return The destination Id
   */
  public Id getDestinationId() {
    return RingId.build(ringId, message.getDestinationId());
  }

  /**
   * Returns the next hop handle for this message
   *
   * @return The next hop
   */
  public NodeHandle getNextHopHandle() {
    return new MultiringNodeHandle(ringId, message.getNextHopHandle());
  }

  /**
   * Returns the enclosed message inside of this message
   *
   * @return The enclosed message
   */
  public Message getMessage() {
    return message.getMessage();
  }

  /**
   * Gets the Message attribute of the MultiringRouteMessage object
   *
   * @param md DESCRIBE THE PARAMETER
   * @return The Message value
   * @exception IOException DESCRIBE THE EXCEPTION
   */
  public Message getMessage(MessageDeserializer md) throws IOException {
    return message.getMessage(md);
  }

  /**
   * Sets the destination Id for this message
   *
   * @param id The destination Id
   */
  public void setDestinationId(Id id) {
    message.setDestinationId(((RingId) id).getId());
  }

  /**
   * Sets the next hop handle for this message
   *
   * @param nextHop The next hop for this handle
   */
  public void setNextHopHandle(NodeHandle nextHop) {
    message.setNextHopHandle(((MultiringNodeHandle) nextHop).getHandle());
  }

  /**
   * Sets the internal message for this message
   *
   * @param message The internal message
   */
  public void setMessage(Message message) {
    if (message instanceof RawMessage) {
      setMessage((RawMessage) message);
    } else {
      this.message.setMessage(message);
    }
  }

  /**
   * Better performance.
   *
   * @param message The new Message value
   */
  public void setMessage(RawMessage message) {
    this.message.setMessage(message);
  }

}

