mcs/class/Novell.Directory.Ldap/Novell.Directory.Ldap.Extensions/TriggerBackgroundProcessRequest.cs

   1 /******************************************************************************
   2 * The MIT License
   3 * Copyright (c) 2003 Novell Inc.  www.novell.com
   4 *
   5 * Permission is hereby granted, free of charge, to any person obtaining  a copy
   6 * of this software and associated documentation files (the Software), to deal
   7 * in the Software without restriction, including  without limitation the rights
   8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 * copies of the Software, and to  permit persons to whom the Software is
  10 * furnished to do so, subject to the following conditions:
  11 *
  12 * The above copyright notice and this permission notice shall be included in
  13 * all copies or substantial portions of the Software.
  14 *
  15 * THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21 * SOFTWARE.
  22 *******************************************************************************/
  23 //
  24 // Novell.Directory.Ldap.Extensions.TriggerBackgroundProcessRequest.cs
  25 //
  26 // Author:
  27 //   Sunil Kumar (Sunilk@novell.com)
  28 //
  29 // (C) 2003 Novell, Inc (http://www.novell.com)
  30 //
  31
  32 using System;
  33 using Novell.Directory.Ldap;
  34 using Novell.Directory.Ldap.Asn1;
  35 using Novell.Directory.Ldap.Utilclass;
  36
  37 namespace Novell.Directory.Ldap.Extensions
  38 {
  39
  40         /// <summary> This API is used to trigger the specified background process on the
  41         /// Novell eDirectory server.
  42         ///
  43         /// <p>The TriggerBackgroundProcessRequest uses tone of the following OID's
  44         /// depending on the process being triggered:<br>
  45         /// &nbsp;&nbsp;&nbsp;2.16.840.1.113719.1.27.100.43</p>
  46         /// &nbsp;&nbsp;&nbsp;2.16.840.1.113719.1.27.100.47</p>
  47         /// &nbsp;&nbsp;&nbsp;2.16.840.1.113719.1.27.100.49</p>
  48         /// &nbsp;&nbsp;&nbsp;2.16.840.1.113719.1.27.100.51</p>
  49         /// &nbsp;&nbsp;&nbsp;2.16.840.1.113719.1.27.100.53</p>
  50         /// &nbsp;&nbsp;&nbsp;2.16.840.1.113719.1.27.100.55</p>
  51         ///
  52         /// <p>The requestValue has the following format:<br>
  53         ///
  54         /// requestValue ::=<br>
  55         /// &nbsp;&nbsp;&nbsp;&nbsp;   NULL
  56         /// </p>
  57         /// </summary>
  58
  59         public class TriggerBackgroundProcessRequest:LdapExtendedOperation
  60         {
  61
  62                 /// <summary> Constants used to refer to different Novell eDirectory
  63                 /// background processes
  64                 /// </summary>
  65                 public const int Ldap_BK_PROCESS_BKLINKER = 1;
  66                 public const int Ldap_BK_PROCESS_JANITOR = 2;
  67                 public const int Ldap_BK_PROCESS_LIMBER = 3;
  68                 public const int Ldap_BK_PROCESS_SKULKER = 4;
  69                 public const int Ldap_BK_PROCESS_SCHEMA_SYNC = 5;
  70                 public const int Ldap_BK_PROCESS_PART_PURGE = 6;
  71
  72                 /// <summary>
  73                 /// Based on the process ID specified this constructer cosntructs an
  74                 /// LdapExtendedOperation object with the apppropriate OID.
  75                 ///
  76                 /// </summary>
  77                 /// <param name="processID">  This id identifies the background process to be triggerd.
  78                 ///
  79                 /// </param>
  80                 /// <exception cref=""> LdapException A general exception which includes an error message
  81                 /// and an Ldap error code.
  82                 /// </exception>
  83                 public TriggerBackgroundProcessRequest(int processID):base(null, null)
  84                 {
  85
  86                         switch (processID)
  87                         {
  88
  89
  90                                 case Ldap_BK_PROCESS_BKLINKER:
  91                                         setID(ReplicationConstants.TRIGGER_BKLINKER_REQ);
  92                                         break;
  93
  94                                 case Ldap_BK_PROCESS_JANITOR:
  95                                         setID(ReplicationConstants.TRIGGER_JANITOR_REQ);
  96                                         break;
  97
  98                                 case Ldap_BK_PROCESS_LIMBER:
  99                                         setID(ReplicationConstants.TRIGGER_LIMBER_REQ);
 100                                         break;
 101
 102                                 case Ldap_BK_PROCESS_SKULKER:
 103                                         setID(ReplicationConstants.TRIGGER_SKULKER_REQ);
 104                                         break;
 105
 106                                 case Ldap_BK_PROCESS_SCHEMA_SYNC:
 107                                         setID(ReplicationConstants.TRIGGER_SCHEMA_SYNC_REQ);
 108                                         break;
 109
 110                                 case Ldap_BK_PROCESS_PART_PURGE:
 111                                         setID(ReplicationConstants.TRIGGER_PART_PURGE_REQ);
 112                                         break;
 113
 114                                 default:
 115                                         throw new System.ArgumentException(ExceptionMessages.PARAM_ERROR);
 116
 117                         }
 118                 }
 119         }
 120 }