blob: b33cadc5fc7cd317f22166cb6fd29b5fda806dfe [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
using System;
namespace Apache.NMS
{
/// <summary>
/// Represents an NMS exception
/// </summary>
[Serializable]
public class NMSException : Exception
{
protected string exceptionErrorCode;
public NMSException()
: base()
{
}
public NMSException(string message)
: base(message)
{
}
public NMSException(string message, string errorCode)
: this(message)
{
exceptionErrorCode = errorCode;
}
public NMSException(string message, Exception innerException)
: base(message, innerException)
{
}
public NMSException(string message, string errorCode, Exception innerException)
: base(message, innerException)
{
exceptionErrorCode = errorCode;
}
#region ISerializable interface implementation
#if !NETCF
/// <summary>
/// Initializes a new instance of the NMSException class with serialized data.
/// Throws System.ArgumentNullException if the info parameter is null.
/// Throws System.Runtime.Serialization.SerializationException if the class name is null or System.Exception.HResult is zero (0).
/// </summary>
/// <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
protected NMSException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
: base(info, context)
{
exceptionErrorCode = info.GetString("NMSException.exceptionErrorCode");
}
/// <summary>
/// When overridden in a derived class, sets the SerializationInfo with information about the exception.
/// </summary>
/// <param name="info">The SerializationInfo that holds the serialized object data about the exception being thrown.</param>
/// <param name="context">The StreamingContext that contains contextual information about the source or destination.</param>
public override void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
{
base.GetObjectData(info, context);
info.AddValue("NMSException.exceptionErrorCode", exceptionErrorCode);
}
#endif
#endregion
/// <summary>
/// Returns the error code for the exception, if one has been provided.
/// </summary>
public string ErrorCode
{
get { return exceptionErrorCode; }
}
}
}