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

"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.pastry.join;

import rice.pastry.*;
import rice.pastry.messaging.*;
import rice.pastry.security.*;
import rice.pastry.routing.*;
import rice.pastry.leafset.*;

import java.io.*;
import java.util.*;

/**
 * Request to join this network.
 *
 * @version $Id: JoinRequest.java,v 1.11 2005/06/29 18:01:41 jstewart Exp $
 * @author Andrew Ladd
 */

public class JoinRequest extends Message implements Serializable {

  private NodeHandle handle;

  private NodeHandle joinHandle;

  private int rowCount;

  private RouteSet rows[][];

  private LeafSet leafSet;

  final static long serialVersionUID = 231671018732832563L;

  /**
   * Constructor.
   *
   * @param nh a handle of the node trying to join the network.
   * @param rtBase DESCRIBE THE PARAMETER
   */

  public JoinRequest(NodeHandle nh, int rtBase) {
    super(new JoinAddress());
    handle = nh;
    initialize(rtBase);
    setPriority(0);
  }

  /**
   * Constructor.
   *
   * @param nh a handle of the node trying to join the network.
   * @param stamp the timestamp
   * @param rtBase DESCRIBE THE PARAMETER
   */

  public JoinRequest(NodeHandle nh, Date stamp, int rtBase) {
    super(new JoinAddress(), stamp);
    handle = nh;
    initialize(rtBase);
    setPriority(0);
  }

  /**
   * Constructor.
   *
   * @param nh a handle of the node trying to join the network.
   * @param cred the credentials
   * @param rtBase DESCRIBE THE PARAMETER
   */

  public JoinRequest(NodeHandle nh, Credentials cred, int rtBase) {
    super(new JoinAddress(), cred);
    handle = nh;
    initialize(rtBase);
    setPriority(0);
  }

  /**
   * Constructor.
   *
   * @param nh a handle of the node trying to join the network.
   * @param cred the credentials
   * @param stamp the timestamp
   * @param rtBase DESCRIBE THE PARAMETER
   */

  public JoinRequest(NodeHandle nh, Credentials cred, Date stamp, int rtBase) {
    super(new JoinAddress(), cred, stamp);
    handle = nh;
    initialize(rtBase);
    setPriority(0);
  }

  /**
   * Gets the handle of the node trying to join.
   *
   * @return the handle.
   */

  public NodeHandle getHandle() {
    return handle;
  }

  /**
   * Gets the handle of the node that accepted the join request;
   *
   * @return the handle.
   */

  public NodeHandle getJoinHandle() {
    return joinHandle;
  }

  /**
   * Gets the leafset of the node that accepted the join request;
   *
   * @return the leafset.
   */

  public LeafSet getLeafSet() {
    return leafSet;
  }

  /**
   * Get row.
   *
   * @param i the row to get.
   * @return the row.
   */

  public RouteSet[] getRow(int i) {
    return rows[i];
  }

  /**
   * Returns true if the request was accepted, false if it hasn't yet.
   *
   * @return DESCRIBE THE RETURN VALUE
   */

  public boolean accepted() {
    return joinHandle != null;
  }

  /**
   * Accept join request.
   *
   * @param nh the node handle that accepts the join request.
   * @param ls DESCRIBE THE PARAMETER
   */

  public void acceptJoin(NodeHandle nh, LeafSet ls) {
    joinHandle = nh;
    leafSet = ls;
  }

  /**
   * Returns the number of rows left to determine (in order).
   *
   * @return the number of rows left.
   */

  public int lastRow() {
    return rowCount;
  }

  /**
   * Push row.
   *
   * @param row the row to push.
   */

  public void pushRow(RouteSet row[]) {
    rows[--rowCount] = row;
  }

  /**
   * Get the number of rows.
   *
   * @return the number of rows.
   */

  public int numRows() {
    return rows.length;
  }

  /**
   * DESCRIBE THE METHOD
   *
   * @param rtBaseBitLength DESCRIBE THE PARAMETER
   */
  private void initialize(int rtBaseBitLength) {
    joinHandle = null;

    rowCount = NodeId.nodeIdBitLength / rtBaseBitLength;

    rows = new RouteSet[rowCount][];
  }

  /**
   * DESCRIBE THE METHOD
   *
   * @return DESCRIBE THE RETURN VALUE
   */
  public String toString() {
    return "JoinRequest(" + (handle != null ? handle.getNodeId() : null) + ","
      + (joinHandle != null ? joinHandle.getNodeId() : null) + ")";
  }
}

