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
|
/******************************************************************************
* The MIT License
* Copyright (c) 2003 Novell Inc. www.novell.com
*
* 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.
*******************************************************************************/
//
// Novell.Directory.Ldap.Controls.LdapEntryChangeControl.cs
//
// Author:
// Sunil Kumar (Sunilk@novell.com)
//
// (C) 2003 Novell, Inc (http://www.novell.com)
//
using System;
using Novell.Directory.Ldap;
using Novell.Directory.Ldap.Asn1;
namespace Novell.Directory.Ldap.Controls
{
/// <summary> LdapEntryChangeControl is a Server Control returned at the request
/// of the client in response to a persistent search request. It
/// contains additional information about a change such as what type of
/// change occurred.
/// </summary>
public class LdapEntryChangeControl:LdapControl
{
/// <summary> returns the record number of the change in the servers change log.
///
/// </summary>
/// <returns> the record number of the change in the server's change log.
/// The server may not return a change number. In this case the return
/// value is -1
/// </returns>
virtual public bool HasChangeNumber
{
get
{
return m_hasChangeNumber;
}
}
/// <summary> returns the record number of the change in the servers change log.
///
/// </summary>
/// <returns> the record number of the change in the server's change log.
/// The server may not return a change number. In this case the return
/// value is -1
/// </returns>
virtual public int ChangeNumber
{
get
{
return m_changeNumber;
}
}
/// <summary> Returns the type of change that occured
///
/// </summary>
/// <returns> returns one of the following values indicating the type of
/// change that occurred:
/// LdapPersistSearchControl.ADD
/// LdapPersistSearchControl.DELETE
/// LdapPersistSearchControl.MODIFY
/// LdapPersistSearchControl.MODDN.
/// </returns>
virtual public int ChangeType
{
get
{
return m_changeType;
}
}
/// <summary> Returns the previous DN of the entry, if it was renamed.
///
/// </summary>
/// <returns> the previous DN of the entry if the entry was renamed (ie. if the
/// change type is LdapersistSearchControl.MODDN.
/// </returns>
virtual public System.String PreviousDN
{
get
{
return m_previousDN;
}
}
private int m_changeType;
private System.String m_previousDN;
private bool m_hasChangeNumber;
private int m_changeNumber;
/// <summary> This constructor is called by the SDK to create an
/// LdapEntryChangeControl. This constructor should NOT be called by
/// application developers. It must be public since it resides in a
/// different package than the classes that call it.
/// The Entry Change Control is defined as follows:
/// EntryChangeNotification ::= SEQUENCE {
/// changeType ENUMERATED {
/// add (1),
/// delete (2),
/// modify (4),
/// modDN (8)
/// },
/// previousDN LdapDN OPTIONAL, -- modifyDN ops. only
/// changeNumber INTEGER OPTIONAL -- if supported
/// }
///
/// </summary>
/// <param name="oid"> The OID of the control, as a dotted string.
///
/// </param>
/// <param name="critical"> True if the Ldap operation should be discarded if
/// the control is not supported. False if
/// the operation can be processed without the control.
///
/// </param>
/// <param name="value"> The control-specific data.
/// </param>
[CLSCompliantAttribute(false)]
public LdapEntryChangeControl(System.String oid, bool critical, sbyte[] value_Renamed):base(oid, critical, value_Renamed)
{
// Create a decoder objet
LBERDecoder decoder = new LBERDecoder();
if (decoder == null)
throw new System.IO.IOException("Decoding error.");
// We should get a sequence initially
Asn1Object asnObj = decoder.decode(value_Renamed);
if ((asnObj == null) || (!(asnObj is Asn1Sequence)))
throw new System.IO.IOException("Decoding error.");
Asn1Sequence sequence = (Asn1Sequence) asnObj;
// The first element in the sequence should be an enumerated type
Asn1Object asn1Obj = sequence.get_Renamed(0);
if ((asn1Obj == null) || (!(asn1Obj is Asn1Enumerated)))
throw new System.IO.IOException("Decoding error.");
m_changeType = ((Asn1Enumerated) asn1Obj).intValue();
//check for optional elements
if ((sequence.size() > 1) && (m_changeType == 8))
//8 means modifyDN
{
// get the previous DN - it is encoded as an octet string
asn1Obj = sequence.get_Renamed(1);
if ((asn1Obj == null) || (!(asn1Obj is Asn1OctetString)))
throw new System.IO.IOException("Decoding error get previous DN");
m_previousDN = ((Asn1OctetString) asn1Obj).stringValue();
}
else
{
m_previousDN = "";
}
//check for change number
if (sequence.size() == 3)
{
asn1Obj = sequence.get_Renamed(2);
if ((asn1Obj == null) || (!(asn1Obj is Asn1Integer)))
throw new System.IO.IOException("Decoding error getting change number");
m_changeNumber = ((Asn1Integer) asn1Obj).intValue();
m_hasChangeNumber = true;
}
else
m_hasChangeNumber = false;
return ;
}
/// <summary> Returns a string representation of the control for debugging.</summary>
public override System.String ToString()
{
return base.ToString();
}
} //end class LdapEntryChangeControl
}
|