Package edu.vt.middleware.ldap.bean

Interface LdapAttributes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addAttribute​(LdapAttribute a)
      This adds a new attribute to this LdapAttributes.
      void addAttribute​(java.lang.String name, java.lang.Object value)
      This adds a new attribute to this LdapAttributes with the supplied name and value.
      void addAttribute​(java.lang.String name, java.util.List<?> values)
      This adds a new attribute to this LdapAttributes with the supplied name and values.
      void addAttributes​(java.util.Collection<LdapAttribute> c)
      This adds a Collection of attributes to this LdapAttributes.
      void addAttributes​(javax.naming.directory.Attributes a)
      This adds the attributes in the supplied Attributes to this LdapAttributes.
      void clear()
      This removes all attributes from this LdapAttributes.
      LdapAttribute getAttribute​(java.lang.String name)
      This returns the LdapAttribute for this LdapAttributes with the supplied name.
      java.lang.String[] getAttributeNames()
      This returns an array of all the attribute names for this LdapAttributes.
      java.util.Collection<LdapAttribute> getAttributes()
      This returns a Collection of LdapAttribute for this LdapAttributes.
      void removeAttribute​(LdapAttribute a)
      This removes an attribute from this LdapAttributes.
      void removeAttribute​(java.lang.String name)
      This removes the attribute with the supplied name.
      void removeAttributes​(java.util.Collection<LdapAttribute> c)
      This removes a Collection of attributes from this LdapAttributes.
      void removeAttributes​(javax.naming.directory.Attributes a)
      This removes the attributes in the supplied Attributes from this LdapAttributes.
      int size()
      This returns the number of attributes in this attributes.
      javax.naming.directory.Attributes toAttributes()
      This returns an Attributes that represents this entry.

    • Method Detail

      • getAttributes

        java.util.Collection<LdapAttribute> getAttributes()
        This returns a Collection of LdapAttribute for this LdapAttributes.
        Returns:
        List

      • getAttribute

        LdapAttribute getAttribute​(java.lang.String name)
        This returns the LdapAttribute for this LdapAttributes with the supplied name.
        Parameters:
        name - String
        Returns:
        LdapAttribute

      • getAttributeNames

        java.lang.String[] getAttributeNames()
        This returns an array of all the attribute names for this LdapAttributes.
        Returns:
        String[]

      • addAttribute

        void addAttribute​(LdapAttribute a)
        This adds a new attribute to this LdapAttributes.
        Parameters:
        a - LdapAttribute

      • addAttribute

        void addAttribute​(java.lang.String name,
                  java.lang.Object value)
        This adds a new attribute to this LdapAttributes with the supplied name and value.
        Parameters:
        name - String
        value - Object

      • addAttribute

        void addAttribute​(java.lang.String name,
                  java.util.List<?> values)
        This adds a new attribute to this LdapAttributes with the supplied name and values.
        Parameters:
        name - String
        values - List

      • addAttributes

        void addAttributes​(java.util.Collection<LdapAttribute> c)
        This adds a Collection of attributes to this LdapAttributes. The collection should contain LdapAttribute objects.
        Parameters:
        c - Collection

      • addAttributes

        void addAttributes​(javax.naming.directory.Attributes a)
            throws javax.naming.NamingException
        This adds the attributes in the supplied Attributes to this LdapAttributes.
        Parameters:
        a - Attributes
        Throws:
        javax.naming.NamingException - if the attributes cannot be read

      • removeAttribute

        void removeAttribute​(LdapAttribute a)
        This removes an attribute from this LdapAttributes.
        Parameters:
        a - LdapAttribute

      • removeAttribute

        void removeAttribute​(java.lang.String name)
        This removes the attribute with the supplied name.
        Parameters:
        name - String

      • removeAttributes

        void removeAttributes​(java.util.Collection<LdapAttribute> c)
        This removes a Collection of attributes from this LdapAttributes. The collection should contain LdapAttribute objects.
        Parameters:
        c - Collection

      • removeAttributes

        void removeAttributes​(javax.naming.directory.Attributes a)
               throws javax.naming.NamingException
        This removes the attributes in the supplied Attributes from this LdapAttributes.
        Parameters:
        a - Attributes
        Throws:
        javax.naming.NamingException - if the attributes cannot be read

      • size

        int size()
        This returns the number of attributes in this attributes.
        Returns:
        int

      • clear

        void clear()
        This removes all attributes from this LdapAttributes.

      • toAttributes

        javax.naming.directory.Attributes toAttributes()
        This returns an Attributes that represents this entry.
        Returns:
        Attributes