File size: 15,042 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 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Collections.ObjectModel;
using Dbg = System.Management.Automation;
namespace System.Management.Automation
{
/// <summary>
/// Exposes the Cmdlet Family Provider's drives to the Cmdlet base class. The methods of this class
/// get and set provider data in session state.
/// </summary>
public sealed class DriveManagementIntrinsics
{
#region Constructors
/// <summary>
/// Hide the default constructor since we always require an instance of SessionState.
/// </summary>
private DriveManagementIntrinsics()
{
Dbg.Diagnostics.Assert(
false,
"This constructor should never be called. Only the constructor that takes an instance of SessionState should be called.");
}
/// <summary>
/// Constructs a Drive management facade.
/// </summary>
/// <param name="sessionState">
/// The instance of session state that facade wraps.
/// </param>
/// <exception cref="ArgumentNullException">
/// If <paramref name="sessionState"/> is null.
/// </exception>
internal DriveManagementIntrinsics(SessionStateInternal sessionState)
{
if (sessionState == null)
{
throw PSTraceSource.NewArgumentNullException(nameof(sessionState));
}
_sessionState = sessionState;
}
#endregion Constructors
#region Public methods
/// <summary>
/// Gets the drive information for the current working drive.
/// </summary>
/// <remarks>
/// This property is readonly. To set the current drive use the
/// SetLocation method.
/// </remarks>
public PSDriveInfo Current
{
get
{
Dbg.Diagnostics.Assert(
_sessionState != null,
"The only constructor for this class should always set the sessionState field");
return _sessionState.CurrentDrive;
}
}
#region New
/// <summary>
/// Creates a new PSDrive in session state.
/// </summary>
/// <param name="drive">
/// The drive to be created.
/// </param>
/// <param name="scope">
/// The ID of the scope to create the drive in. This may be one of the scope
/// keywords like global or local, or it may be an numeric offset of the scope
/// generation relative to the current scope.
/// If the scopeID is null or empty the local scope is used.
/// </param>
/// <returns>
/// The drive that was created.
/// </returns>
/// <exception cref="ArgumentNullException">
/// If <paramref name="drive"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
/// If the drive already exists,
/// or
/// If <paramref name="drive"/>.Name contains one or more invalid characters; ~ / \\ . :
/// </exception>
/// <exception cref="NotSupportedException">
/// If the provider is not a DriveCmdletProvider.
/// </exception>
/// <exception cref="ProviderNotFoundException">
/// The provider for the <paramref name="drive"/> could not be found.
/// </exception>
/// <exception cref="ProviderInvocationException">
/// If the provider threw an exception or returned null.
/// </exception>
public PSDriveInfo New(PSDriveInfo drive, string scope)
{
Dbg.Diagnostics.Assert(
_sessionState != null,
"The only constructor for this class should always set the sessionState field");
// Parameter validation is done in the session state object
return _sessionState.NewDrive(drive, scope);
}
/// <summary>
/// Creates a new MSH drive in session state.
/// </summary>
/// <param name="drive">
/// The drive to be created.
/// </param>
/// <param name="scope">
/// The ID of the scope to create the drive in. This may be one of the scope
/// keywords like global or local, or it may be an numeric offset of the scope
/// generation relative to the current scope.
/// If the scopeID is null or empty the local scope is used.
/// </param>
/// <param name="context">
/// The context under which this command is running.
/// </param>
/// <returns>
/// Nothing. The drive that is created is written to the context.
/// </returns>
/// <exception cref="ArgumentNullException">
/// If <paramref name="drive"/> or <paramref name="context"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
/// If the drive already exists
/// or
/// If <paramref name="drive"/>.Name contains one or more invalid characters; ~ / \\ . :
/// </exception>
/// <exception cref="NotSupportedException">
/// If the provider is not a DriveCmdletProvider.
/// </exception>
/// <exception cref="ProviderNotFoundException">
/// The provider for the <paramref name="drive"/> could not be found.
/// </exception>
/// <exception cref="ProviderInvocationException">
/// If the provider threw an exception or returned null.
/// </exception>
internal void New(
PSDriveInfo drive,
string scope,
CmdletProviderContext context)
{
Dbg.Diagnostics.Assert(
_sessionState != null,
"The only constructor for this class should always set the sessionState field");
// Parameter validation is done in the session state object
_sessionState.NewDrive(drive, scope, context);
}
/// <summary>
/// Gets an object that defines the additional parameters for the NewDrive implementation
/// for a provider.
/// </summary>
/// <param name="providerId">
/// The provider ID for the drive that is being created.
/// </param>
/// <param name="context">
/// The context under which this method is being called.
/// </param>
/// <returns>
/// An object that has properties and fields decorated with
/// parsing attributes similar to a cmdlet class.
/// </returns>
/// <exception cref="NotSupportedException">
/// If the <paramref name="providerId"/> is not a DriveCmdletProvider.
/// </exception>
/// <exception cref="ProviderNotFoundException">
/// If <paramref name="providerId"/> does not exist.
/// </exception>
internal object NewDriveDynamicParameters(
string providerId,
CmdletProviderContext context)
{
Dbg.Diagnostics.Assert(
_sessionState != null,
"The only constructor for this class should always set the sessionState field");
// Parameter validation is done in the session state object
return _sessionState.NewDriveDynamicParameters(providerId, context);
}
#endregion New
#region Remove
/// <summary>
/// Removes the specified drive.
/// </summary>
/// <param name="driveName">
/// The name of the drive to be removed.
/// </param>
/// <param name="force">
/// Determines whether drive should be forcefully removed even if there was errors.
/// </param>
/// <param name="scope">
/// The ID of the scope to remove the drive from. This may be one of the scope
/// keywords like global or local, or it may be an numeric offset of the scope
/// generation relative to the current scope.
/// If the scopeID is null or empty the local scope is used.
/// </param>
public void Remove(string driveName, bool force, string scope)
{
Dbg.Diagnostics.Assert(
_sessionState != null,
"The only constructor for this class should always set the sessionState field");
// Parameter validation is done in the session state object
_sessionState.RemoveDrive(driveName, force, scope);
}
/// <summary>
/// Removes the specified drive.
/// </summary>
/// <param name="driveName">
/// The name of the drive to be removed.
/// </param>
/// <param name="force">
/// Determines whether drive should be forcefully removed even if there was errors.
/// </param>
/// <param name="scope">
/// The ID of the scope to remove the drive from. This may be one of the scope
/// keywords like global or local, or it may be an numeric offset of the scope
/// generation relative to the current scope.
/// If the scopeID is null or empty the local scope is used.
/// </param>
/// <param name="context">
/// The context under which this command is running.
/// </param>
internal void Remove(
string driveName,
bool force,
string scope,
CmdletProviderContext context)
{
Dbg.Diagnostics.Assert(
_sessionState != null,
"The only constructor for this class should always set the sessionState field");
// Parameter validation is done in the session state object
_sessionState.RemoveDrive(driveName, force, scope, context);
}
#endregion Remove
#region Get
/// <summary>
/// Gets the drive information for the drive specified by name.
/// </summary>
/// <param name="driveName">
/// The name of the drive to get the drive information for.
/// </param>
/// <returns>
/// The drive information that represents the drive of the specified name.
/// </returns>
/// <exception cref="ArgumentNullException">
/// If <paramref name="driveName"/> is null.
/// </exception>
/// <exception cref="DriveNotFoundException">
/// If there is no drive with <paramref name="driveName"/>.
/// </exception>
public PSDriveInfo Get(string driveName)
{
Dbg.Diagnostics.Assert(
_sessionState != null,
"The only constructor for this class should always set the sessionState field");
// Parameter validation is done in the session state object
return _sessionState.GetDrive(driveName);
}
/// <summary>
/// Gets the drive information for the drive specified by name.
/// </summary>
/// <param name="driveName">
/// The name of the drive to get the drive information for.
/// </param>
/// <param name="scope">
/// The ID of the scope to get the drive from. This may be one of the scope
/// keywords like global or local, or it may be an numeric offset of the scope
/// generation relative to the current scope.
/// If the scopeID is null or empty the local scope is used.
/// </param>
/// <returns>
/// The drive information that represents the drive of the specified name.
/// </returns>
/// <exception cref="ArgumentNullException">
/// If <paramref name="driveName"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
/// If <paramref name="scope"/> is less than zero, or not
/// a number and not "script", "global", "local", or "private"
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// If <paramref name="scopeID"/> is less than zero or greater than the number of currently
/// active scopes.
/// </exception>
public PSDriveInfo GetAtScope(string driveName, string scope)
{
Dbg.Diagnostics.Assert(
_sessionState != null,
"The only constructor for this class should always set the sessionState field");
// Parameter validation is done in the session state object
return _sessionState.GetDrive(driveName, scope);
}
/// <summary>
/// Retrieves all the drives in the specified scope.
/// </summary>
public Collection<PSDriveInfo> GetAll()
{
Dbg.Diagnostics.Assert(
_sessionState != null,
"The only constructor for this class should always set the sessionState field");
return _sessionState.Drives(null);
}
/// <summary>
/// Retrieves all the drives in the specified scope.
/// </summary>
/// <param name="scope">
/// The scope to retrieve the drives from. If null, the
/// drives in all the scopes will be returned.
/// </param>
/// <exception cref="ArgumentException">
/// If <paramref name="scope"/> is less than zero, or not
/// a number and not "script", "global", "local", or "private"
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// If <paramref name="scopeID"/> is less than zero or greater than the number of currently
/// active scopes.
/// </exception>
public Collection<PSDriveInfo> GetAllAtScope(string scope)
{
Dbg.Diagnostics.Assert(
_sessionState != null,
"The only constructor for this class should always set the sessionState field");
return _sessionState.Drives(scope);
}
/// <summary>
/// Gets all the drives for the specified provider.
/// </summary>
/// <param name="providerName">
/// The name of the provider to get the drives for.
/// </param>
/// <returns>
/// All the drives in all the scopes for the given provider.
/// </returns>
public Collection<PSDriveInfo> GetAllForProvider(string providerName)
{
Dbg.Diagnostics.Assert(
_sessionState != null,
"The only constructor for this class should always set the sessionState field");
// Parameter validation is done in the session state object
return _sessionState.GetDrivesForProvider(providerName);
}
#endregion GetDrive
#endregion Public methods
#region private data
// A private reference to the internal session state of the engine.
private readonly SessionStateInternal _sessionState;
#endregion private data
}
}
|