SocketHelper.java

/* ====================================================================
 * Limited Evaluation License:
 *
 * This software is open source, but licensed. The license with this package
 * is an evaluation license, which may not be used for productive systems. If
 * you want a full license, please contact us.
 *
 * The exclusive owner of this work is the OpenRate project.
 * This work, including all associated documents and components
 * is Copyright of the OpenRate project 2006-2015.
 *
 * The following restrictions apply unless they are expressly relaxed in a
 * contractual agreement between the license holder or one of its officially
 * assigned agents and you or your organisation:
 *
 * 1) This work may not be disclosed, either in full or in part, in any form
 *    electronic or physical, to any third party. This includes both in the
 *    form of source code and compiled modules.
 * 2) This work contains trade secrets in the form of architecture, algorithms
 *    methods and technologies. These trade secrets may not be disclosed to
 *    third parties in any form, either directly or in summary or paraphrased
 *    form, nor may these trade secrets be used to construct products of a
 *    similar or competing nature either by you or third parties.
 * 3) This work may not be included in full or in part in any application.
 * 4) You may not remove or alter any proprietary legends or notices contained
 *    in or on this work.
 * 5) This software may not be reverse-engineered or otherwise decompiled, if
 *    you received this work in a compiled form.
 * 6) This work is licensed, not sold. Possession of this software does not
 *    imply or grant any right to you.
 * 7) You agree to disclose any changes to this work to the copyright holder
 *    and that the copyright holder may include any such changes at its own
 *    discretion into the work
 * 8) You agree not to derive other works from the trade secrets in this work,
 *    and that any such derivation may make you liable to pay damages to the
 *    copyright holder
 * 9) You agree to use this software exclusively for evaluation purposes, and
 *    that you shall not use this software to derive commercial profit or
 *    support your business or personal activities.
 *
 * This software is provided "as is" and any expressed or impled warranties,
 * including, but not limited to, the impled warranties of merchantability
 * and fitness for a particular purpose are disclaimed. In no event shall
 * The OpenRate Project or its officially assigned agents be liable to 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 any business interruption) however caused
 * and on 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.
 * This software contains portions by The Apache Software Foundation, Robert
 * Half International.
 * ====================================================================
 */

package OpenRate.configurationmanager;

import java.io.PrintStream;

/**
 * @author = g.z.
 * This class helps the socket listener execute methods that could be<br/>
 * used by other objects. This usually involves displaying of the <br/>
 * listener's response to the command issued, or manipulation of the <br/>
 * SockectConnectionData object.
 *
 */

public class SocketHelper
{
  /**
   * This method displays the welcome message when an allowed connection <br/>
   * is made.
   *
   * @param out The print stream to display the message on
   */

  public static void displayWelcomeMessage(PrintStream out)
  {
    out.print(appendOpenRate(SocketProtocol.getWelcomeMessage()));
    out.flush();
  }

  /**
   * This method displays the response of the listener depending on the <br/>
   * String output passed in the parameter.
   *
   * @param out The print stream to display the message on
   * @param output The message to display
   */

  public static void displayResponse(PrintStream out, String output)
  {
    out.print(appendOpenRate(output));
    out.flush();
  }

  /**
   * This method assists the display***() methods by appending a String <br/>
   * 'openrate> ' to the response for display purposes.
   * @param output
   * @return
   */
  private static String appendOpenRate(String output)
  {
    return output.concat(SocketConstants.OPENRATETAB);
  }

  /**
   * This method displays the quit message when user or admin quits from<br/>
   * the console.
   * @param out
   */
  public static void displayQuitMessage(PrintStream out)
  {
    out.println(SocketConstants.OPENRATETAB.concat(SocketConstants.GOODBYE));
  }

  /**
   * This method deducts from the number of connection from the <br/>
   * SocketConnectionData.
   * @param socData
   */
  public static void removeAConnectionCount(SocketConnectionData socData)
  {
    int conNum = socData.getConnectionNumber();
    socData.setConnectionNumber(--conNum);
  }

  /**
   * This method adds 1 to the number of connection from the <br/>
   * SocketConnectionData.
   * @param socData
   */
  public static void addAConnectionCount(SocketConnectionData socData)
  {
    int conNum = socData.getConnectionNumber();
    socData.setConnectionNumber(++conNum);
  }
}