org.lockss.poller.Poll Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lockss-core Show documentation
The Slimmed Down LOCKSS Daemon Core
The newest version!
/*
* $Id$
 */

/*

Copyright (c) 2003 Board of Trustees of Leland Stanford Jr. University,
all rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
STANFORD UNIVERSITY BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of Stanford University shall not
be used in advertising or otherwise to promote the sale, use or other dealings
in this Software without prior written authorization from Stanford University.

*/
package org.lockss.poller;

import org.lockss.plugin.ArchivalUnit;
import org.lockss.plugin.CachedUrlSet;
import org.lockss.protocol.LcapMessage;
import org.lockss.protocol.PeerIdentity;
import org.lockss.util.time.Deadline;

public interface Poll {
  // Poll type names
  public static final String[] POLL_NAME = {
    "V1 Name", "V1 Content", "V1 Verify",
    "V3 Poller", "V3 Voter"
  };

  public static final String[] PROTOCOL_NAME = {
    "Undefined", "V1", "V2", "V3"
  };

  // Poll type enum
  public static final int V1_NAME_POLL = 0;
  public static final int V1_CONTENT_POLL = 1;
  public static final int V1_VERIFY_POLL = 2;
  public static final int V3_POLL = 3;
//  public static final int V3_POLLER = 3;
//  public static final int V3_VOTER = 4;

  // Protocol version enum
  public static final int UNDEFINED_PROTOCOL = 0;
  public static final int V1_PROTOCOL = 1;
  public static final int V2_PROTOCOL = 2;
  public static final int V3_PROTOCOL = 3;

  public static final int MAX_PROTOCOL = 3;

//  // Protocol version param
//  public static final String PARAM_USE_PROTOCOL_VERSION =
//    Configuration.PREFIX + "protocol.useProtocolVersion";
//  public static final int DEFAULT_USE_PROTOCOL_VERSION = V1_PROTOCOL;


  /**
   * Error was return by hasher while attempting schedule hash - this
   * usually indicates the hasher is busy but may mean hash time was invalid
   */
  public static final int ERR_SCHEDULE_HASH = -1;
  /**
   * Error was returned by hasher via the callback interface.
   */
  public static final int ERR_HASHING = -2;
  /**
   * Error occured when attempting to send a reply or request packet
   */
  public static final int ERR_IO = -3;
  /**
   * Poll aborted (e.g., due to AU inactivated)
   */
  public static final int ERR_ABORTED = -4;

  /**
   * Return the poll spec used by this poll
   * @return the PollSpec
   */
  public PollSpec getPollSpec();

  /**
   * Return the CachedUrlSet for this poll.
   *
   * @return The CachedUrlSet.
   */
  public CachedUrlSet getCachedUrlSet();

  /* Return the version of the protocol in use
   * @return the protocol version
   */
  public int getVersion();

  /**
   * get the message used to define this Poll
   * @return Message
   */
  public LcapMessage getMessage();

  /**
   * get the poll identifier key
   * @return the key as a String
   */
  public String getKey();

  /**
   * Return the poll's deadline
   * @return the Deadline object for this poll.
   */
  public Deadline getDeadline();

  /**
   * Start a poll.
   */
  public void startPoll();

  /**
   * Stop a poll.
   */
  public void stopPoll();

  /**
   * Abort a poll.
   */
  public void abortPoll();

  /**
   * Return the type of the poll.
   *
   * @return The type of the poll.
   */
  public int getType();

  /**
   * Return the AU associated with this poll.
   *
   * @return The AU associated with this poll.
   */
  public ArchivalUnit getAu();

  /**
   * Return the current status of this poll.
   *
   * @return  The current poll status.
   */
  public String getStatusString();

  /**
   * Set the message that triggered this poll.
   *
   * @param msg
   */
  void setMessage(LcapMessage msg);

  /**
   * Return the time that this poll was created.
   */
  long getCreateTime();


  /**
   * Recieve and incoming message from the PollManager
   * @param msg the incoming msg containing a vote for this poll
   */
  void receiveMessage(LcapMessage msg);


  /**
   * Is this poll currently active?
   *
   * @return True if the poll is active.
   */
  boolean isPollActive();

  /**
   * Is this poll currently active?
   *
   * @return True if the poll is complete.
   */
  boolean isPollCompleted();
}