// TRAP message PDU (SNMP version 1 only).
// Copyright (C) 2008-2010 Malcolm Crowe, Lex Li, and other contributors.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of this
// software and associated documentation files (the "Software"), to deal in the Software
// without restriction, including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
// to whom the Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all copies or
// substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
/*
* Created by SharpDevelop.
* User: lextm
* Date: 2008/4/30
* Time: 21:22
*
* To change this template use Tools | Options | Coding | Edit Standard Headers.
*/
using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
namespace GSF.Net.Snmp
{
///
/// Trap v1 PDU.
///
/// represents the PDU of trap v1 message.
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "Pdu")]
public sealed class TrapV1Pdu : ISnmpPdu
{
private byte[] _raw;
private readonly Integer32 _generic;
private readonly Integer32 _specific;
private readonly Sequence _varbindSection;
private readonly byte[] _length;
///
/// Creates a instance with PDU elements.
///
/// Enterprise
/// Agent address
/// Generic trap type
/// Specific trap type
/// Time stamp
/// Variable binds
[CLSCompliant(false)]
public TrapV1Pdu(uint[] enterprise, IP agent, Integer32 generic, Integer32 specific, TimeTicks timestamp, IList variables)
: this(new ObjectIdentifier(enterprise), agent, generic, specific, timestamp, variables)
{
}
///
/// Creates a instance with PDU elements.
///
/// Enterprise
/// Agent address
/// Generic trap type
/// Specific trap type
/// Time stamp
/// Variable binds
public TrapV1Pdu(ObjectIdentifier enterprise, IP agent, Integer32 generic, Integer32 specific, TimeTicks timestamp, IList variables)
{
if (enterprise == null)
{
throw new ArgumentNullException(nameof(enterprise));
}
if (agent == null)
{
throw new ArgumentNullException(nameof(agent));
}
if (generic == null)
{
throw new ArgumentNullException(nameof(generic));
}
if (specific == null)
{
throw new ArgumentNullException(nameof(specific));
}
if (timestamp == null)
{
throw new ArgumentNullException(nameof(timestamp));
}
if (variables == null)
{
throw new ArgumentNullException(nameof(variables));
}
Enterprise = enterprise;
AgentAddress = agent;
_generic = generic;
_specific = specific;
TimeStamp = timestamp;
_varbindSection = Variable.Transform(variables);
Variables = variables;
}
///
/// Initializes a new instance of the class.
///
/// The length data.
/// The stream.
public TrapV1Pdu(Tuple length, Stream stream)
{
if (length == null)
{
throw new ArgumentNullException(nameof(length));
}
if (stream == null)
{
throw new ArgumentNullException(nameof(stream));
}
Enterprise = (ObjectIdentifier)DataFactory.CreateSnmpData(stream);
AgentAddress = (IP)DataFactory.CreateSnmpData(stream);
_generic = (Integer32)DataFactory.CreateSnmpData(stream);
_specific = (Integer32)DataFactory.CreateSnmpData(stream);
TimeStamp = (TimeTicks)DataFactory.CreateSnmpData(stream);
_varbindSection = (Sequence)DataFactory.CreateSnmpData(stream);
Variables = Variable.Transform(_varbindSection);
_length = length.Item2;
}
///
/// Gets the request ID.
///
/// The request ID.
public Integer32 RequestId
{
get { throw new NotSupportedException(); }
}
///
/// Gets the index of the error.
///
/// The index of the error.
public Integer32 ErrorIndex
{
get { throw new NotSupportedException(); }
}
///
/// Gets the error status.
///
/// The error status.
public Integer32 ErrorStatus
{
get { throw new NotSupportedException(); }
}
///
/// Type code.
///
public SnmpType TypeCode
{
get
{
return SnmpType.TrapV1Pdu;
}
}
///
/// Appends the bytes to .
///
/// The stream.
public void AppendBytesTo(Stream stream)
{
if (stream == null)
{
throw new ArgumentNullException(nameof(stream));
}
if (_raw == null)
{
_raw = ByteTool.ParseItems(Enterprise, AgentAddress, _generic, _specific, TimeStamp, _varbindSection);
}
stream.AppendBytes(TypeCode, _length, _raw);
}
///
/// Enterprise.
///
public ObjectIdentifier Enterprise { get; private set; }
///
/// Agent address.
///
public IP AgentAddress { get; private set; }
///
/// Generic trap type.
///
public GenericCode Generic
{
get { return (GenericCode)_generic.ToInt32(); }
}
///
/// Specific trap type.
///
public int Specific
{
get { return _specific.ToInt32(); }
}
///
/// Time stamp.
///
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1702:CompoundWordsShouldBeCasedCorrectly", MessageId = "TimeStamp")]
public TimeTicks TimeStamp { get; private set; }
///
/// Variable binds.
///
public IList Variables { get; private set; }
///
/// Returns a that represents this .
///
///
public override string ToString()
{
return string.Format(
CultureInfo.InvariantCulture,
"SNMPv1 TRAP PDU: agent address: {0}; time stamp: {1}; enterprise: {2}; generic: {3}; specific: {4}; varbind count: {5}",
AgentAddress,
TimeStamp,
Enterprise,
Generic,
Specific.ToString(CultureInfo.InvariantCulture),
Variables.Count.ToString(CultureInfo.InvariantCulture));
}
}
}