IPv4NetworkInterface.java

//
// This file is part of the OpenNMS(R) Application.
//
// OpenNMS(R) is Copyright (C) 2002-2003 The OpenNMS Group, Inc.  All rights reserved.
// OpenNMS(R) is a derivative work, containing both original code, included code and modified
// code that was published under the GNU General Public License. Copyrights for modified 
// and included code are below.
//
// OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
//
// Modifications:
//
// 2003 Jan 31: Cleaned up some unused imports.
//
// Original code base Copyright (C) 1999-2001 Oculan Corp.  All rights reserved.
//
// 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
//
// For more information contact:
//      OpenNMS Licensing       <license@opennms.org>
//      http://www.opennms.org/
//      http://www.opennms.com/
//

package org.infosec.ismp.model.poller;

import java.io.Serializable;
import java.net.InetAddress;
import java.util.HashMap;
import java.util.Map;

import org.infosec.ismp.util.ThreadCategory;

/**
 * <P>
 * The NetworkInterface class is designed to be a well defined front for passing
 * interfaces to a service monitor. There are many different types of network in
 * use today including IPv4, IPv6, IPX, and others. To accommodate the possible
 * differences this class provides the basic information that a monitor can use
 * to determine the type of interface and its expected address type.
 * </P>
 * 
 * <P>
 * In addition to providing typing and address information, the interface allows
 * for the monitor to associate key-value pairs with an interface. This can be
 * used to save state information between the various invocations if necessary.
 * The attributes may be shared with other monitors concurrently, so a monitor
 * must be careful to choose unique keys to prevent namespace collisions.
 * </P>
 * 
 * @author <A HREF="mailto:mike@opennms.org">Mike Davidson </A>
 * @author <A HREF="mailto:weave@oculan.com">Weave </A>
 * @author <A HREF="http://www.opennms.org/">OpenNMS </A>
 * 
 */
public class IPv4NetworkInterface implements NetworkInterface, Serializable {
	private static final long serialVersionUID = 1L;

	/**
	 * The map of attributes for this interface.
	 */
	private transient Map<String, Object> m_properties;

	/**
	 * Interface address
	 */
	protected InetAddress m_address;

	public IPv4NetworkInterface(InetAddress address) {
		m_address = address;
	}

	/**
	 * <P>
	 * Returns the interface type for the network interface.
	 * </P>
	 */
	@Override
	public int getType() {
		return TYPE_IPV4;
	}

	/**
	 * <P>
	 * Returns the address information for the interface. If the interface then
	 * this should be either an InetAddress or an object for specialized address
	 * types.
	 * </p>
	 */
	@Override
	public Object getAddress() {
		return m_address;
	}

	public InetAddress getInetAddress() {
		return m_address;
	}

	/**
	 * <P>
	 * This method is used to return the object that is associated with the
	 * property name. This is very similar to the java.util.Map get() method,
	 * but requires that the lookup be performed using a String name. The object
	 * may be of any instance that the monitor previous stored.
	 * </P>
	 * 
	 * <P>
	 * If there is no matching object for the property key, then a null pointer
	 * is returned to the application.
	 * </P>
	 * 
	 * @param property
	 *            The key for the lookup.
	 * 
	 * @return The resulting value for the key, null if no value exist.
	 * 
	 * @exception java.lang.IllegalArgumentException
	 *                Thrown if the passed key is empty or null.
	 * 
	 * @see java.util.Map#get(java.lang.Object)
	 */
	@Override
	public synchronized Object getAttribute(String property) {
		Object rc = null;
		if (m_properties != null)
			rc = m_properties.get(property);

		return rc;
	}

	/**
	 * <P>
	 * This method is used to associate an object value with a textual key. If a
	 * previous value was associated with the key then the old value is returned
	 * to the caller. This is identical to the behavior defined by the
	 * java.util.Map put() method. The only restriction is that the key must be
	 * a java string instance.
	 * </P>
	 * 
	 * @param property
	 *            The key
	 * @param value
	 *            The value to associate with the key
	 * 
	 * @return The object that was previously associated with the key. Null is
	 *         returned if there was no previous value associated.
	 * 
	 * @exception java.lang.IllegalArgumentException
	 *                Thrown if the property name is empty or null.
	 * 
	 * @see java.util.Map#put(java.lang.Object, java.lang.Object)
	 * 
	 */
	@Override
	public synchronized Object setAttribute(String property, Object value) {
		if (m_properties == null)
			m_properties = new HashMap<String, Object>();

		return m_properties.put(property, value);
	}

	public ThreadCategory log() {
		return ThreadCategory.getInstance(getClass());
	}

}