File size: 11,598 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#region Using directives
using System;
using System.Globalization;
using System.Management.Automation;
using System.Threading;
#endregion
namespace Microsoft.Management.Infrastructure.CimCmdlets
{
/// <summary>
/// <para>
/// Subscription result event args
/// </para>
/// </summary>
internal abstract class CimSubscriptionEventArgs : EventArgs
{
/// <summary>
/// <para>
/// Returns an Object value for an operation context
/// </para>
/// </summary>
public object Context
{
get
{
return context;
}
}
protected object context;
}
/// <summary>
/// <para>
/// Subscription result event args
/// </para>
/// </summary>
internal class CimSubscriptionResultEventArgs : CimSubscriptionEventArgs
{
/// <summary>
/// <para>
/// subscription result
/// </para>
/// </summary>
public CimSubscriptionResult Result { get; }
/// <summary>
/// Initializes a new instance of the <see cref="CimSubscriptionResultEventArgs"/> class.
/// </summary>
/// <param name="theResult"></param>
public CimSubscriptionResultEventArgs(
CimSubscriptionResult theResult)
{
this.context = null;
this.Result = theResult;
}
}
/// <summary>
/// <para>
/// Subscription result event args
/// </para>
/// </summary>
internal class CimSubscriptionExceptionEventArgs : CimSubscriptionEventArgs
{
/// <summary>
/// <para>
/// subscription result
/// </para>
/// </summary>
public Exception Exception { get; }
/// <summary>
/// Initializes a new instance of the <see cref="CimSubscriptionExceptionEventArgs"/> class.
/// </summary>
/// <param name="theResult"></param>
public CimSubscriptionExceptionEventArgs(
Exception theException)
{
this.context = null;
this.Exception = theException;
}
}
/// <summary>
/// <para>
/// Implements operations of register-cimindication cmdlet.
/// </para>
/// </summary>
internal sealed class CimRegisterCimIndication : CimAsyncOperation
{
/// <summary>
/// <para>
/// New subscription result event
/// </para>
/// </summary>
public event EventHandler<CimSubscriptionEventArgs> OnNewSubscriptionResult;
/// <summary>
/// Initializes a new instance of the <see cref="CimRegisterCimIndication"/> class.
/// </summary>
public CimRegisterCimIndication()
: base()
{
this.ackedEvent = new ManualResetEventSlim(false);
}
/// <summary>
/// Start an indication subscription target to the given computer.
/// </summary>
/// <param name="computerName">Null stands for localhost.</param>
/// <param name="nameSpace"></param>
/// <param name="queryDialect"></param>
/// <param name="queryExpression"></param>
/// <param name="operationTimeout"></param>
public void RegisterCimIndication(
string computerName,
string nameSpace,
string queryDialect,
string queryExpression,
uint operationTimeout)
{
DebugHelper.WriteLogEx("queryDialect = '{0}'; queryExpression = '{1}'", 0, queryDialect, queryExpression);
this.TargetComputerName = computerName;
CimSessionProxy proxy = CreateSessionProxy(computerName, operationTimeout);
proxy.SubscribeAsync(nameSpace, queryDialect, queryExpression);
WaitForAckMessage();
}
/// <summary>
/// Start an indication subscription through a given <see cref="CimSession"/>.
/// </summary>
/// <param name="cimSession">Cannot be null.</param>
/// <param name="nameSpace"></param>
/// <param name="queryDialect"></param>
/// <param name="queryExpression"></param>
/// <param name="operationTimeout"></param>
/// <exception cref="ArgumentNullException">Throw if cimSession is null.</exception>
public void RegisterCimIndication(
CimSession cimSession,
string nameSpace,
string queryDialect,
string queryExpression,
uint operationTimeout)
{
DebugHelper.WriteLogEx("queryDialect = '{0}'; queryExpression = '{1}'", 0, queryDialect, queryExpression);
ArgumentNullException.ThrowIfNull(cimSession, string.Format(CultureInfo.CurrentUICulture, CimCmdletStrings.NullArgument, nameof(cimSession)));
this.TargetComputerName = cimSession.ComputerName;
CimSessionProxy proxy = CreateSessionProxy(cimSession, operationTimeout);
proxy.SubscribeAsync(nameSpace, queryDialect, queryExpression);
WaitForAckMessage();
}
#region override methods
/// <summary>
/// <para>
/// Subscribe to the events issued by <see cref="CimSessionProxy"/>.
/// </para>
/// </summary>
/// <param name="proxy"></param>
protected override void SubscribeToCimSessionProxyEvent(CimSessionProxy proxy)
{
DebugHelper.WriteLog("SubscribeToCimSessionProxyEvent", 4);
// Raise event instead of write object to ps
proxy.OnNewCmdletAction += this.CimIndicationHandler;
proxy.OnOperationCreated += this.OperationCreatedHandler;
proxy.OnOperationDeleted += this.OperationDeletedHandler;
proxy.EnableMethodResultStreaming = false;
}
/// <summary>
/// <para>
/// Handler used to handle new action event from
/// <seealso cref="CimSessionProxy"/> object.
/// </para>
/// </summary>
/// <param name="cimSession">
/// <seealso cref="CimSession"/> object raised the event
/// </param>
/// <param name="actionArgs">Event argument.</param>
private void CimIndicationHandler(object cimSession, CmdletActionEventArgs actionArgs)
{
DebugHelper.WriteLogEx("action is {0}. Disposed {1}", 0, actionArgs.Action, this.Disposed);
if (this.Disposed)
{
return;
}
// NOTES: should move after this.Disposed, but need to log the exception
if (actionArgs.Action is CimWriteError cimWriteError)
{
this.Exception = cimWriteError.Exception;
if (!this.ackedEvent.IsSet)
{
// an exception happened
DebugHelper.WriteLogEx("an exception happened", 0);
this.ackedEvent.Set();
return;
}
EventHandler<CimSubscriptionEventArgs> temp = this.OnNewSubscriptionResult;
if (temp != null)
{
DebugHelper.WriteLog("Raise an exception event", 2);
temp(this, new CimSubscriptionExceptionEventArgs(this.Exception));
}
DebugHelper.WriteLog("Got an exception: {0}", 2, Exception);
}
if (actionArgs.Action is CimWriteResultObject cimWriteResultObject)
{
if (cimWriteResultObject.Result is CimSubscriptionResult result)
{
EventHandler<CimSubscriptionEventArgs> temp = this.OnNewSubscriptionResult;
if (temp != null)
{
DebugHelper.WriteLog("Raise an result event", 2);
temp(this, new CimSubscriptionResultEventArgs(result));
}
}
else
{
if (!this.ackedEvent.IsSet)
{
// an ACK message returned
DebugHelper.WriteLogEx("an ack message happened", 0);
this.ackedEvent.Set();
return;
}
else
{
DebugHelper.WriteLogEx("an ack message should not happen here", 0);
}
}
}
}
/// <summary>
/// Block the ps thread until ACK message or Error happened.
/// </summary>
private void WaitForAckMessage()
{
DebugHelper.WriteLogEx();
this.ackedEvent.Wait();
if (this.Exception != null)
{
DebugHelper.WriteLogEx("error happened", 0);
if (this.Cmdlet != null)
{
DebugHelper.WriteLogEx("Throw Terminating error", 1);
// throw terminating error
ErrorRecord errorRecord = ErrorToErrorRecord.ErrorRecordFromAnyException(
new InvocationContext(this.TargetComputerName, null), this.Exception, null);
this.Cmdlet.ThrowTerminatingError(errorRecord);
}
else
{
DebugHelper.WriteLogEx("Throw exception", 1);
// throw exception out
throw this.Exception;
}
}
DebugHelper.WriteLogEx("ACK happened", 0);
}
#endregion
#region internal property
/// <summary>
/// The cmdlet object who issue this subscription,
/// to throw ThrowTerminatingError
/// in case there is a subscription failure.
/// </summary>
/// <param name="cmdlet"></param>
internal Cmdlet Cmdlet
{
get;
set;
}
/// <summary>
/// Target computername.
/// </summary>
internal string TargetComputerName
{
get;
set;
}
#endregion
#region private methods
/// <summary>
/// <para>
/// Create <see cref="CimSessionProxy"/> and set properties
/// </para>
/// </summary>
/// <param name="computerName"></param>
/// <param name="timeout"></param>
/// <returns></returns>
private CimSessionProxy CreateSessionProxy(
string computerName,
uint timeout)
{
CimSessionProxy proxy = CreateCimSessionProxy(computerName);
proxy.OperationTimeout = timeout;
return proxy;
}
/// <summary>
/// Create <see cref="CimSessionProxy"/> and set properties.
/// </summary>
/// <param name="session"></param>
/// <param name="timeout"></param>
/// <returns></returns>
private CimSessionProxy CreateSessionProxy(
CimSession session,
uint timeout)
{
CimSessionProxy proxy = CreateCimSessionProxy(session);
proxy.OperationTimeout = timeout;
return proxy;
}
#endregion
#region private members
/// <summary>
/// Exception occurred while start the subscription.
/// </summary>
internal Exception Exception { get; private set; }
#endregion
}
}
|