commandutility.java

LemonSMS is a component developed in Java that provides a turnkey solution for application developer

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2003 Melvin Dave P. Vivas. All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *    "This product includes software developed by Melvin Dave P. Vivas."
 *    Alternately, this acknowledgment may appear in the software
 *    itself, if and wherever such third-party acknowledgments
 *    normally appear.
 *
 * 4. The names "LemonSMS", and "Melvin Dave P. Vivas"
 *    must not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact [e-mail].
 *
 * 5. Products derived from this software may not be called "LemonSMS",
 *    nor may "LemonSMS" appear in their name, without prior written
 *    permission of Melvin Dave P. Vivas.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 THE APACHE SOFTWARE FOUNDATION OR
 * ITS 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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by 
 * individuals on behalf of the LemonSMS project. For more
 * information , please see <http://www.sourceforge.net/projects/lemonsms>.
 */

package net.lemongreen.mobile.smslibrary;

//import gnu.io.*;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

public final class CommandUtility implements ATCommandIF, Loggable{
		
	private OutputStream serialOS = null;
	private InputStream serialIS = null;

	public CommandUtility(String portUsed) throws LemonSMSException{
		try {
			CommPortDriver portDrvr = new CommPortDriver(portUsed);
			serialOS = portDrvr.getPortOutputStream();
			serialIS = portDrvr.getPortInputStream();
		} catch (LemonSMSException e) {
			throw new LemonSMSException(this.getClass().getName() + " : CommandUtility() " + e.getCause());
		}
	}

	protected final byte[] getCommand(String command) {
		return command.getBytes();
	}
	protected final byte[] getCommandPlusSuffix(String command, int suffix) {
		return (command + (char) suffix).getBytes();
	}
	protected final byte[] getCommandPlusPrefix(String command, int prefix) {
		return ((char) prefix + command).getBytes();
	}

	public final void executeCommand(String command) throws LemonSMSException{

		try {
			serialOS.write(getCommand(command));
		} catch (IOException e) {
			logger.error(e);			
			throw new LemonSMSException(this.getClass().getName() + " : executeCommand(String) :" + e.getCause());
		} catch (Exception e) {			
			logger.error(e);
			throw new LemonSMSException(this.getClass().getName() + " : executeCommand(String) :" + e.getCause());			
		}
	}

	public final void executeCommand(byte[] command) throws LemonSMSException{

		try {
			serialOS.write(command);
		} catch (IOException e) {
			logger.error(e);
			throw new LemonSMSException(this.getClass().getName() + " : executeCommand(byte) " + e.getCause());
		} catch (Exception e) {
			logger.error(e);
			throw new LemonSMSException(this.getClass().getName() + " : executeCommand(byte) " + e.getCause());
		}
	}

	public final void destroy() throws LemonSMSException{
		try {
			serialIS.close();
			serialOS.close();
			serialIS = null;
			serialOS = null;
		} catch (IOException e) {
			throw new LemonSMSException(this.getClass().getName() + " : destroy() " + e.getCause());
		}

	}
	
	public final String getCommandResponse() throws LemonSMSException{
		String response = null;
		try {
			response = getResponseString();
		} catch (LemonSMSException e) {
			throw new LemonSMSException(this.getClass().getName() + " : () " + e.getCause());
		}
		
		return response;
	}

	public final String getResponseString() throws LemonSMSException{
		StringBuffer sBuffer;
		int charRead;

		sBuffer = new StringBuffer(256);

		try {
			//System.out.println("Getting response...\n");
			while (true) {
				charRead = serialIS.read();
				if (charRead == -1) {
					//	sBuffer.delete(0, sBuffer.length());
					break;
				}
				sBuffer.append((char) charRead);

				if (sBuffer.toString().indexOf("OK\r") > -1
					&& sBuffer.toString().indexOf("\r") > -1) {
					break;
				}
				if (sBuffer.toString().indexOf("ERROR\r") > -1
					&& sBuffer.toString().indexOf("\r") > -1) {
					break;
				}
			}
		} catch (IOException e) {
			throw new LemonSMSException(this.getClass().getName() + " : getResponseString() " + e.getCause());
		}

		return sBuffer.toString();
	}

	/**
	 * Returns the cMD_AT.
	 * @return String
	 */
	public final String getCMD_AT() {
		return CMD_AT;
	}

	/**
	 * Returns the lIST_MESSAGES_RECREAD.
	 * @return String
	 */
	public final String getLIST_MESSAGES_RECREAD() {
		return LIST_MESSAGES_RECREAD;
	}

	/**
	 * Returns the sEND_SMS.
	 * @return String
	 */
	public final String getSEND_SMS() {
		return SEND_SMS;
	}

	/**
	 * Returns the sET_SMSMODE_TO_TEXT.
	 * @return String
	 */
	public final String getSET_SMSMODE_TO_TEXT() {
		return SET_SMSMODE_TO_TEXT;
	}

	/**
	 * Returns the cMD_AT.
	 * @return byte[]
	 */
	public final byte[] getbyteCMD_AT() {
		return getCommand(CMD_AT);
	}

	/**
	 * Returns the lIST_MESSAGES_RECREAD.
	 * @return byte[]
	 */
	public final byte[] getbyteLIST_MESSAGES_RECREAD() {
		return getCommand(LIST_MESSAGES_RECREAD);
	}

	/**
	 * Returns the sEND_SMS.
	 * @return byte[]
	 */
	public final byte[] getbyteSEND_SMS() {
		return getCommand(SEND_SMS);
	}

	/**
	 * Returns the sET_SMSMODE_TO_TEXT.
	 * @return byte[]
	 */
	public final byte[] getbyteSET_SMSMODE_TO_TEXT() {
		return getCommand(SET_SMSMODE_TO_TEXT);
	}

	/**
	 * Returns the ctrlZ.
	 * @return char
	 */
	public final char getCtrlZ() {
		return ctrlZ;
	}

	/**
	 * Returns the enter.
	 * @return char
	 */
	public final char getEnter() {
		return enter;
	}

	/**
	 * Returns the dELETE_MESSAGE.
	 * @return String
	 */
	public final String getDELETE_MESSAGE() {
		return DELETE_MESSAGE;
	}

	/**
	 * Returns the lIST_MESSAGES_RECUNREAD.
	 * @return String
	 */
	public String getLIST_MESSAGES_RECUNREAD() {
		return LIST_MESSAGES_RECUNREAD;
	}

}