ErrorCodes.java

/*
 * #%L
 * OW2 Chameleon - Fuchsia Framework
 * %%
 * Copyright (C) 2009 - 2014 OW2 Chameleon
 * %%
 * 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.
 * #L%
 */
/*
    Calimero - A library for KNX network access
    Copyright (C) 2006-2008 B. Malinowsky

    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. 
 
    Linking this library statically or dynamically with other modules is 
    making a combined work based on this library. Thus, the terms and 
    conditions of the GNU General Public License cover the whole 
    combination. 
 
    As a special exception, the copyright holders of this library give you 
    permission to link this library with independent modules to produce an 
    executable, regardless of the license terms of these independent 
    modules, and to copy and distribute the resulting executable under terms 
    of your choice, provided that you also meet, for each linked independent 
    module, the terms and conditions of the license of that module. An 
    independent module is a module which is not derived from or based on 
    this library. If you modify this library, you may extend this exception 
    to your version of the library, but you are not obligated to do so. If 
    you do not wish to do so, delete this exception statement from your 
    version. 
*/

package tuwien.auto.calimero.knxnetip.servicetype;

/**
 * Contains KNXnet/IP error codes for all supported service types.
 * <p>
 * 
 * @author B. Malinowsky
 */
public final class ErrorCodes
{
	// common error codes

	/**
	 * Error code: Operation successful.
	 * <p>
	 */
	public static final short NO_ERROR = 0x00;

	/**
	 * Error code: The requested type of host protocol is not supported by the device.
	 * <p>
	 */
	public static final short HOST_PROTOCOL_TYPE = 0x01;

	/**
	 * Error code: The requested protocol version is not supported by the device.
	 * <p>
	 */
	public static final short VERSION_NOT_SUPPORTED = 0x02;

	/**
	 * Error code: The received sequence number is out of order.
	 * <p>
	 */
	public static final short SEQUENCE_NUMBER = 0x04;

	// connect response error codes

	/**
	 * Error code: The server does not support the requested connection type.
	 * <p>
	 */
	public static final short CONNECTION_TYPE = 0x22;

	/**
	 * Error code: The server does not support the requested connection options.
	 * <p>
	 */
	public static final short CONNECTION_OPTION = 0x23;

	/**
	 * Error code: The server could not accept a new connection, maximum reached.
	 * <p>
	 */
	public static final short NO_MORE_CONNECTIONS = 0x24;

	/**
	 * Error code: The requested tunneling layer is not supported by the server.
	 * <p>
	 */
	public static final short TUNNELING_LAYER = 0x29;

	// connection state response error codes

	/**
	 * Error code: The server device could not find an active data connection with the
	 * specified ID.
	 * <p>
	 */
	public static final short CONNECTION_ID = 0x21;

	/**
	 * Error code: The server detected an error concerning the data connection with the
	 * specified ID.
	 * <p>
	 */
	public static final short DATA_CONNECTION = 0x26;

	/**
	 * Error code: The server detected an error concerning the KNX subsystem connection
	 * with the specified ID.
	 * <p>
	 */
	public static final short KNX_CONNECTION = 0x27;

	private ErrorCodes()
	{}

	/**
	 * Returns a brief description message for an error code.
	 * <p>
	 * For now, only common error codes are translated.<br>
	 * On unknown error code, the string "unknown error code" is returned.
	 * 
	 * @param code error code to lookup the description
	 * @return string representation of error code
	 */
	public static String getErrorMessage(int code)
	{
		switch (code) {
		case NO_ERROR:
			return "success";
		case HOST_PROTOCOL_TYPE:
			return "host protocol type not supported";
		case VERSION_NOT_SUPPORTED:
			return "protocol version not supported";
		case SEQUENCE_NUMBER:
			return "sequence number out of order";
		default:
			return "unknown error code";
		}
	}
}