com.techempower.gemini.cluster.message.ResponseMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gemini Show documentation
Gemini is a web framework created by TechEmpower.
There is a newer version: 3.3.14
/*******************************************************************************
 * Copyright (c) 2018, TechEmpower, Inc.
 * 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 TechEmpower, Inc. 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL TECHEMPOWER, INC. 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 com.techempower.gemini.cluster.message;

/**
 * A "response" sent from the Master Server to a Client following the receipt
 * of a RequestMessage.
 */
public class ResponseMessage
     extends Message
{
  private static final long serialVersionUID = 1L;

  //
  // Constants.
  //
  
  public static final int STATUS_GOOD  = 0;
  public static final int STATUS_ERROR = 1;
  
  //
  // Variables.
  //

  /**
   * The server's evaluation of the request's response.
   */
  private int status = STATUS_GOOD;

  /**
   * The request ID to which this is a response.
   */
  private long requestId;
  
  //
  // Methods.
  //
  
  /**
   * Gets the status.
   */
  public int getStatus()
  {
    return this.status;
  }
  
  /**
   * Is the response status good?
   */
  public boolean isGood()
  {
    return getStatus() == STATUS_GOOD;
  }
  
  /**
   * Sets the status.
   */
  public void setStatus(int status)
  {
    this.status = status;
  }
  
  /**
   * Gets the referenced request's ID. 
   */
  public long getRequestId()
  {
    return this.requestId;
  }
  
  /**
   * Sets the referenced request's ID.
   */
  public void setRequestId(long id)
  {
    this.requestId = id;
  }
  
}