adobjectnavigator.xml

TestAD is an example for active directory

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>ADObjectNavigator</name>
    </assembly>
    <members>
        <member name="T:BVA.ActiveDirectory.Navigator.Business.AdManager">
            <summary>
            This class performs operations on Active Directory.
            </summary>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.#ctor">
            <summary>
            Private constructor, this class is not supposed to be instantiated.
            </summary>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.GetRootNode">
            <summary>
            This method gets a root node on the Active Directory using the default domain, default username 
            and default password.
            </summary>
            <returns>This method returns an Active Directory RootNode.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.GetRootNode(System.String)">
            <summary>
            This method gets a root node on the Active Directory using the default username 
            and default password, but with the parameterized domain.
            </summary>
            <param name="Domain">Domain to be used.</param>
            <returns>This method returns an Active Directory RootNode.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.GetRootNode(System.String,System.String,System.String)">
            <summary>
            This method gets a root node on the Active Directory using the parameterized username, 
            parameterized password and parameterized domain.
            </summary>
            <param name="Domain">Domain to be used.</param>
            <param name="DomainUserName">Domain username to be used.</param>
            <param name="DomainPassword">Domain user password to be used.</param>
            <returns>This method returns an Active Directory RootNode.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.GetMemberships(BVA.ActiveDirectory.Navigator.Objects.User)">
            <summary>
            This method gets all the groups the user is member of.
            </summary>
            <param name="user">Member of the groups.</param>
            <returns>Returns a collection of Groups that the user is member of.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.LoadUser(System.DirectoryServices.DirectoryEntry)">
            <summary>
            This method loads all the information for an user in the AD DirectoryEntry object.
            </summary>
            <remarks>This method should not be used by the users and is supposed 
            to be used by the Navigator architecture.</remarks>
            <param name="de">DirectoryEntry to be assigned to the user.</param>
            <returns>Returns an user object loaded with information.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.getStringProperty(System.DirectoryServices.PropertyCollection,System.String)">
            <summary>
            This method gets a property from the DirectoryEntry object.
            </summary>
            <param name="p">PropertyCollection from the DirectoryEntry object.</param>
            <param name="PropName">Property Name.</param>
            <returns>Returns a string with the Property value.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.getStringArrayProperty(System.DirectoryServices.PropertyCollection,System.String)">
            <summary>
            This method gets a property array from the DirectoryEntry object.
            </summary>
            <param name="p">PropertyCollection from the DirectoryEntry object.</param>
            <param name="PropName">Property Name.</param>
            <returns>Returns an array of strings with the Property values.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.ValidateUser(System.String,System.String)">
            <summary>
            This method validates an user in the Active Directory tree.
            </summary>
            <param name="domainUser">Domain user to be validated.</param>
            <param name="domainPassword">Domain password to be validated.</param>
            <returns>Returns true if the user is valid and false if the user is invalid.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.GetUser(System.String,System.String)">
            <summary>
            This method gets an user from AD by username and password.
            </summary>
            <param name="domainUser">User's username.</param>
            <param name="domainPassword">User's password.</param>
            <returns>Returns an user Object.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.GetUser(System.String)">
            <summary>
            This method gets an user from AD by GUID.
            </summary>
            <param name="SID">User's GUID (unique identified in AD).</param>
            <returns>Returns an user Object.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.DecryptPass(System.String)">
            <summary>
            Method to be used if your system uses encryption for the passwords.
            </summary>
            <remarks>
            Although this is not very safe, since passwords should not be decrypted, the Active Directory object
            doesn't allow for password encryption. This way we need to give the decrypted password for AD.
            </remarks>
            <param name="password">Password to be decrypted.</param>
            <returns>Returns the password string.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.GetAllUsers">
            <summary>
            This method returns all Active Directory users.
            </summary>
            <remarks>This method should be used with caution because it's really heavy.</remarks>
            <returns>Returns an User Collection.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.GetAllUsers(System.Boolean)">
            <summary>
            This method returns all Active Directory users.
            </summary>
            <param name="includeDisabledUsers">This parameter specifies if the disabled accounts should be returned.</param>
            <remarks>This method should be used with caution because it's really heavy.</remarks>
            <returns>Returns an User Collection.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.GetGroupUsers(BVA.ActiveDirectory.Navigator.Objects.Group)">
            <summary>
            This method gets all the users that belong to a group.
            </summary>
            <param name="group">Group of the users.</param>
            <returns>Returns an user collection.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.GetContainer(System.String)">
            <summary>
            Returns a container by its SID.
            </summary>
            <param name="SID">GUID of the Container.</param>
            <returns>Returns a container (if not found returns null).</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.AdManager.GetOrganizationalUnit(System.String)">
            <summary>
            Returns an organizational unit by its SID.
            </summary>
            <param name="SID">GUID of the Organizational Unit.</param>
            <returns>Returns an organizational unit(if not found returns null).</returns>
        </member>
        <member name="T:BVA.ActiveDirectory.Navigator.Business.Impersonation">
            <summary>
            This class is responsible for impersonating an user.
            </summary>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.Impersonation.#ctor">
            <summary>
            This is the default constructor for this class.
            </summary>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.Impersonation.impersonateValidUser(System.String,System.String,System.String)">
            <summary>
            This method is used for impersonating an user.
            </summary>
            <param name="domain">Domain of the user being impersonated.</param>
            <param name="userName">User being impersonated.</param>
            <param name="password">Password of the user being impersonated.</param>
            <returns>A boolean indicating if the user could sucessfully impersonate.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Business.Impersonation.undoImpersonation">
            <summary>
            This method undo the impersonation done in the ImpersonateValidUser method.
            </summary>
        </member>
        <member name="T:BVA.ActiveDirectory.Navigator.Objects.Auxiliary">
            <summary>
            This class is used for the enumerations.
            </summary>
        </member>
        <member name="T:BVA.ActiveDirectory.Navigator.Objects.Auxiliary.ObjectTypes">
            <summary>
            Object types of nodes on the AD tree.
            </summary>
        </member>
        <member name="F:BVA.ActiveDirectory.Navigator.Objects.Auxiliary.ObjectTypes.Root">
            <summary>
            Root Node of the AD tree.
            </summary>
        </member>
        <member name="F:BVA.ActiveDirectory.Navigator.Objects.Auxiliary.ObjectTypes.Container">
            <summary>
            Container Node of the AD tree.
            </summary>
        </member>
        <member name="F:BVA.ActiveDirectory.Navigator.Objects.Auxiliary.ObjectTypes.Group">
            <summary>
            Group Node of the AD tree.
            </summary>
        </member>
        <member name="F:BVA.ActiveDirectory.Navigator.Objects.Auxiliary.ObjectTypes.OrganizationalUnit">
            <summary>
            Organizational Unit of the AD tree.
            </summary>
        </member>
        <member name="F:BVA.ActiveDirectory.Navigator.Objects.Auxiliary.ObjectTypes.User">
            <summary>
            User of the AD tree.
            </summary>
        </member>
        <member name="F:BVA.ActiveDirectory.Navigator.Objects.Auxiliary.ObjectTypes.Other">
            <summary>
            Any other type not specified here.
            </summary>
        </member>
        <member name="T:BVA.ActiveDirectory.Navigator.Objects.BaseObject">
            <summary>
            Base object for the AD objects.
            </summary>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Objects.BaseObject.#ctor">
            <summary>
            This is the default constructor for this class.
            </summary>
        </member>
        <member name="P:BVA.ActiveDirectory.Navigator.Objects.BaseObject.IsLoaded">
            <summary>
            Indicates if this level of the tree is already loaded.
            </summary>
        </member>
        <member name="P:BVA.ActiveDirectory.Navigator.Objects.BaseObject.OriginalDirectoryEntry">
            <summary>
            Indicates the original Directory Entry on the AD namespace (System.DirectoryServices).
            </summary>
        </member>
        <member name="P:BVA.ActiveDirectory.Navigator.Objects.BaseObject.Parent">
            <summary>
            Indicates the parent object (node) of this node.
            </summary>
        </member>
        <member name="P:BVA.ActiveDirectory.Navigator.Objects.BaseObject.ParentType">
            <summary>
            Indicates the type of the parent object of this node.
            </summary>
        </member>
        <member name="T:BVA.ActiveDirectory.Navigator.Objects.Container">
            <summary>
            This class defines an AD container.
            </summary>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Objects.Container.#ctor">
            <summary>
            Constructor of this class.
            </summary>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Objects.Container.Load">
            <summary>
            Method used for loading this level.
            </summary>
        </member>
        <member name="P:BVA.ActiveDirectory.Navigator.Objects.Container.Id">
            <summary>
            Id of the container. This id is unique (GUID) for each object in the AD tree.
            </summary>
        </member>
        <member name="P:BVA.ActiveDirectory.Navigator.Objects.Container.Name">
            <summary>
            Name of the container.
            </summary>
        </member>
        <member name="P:BVA.ActiveDirectory.Navigator.Objects.Container.OrganizationalUnits">
            <summary>
            Organizational Units contained in this container (collection).
            </summary>
        </member>
        <member name="P:BVA.ActiveDirectory.Navigator.Objects.Container.Users">
            <summary>
            Users contained in this container (collection).
            </summary>
        </member>
        <member name="P:BVA.ActiveDirectory.Navigator.Objects.Container.Containers">
            <summary>
            Containers contained in this container (collection).
            </summary>
        </member>
        <member name="P:BVA.ActiveDirectory.Navigator.Objects.Container.Groups">
            <summary>
            Groups contained in this container (collection).
            </summary>
        </member>
        <member name="T:BVA.ActiveDirectory.Navigator.Objects.ContainerCollection">
            <summary>
            Class that defines a collection of Containers.
            </summary>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Objects.ContainerCollection.IndexOf(BVA.ActiveDirectory.Navigator.Objects.Container)">
            <summary>
            Returns the index (position) of an item in the collection.
            </summary>
            <param name="item">Item to be searched.</param>
            <returns>Returns the index(position) of the item.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Objects.ContainerCollection.Add(BVA.ActiveDirectory.Navigator.Objects.Container)">
            <summary>
            This method adds an item to the collection.
            </summary>
            <param name="item">Item to be added.</param>
            <returns>Returns an integer that tells if the item has been successfully added.</returns>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Objects.ContainerCollection.Remove(BVA.ActiveDirectory.Navigator.Objects.Container)">
            <summary>
            Removes an item from the collection.
            </summary>
            <param name="item">Item to be removed from the collection.</param>
        </member>
        <member name="M:BVA.ActiveDirectory.Navigator.Objects.ContainerCollection.CopyTo(System.Array,System.Int32)">
            <summary>
            Copies an array to another.