PacketHandler.java

/*
 * Copyright (C) 2006-2008 Alfresco Software Limited.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */

package org.alfresco.jlan.smb.server;

import java.io.IOException;
import java.net.InetAddress;

/**
 * Protocol Packet Handler Class
 * 
 * @author gkspencer
 */
public abstract class PacketHandler {

	// Protocol type and name

	private int m_protoType;
	private String m_protoName;
	private String m_shortName;

	// Client caller name and remote address

	private String m_clientName;
	private InetAddress m_remoteAddr;

	// Packet pool for allocating packet to incoming requests

	private CIFSPacketPool m_packetPool;

	// Debug output enable
	
	private boolean m_debug;
	
	/**
	 * Class constructor
	 * 
	 * @param typ int
	 * @param name String
	 * @param shortName String
	 * @param packetPool CIFSPacketPool
	 * @exception IOException If a network error occurs
	 */
	public PacketHandler(int typ, String name, String shortName, CIFSPacketPool packetPool) throws IOException {

		m_protoType = typ;
		m_protoName = name;
		m_shortName = shortName;

		m_packetPool = packetPool;
	}

	/**
	 * Class constructor
	 * 
	 * @param typ int
	 * @param name String
	 * @param shortName String
	 */
	public PacketHandler(int typ, String name, String shortName, String clientName, CIFSPacketPool packetPool) {
		m_protoType = typ;
		m_protoName = name;
		m_shortName = shortName;

		m_clientName = clientName;

		m_packetPool = packetPool;
	}

	/**
	 * Return the protocol type
	 * 
	 * @return int
	 */
	public final int isProtocol() {
		return m_protoType;
	}

	/**
	 * Return the protocol name
	 * 
	 * @return String
	 */
	public final String isProtocolName() {
		return m_protoName;
	}

	/**
	 * Return the short protocol name
	 * 
	 * @return String
	 */
	public final String getShortName() {
		return m_shortName;
	}

	/**
	 * Check if there is a remote address available
	 * 
	 * @return boolean
	 */
	public final boolean hasRemoteAddress() {
		return m_remoteAddr != null ? true : false;
	}

	/**
	 * Return the remote address for the connection
	 * 
	 * @return InetAddress
	 */
	public final InetAddress getRemoteAddress() {
		return m_remoteAddr;
	}

	/**
	 * Determine if the client name is available
	 * 
	 * @return boolean
	 */
	public final boolean hasClientName() {
		return m_clientName != null ? true : false;
	}

	/**
	 * Return the client name
	 * 
	 * @return String
	 */
	public final String getClientName() {
		return m_clientName;
	}

	/**
	 * Return the packet pool
	 * 
	 * @return CIFSPacketPool
	 */
	public final CIFSPacketPool getPacketPool() {
		return m_packetPool;
	}

	/**
	 * Check if debug output is enabled
	 * 
	 * @return boolean
	 */
	public final boolean hasDebug() {
		return m_debug;
	}
	
	/**
	 * Set/clear the debug enable flag
	 * 
	 * @param ena boolean
	 */
	public final void setDebug( boolean ena) {
		m_debug = ena;
	}
	
	/**
	 * Return the count of available bytes in the receive input stream
	 * 
	 * @return int
	 * @exception IOException If a network error occurs.
	 */
	public abstract int availableBytes()
		throws IOException;

	/**
	 * Read a packet
	 * 
	 * @return SMBSrvPacket
	 * @exception IOException If a network error occurs.
	 */
	public abstract SMBSrvPacket readPacket()
		throws IOException;

	/**
	 * Send an SMB response packet
	 * 
	 * @param pkt SMBSrvPacket
	 * @param len int
	 * @param writeRaw boolean
	 * @exception IOException If a network error occurs.
	 */
	public abstract void writePacket(SMBSrvPacket pkt, int len, boolean writeRaw)
		throws IOException;

	/**
	 * Send an SMB response packet
	 * 
	 * @param pkt SMBSrvPacket
	 * @exception IOException If a network error occurs.
	 */
	public final void writePacket(SMBSrvPacket pkt, int len)
		throws IOException {
		writePacket(pkt, len, false);
	}

	/**
	 * Send an SMB response packet
	 * 
	 * @param pkt SMBSrvPacket
	 * @exception IOException If a network error occurs.
	 */
	public final void writePacket(SMBSrvPacket pkt)
		throws IOException {
		writePacket(pkt, pkt.getLength());
	}

	/**
	 * Flush the output socket
	 * 
	 * @exception IOException If a network error occurs
	 */
	public abstract void flushPacket()
		throws IOException;

	/**
	 * Close the protocol handler
	 */
	public void closeHandler() {
	}

	/**
	 * Set the client name
	 * 
	 * @param name String
	 */
	protected final void setClientName(String name) {
		m_clientName = name;
	}

	/**
	 * Set the remote address
	 * 
	 * @param addr InetAddress
	 */
	protected final void setRemoteAddress(InetAddress addr) {
		m_remoteAddr = addr;
	}
}