// SNMP context class.// Copyright (C) 2009-2010 Lex Li// // 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.using System;using System.Collections.Generic;using System.Net;using GSF.Net.Snmp.Messaging;using GSF.Net.Snmp.Security;namespace GSF.Net.Snmp.Pipeline{ /// <summary> /// SNMP context. /// </summary> internal abstract class SnmpContextBase : ISnmpContext { /// <summary> /// Initializes a new instance of the <see cref="SnmpContextBase"/> class. /// </summary> /// <param name="request">The request.</param> /// <param name="sender">The sender.</param> /// <param name="users">The users.</param> /// <param name="group">The engine core group.</param> /// <param name="binding">The binding.</param> protected SnmpContextBase(ISnmpMessage request, IPEndPoint sender, UserRegistry users, EngineGroup group, IListenerBinding binding) { Request = request; Binding = binding; Users = users; Sender = sender; CreatedTime = DateTime.Now; Group = group; } /// <summary> /// Gets or sets the binding. /// </summary> /// <value>The binding.</value> public IListenerBinding Binding { get; private set; } /// <summary> /// Gets the created time. /// </summary> /// <value>The created time.</value> public DateTime CreatedTime { get; private set; } /// <summary> /// Gets the request. /// </summary> /// <value>The request.</value> public ISnmpMessage Request { get; private set; } /// <summary> /// Gets the users. /// </summary> /// <value>The users.</value> protected UserRegistry Users { get; private set; } /// <summary> /// Gets the response. /// </summary> /// <value>The response.</value> public ISnmpMessage Response { get; protected set; } /// <summary> /// Gets the sender. /// </summary> /// <value>The sender.</value> public IPEndPoint Sender { get; private set; } /// <summary> /// Gets or sets the objects. /// </summary> /// <value>The objects.</value> protected EngineGroup Group { get; private set; } /// <summary> /// Gets a value indicating whether [too big]. /// </summary> /// <value><c>true</c> if the response is too big; otherwise, <c>false</c>.</value> public bool TooBig { get { int length = Response.ToBytes().Length; return length > Request.Header.MaxSize || length > Messenger.MaxMessageSize; } } /// <summary> /// Sends out response message. /// </summary> public void SendResponse() { if (Response == null) { return; } Binding.SendResponse(Response, Sender); } /// <summary> /// Generates the response. /// </summary> /// <param name="variables">The variables.</param> public abstract void GenerateResponse(IList<Variable> variables); /// <summary> /// Copies the request variable bindings to response. /// </summary> /// <param name="status">The status.</param> /// <param name="index">The index.</param> public abstract void CopyRequest(ErrorCode status, int index); /// <summary> /// Handles the membership authentication. /// </summary> /// <returns></returns> public abstract bool HandleMembership(); /// <summary> /// Generates too big message. /// </summary> public abstract void GenerateTooBig(); }}
// SNMP context class.
// Copyright (C) 2009-2010 Lex Li
//
// 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.
using System;
using System.Collections.Generic;
using System.Net;
using GSF.Net.Snmp.Messaging;
using GSF.Net.Snmp.Security;
namespace GSF.Net.Snmp.Pipeline
{
/// <summary>
/// SNMP context.
/// </summary>
internal abstract class SnmpContextBase : ISnmpContext
{
/// <summary>
/// Initializes a new instance of the <see cref="SnmpContextBase"/> class.
/// </summary>
/// <param name="request">The request.</param>
/// <param name="sender">The sender.</param>
/// <param name="users">The users.</param>
/// <param name="group">The engine core group.</param>
/// <param name="binding">The binding.</param>
protected SnmpContextBase(ISnmpMessage request, IPEndPoint sender, UserRegistry users, EngineGroup group, IListenerBinding binding)
{
Request = request;
Binding = binding;
Users = users;
Sender = sender;
CreatedTime = DateTime.Now;
Group = group;
}
/// <summary>
/// Gets or sets the binding.
/// </summary>
/// <value>The binding.</value>
public IListenerBinding Binding { get; private set; }
/// <summary>
/// Gets the created time.
/// </summary>
/// <value>The created time.</value>
public DateTime CreatedTime { get; private set; }
/// <summary>
/// Gets the request.
/// </summary>
/// <value>The request.</value>
public ISnmpMessage Request { get; private set; }
/// <summary>
/// Gets the users.
/// </summary>
/// <value>The users.</value>
protected UserRegistry Users { get; private set; }
/// <summary>
/// Gets the response.
/// </summary>
/// <value>The response.</value>
public ISnmpMessage Response { get; protected set; }
/// <summary>
/// Gets the sender.
/// </summary>
/// <value>The sender.</value>
public IPEndPoint Sender { get; private set; }
/// <summary>
/// Gets or sets the objects.
/// </summary>
/// <value>The objects.</value>
protected EngineGroup Group { get; private set; }
/// <summary>
/// Gets a value indicating whether [too big].
/// </summary>
/// <value><c>true</c> if the response is too big; otherwise, <c>false</c>.</value>
public bool TooBig
{
get
{
int length = Response.ToBytes().Length;
return length > Request.Header.MaxSize || length > Messenger.MaxMessageSize;
}
}
/// <summary>
/// Sends out response message.
/// </summary>
public void SendResponse()
{
if (Response == null)
{
return;
}
Binding.SendResponse(Response, Sender);
}
/// <summary>
/// Generates the response.
/// </summary>
/// <param name="variables">The variables.</param>
public abstract void GenerateResponse(IList<Variable> variables);
/// <summary>
/// Copies the request variable bindings to response.
/// </summary>
/// <param name="status">The status.</param>
/// <param name="index">The index.</param>
public abstract void CopyRequest(ErrorCode status, int index);
/// <summary>
/// Handles the membership authentication.
/// </summary>
/// <returns></returns>
public abstract bool HandleMembership();
/// <summary>
/// Generates too big message.
/// </summary>
public abstract void GenerateTooBig();
}
}