net.sf.microlog.midp.appender.SerialAppender Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microlog-logger-midp
The Microlog MIDP module contains the MIDP specific classes
The newest version!
/*
 * Copyright 2008 The Microlog project @sourceforge.net
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.sf.microlog.midp.appender;

import java.io.DataOutputStream;
import java.io.IOException;

import javax.microedition.io.CommConnection;
import javax.microedition.io.Connector;

import net.sf.microlog.core.Appender;
import net.sf.microlog.core.IOUtil;
import net.sf.microlog.core.Level;
import net.sf.microlog.core.appender.AbstractAppender;

/**
 * The SerialAppender uses a serial port (
 * CommConnection) to do the logging. The serial port could be
 * opened via Bluetooth, IR or USB, depending on the target platform. If you
 * have access to JSR-82 it is recommended that the
 * BluetoothSerialAppender is used.
 * 
 * This requires MIDP 2.0.
 * 
 * @author Johan Karlsson ([email protected])
 * @since 0.9
 */
public class SerialAppender extends AbstractAppender {

	public static final String COM_PORT_PROPERTY = "comPort";

	public final static String DEFAULT_COM_PORT = "AT1";

	public static final String[] PROPERTY_NAMES = { SerialAppender.COM_PORT_PROPERTY };

	private final static String COMM_SCHEME = "comm:";

	private String comPort;
	private CommConnection connection;
	private DataOutputStream dataOutputStream;

	public SerialAppender() {
	}

	/**
	 * @param comPort
	 *            the comPort to set
	 * @throws IllegalArgumentException
	 *             if the comPort is null.
	 */
	public void setComPort(String comPort) throws IllegalArgumentException {
		if (comPort == null) {
			throw new IllegalArgumentException("The comPort must not be null.");
		}

		this.comPort = comPort;
	}

	/**
	 * Open the log, i.e. it opens the CommConnection.
	 * 
	 * @see net.sf.microlog.core.appender.AbstractAppender#open()
	 */
	public void open() throws IOException {

		// If no serial port is defined, use the first available port
		if (comPort == null) {
			String ports = System.getProperty("microedition.commports");

			int comma = ports.indexOf(',');
			if (comma > 0) {
				// Parse the first port from the available ports list.
				comPort = ports.substring(0, comma);
			} else {
				// Only one serial port available.
				comPort = ports;
			}
		}

		String connectionString = SerialAppender.COMM_SCHEME + comPort;
		connection = (CommConnection) Connector.open(connectionString);
		dataOutputStream = connection.openDataOutputStream();
		logOpen = true;
	}

	/**
	 * Clear the log. In this case we do nothing.
	 * 
	 * @see net.sf.microlog.core.appender.AbstractAppender#clear()
	 */
	public void clear() {
		// Do nothing
	}

	/**
	 * 
	 * @see net.sf.microlog.core.appender.AbstractAppender#close()
	 */
	public void close() throws IOException {
		IOUtil.closeSilent(dataOutputStream);
		IOUtil.closeSilent(connection);
		logOpen = false;
	}

	/**
	 * Get the log size which is always Appender.SIZE_UNDEFINED.
	 * 
	 * @see net.sf.microlog.core.Appender#getLogSize()
	 */
	public long getLogSize() {
		return Appender.SIZE_UNDEFINED;
	}

	/**
	 * (non-Javadoc)
	 * 
	 * @see net.sf.microlog.core.appender.AbstractAppender#doLog(String, String,
	 *      long, net.sf.microlog.core.Level, java.lang.Object,
	 *      java.lang.Throwable)
	 */
	public void doLog(String clientID, String name, long time, Level level,
			Object message, Throwable t) {
		if (logOpen && formatter != null) {
			try {
				dataOutputStream.writeUTF(formatter.format(clientID, name,
						time, level, message, t));
				dataOutputStream.flush();
			} catch (IOException e) {
				System.err.println("Failed to write log data. " + e);
			}
		}
	}
	
	/**
	 * @see Appender#getPropertyNames()
	 */
	public String[] getPropertyNames() {
		return PROPERTY_NAMES;
	}
	
	/**
	 * @see Appender#setProperty(String, String)
	 */
	public void setProperty(String name, String value)
			throws IllegalArgumentException {
		
		if(name.equals(COM_PORT_PROPERTY)){
			setComPort(value);
		}
		
	}
}