Package edu.vt.middleware.ldap.bean
Interface LdapAttributes
-
- All Known Implementing Classes:
AbstractLdapAttributes
,OrderedLdapBeanFactory.OrderedLdapAttributes
,SortedLdapBeanFactory.SortedLdapAttributes
,UnorderedLdapBeanFactory.UnorderedLdapAttributes
public interface LdapAttributes
LdapAttributes
represents a collection of ldap attribute.- Version:
- $Revision: 1330 $ $Date: 2010-05-24 00:10:53 +0200 (Mon, 24 May 2010) $
- Author:
- Middleware Services
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addAttribute(LdapAttribute a)
This adds a new attribute to thisLdapAttributes
.void
addAttribute(java.lang.String name, java.lang.Object value)
This adds a new attribute to thisLdapAttributes
with the supplied name and value.void
addAttribute(java.lang.String name, java.util.List<?> values)
This adds a new attribute to thisLdapAttributes
with the supplied name and values.void
addAttributes(java.util.Collection<LdapAttribute> c)
This adds aCollection
of attributes to thisLdapAttributes
.void
addAttributes(javax.naming.directory.Attributes a)
This adds the attributes in the suppliedAttributes
to thisLdapAttributes
.void
clear()
This removes all attributes from thisLdapAttributes
.LdapAttribute
getAttribute(java.lang.String name)
This returns theLdapAttribute
for thisLdapAttributes
with the supplied name.java.lang.String[]
getAttributeNames()
This returns an array of all the attribute names for thisLdapAttributes
.java.util.Collection<LdapAttribute>
getAttributes()
This returns aCollection
ofLdapAttribute
for thisLdapAttributes
.void
removeAttribute(LdapAttribute a)
This removes an attribute from thisLdapAttributes
.void
removeAttribute(java.lang.String name)
This removes the attribute with the supplied name.void
removeAttributes(java.util.Collection<LdapAttribute> c)
This removes aCollection
of attributes from thisLdapAttributes
.void
removeAttributes(javax.naming.directory.Attributes a)
This removes the attributes in the suppliedAttributes
from thisLdapAttributes
.int
size()
This returns the number of attributes in this attributes.javax.naming.directory.Attributes
toAttributes()
This returns anAttributes
that represents this entry.
-
-
-
Method Detail
-
getAttributes
java.util.Collection<LdapAttribute> getAttributes()
This returns aCollection
ofLdapAttribute
for thisLdapAttributes
.- Returns:
List
-
getAttribute
LdapAttribute getAttribute(java.lang.String name)
This returns theLdapAttribute
for thisLdapAttributes
with the supplied name.- Parameters:
name
-String
- Returns:
LdapAttribute
-
getAttributeNames
java.lang.String[] getAttributeNames()
This returns an array of all the attribute names for thisLdapAttributes
.- Returns:
String[]
-
addAttribute
void addAttribute(LdapAttribute a)
This adds a new attribute to thisLdapAttributes
.- Parameters:
a
-LdapAttribute
-
addAttribute
void addAttribute(java.lang.String name, java.lang.Object value)
This adds a new attribute to thisLdapAttributes
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 thisLdapAttributes
with the supplied name and values.- Parameters:
name
-String
values
-List
-
addAttributes
void addAttributes(java.util.Collection<LdapAttribute> c)
This adds aCollection
of attributes to thisLdapAttributes
. The collection should containLdapAttribute
objects.- Parameters:
c
-Collection
-
addAttributes
void addAttributes(javax.naming.directory.Attributes a) throws javax.naming.NamingException
This adds the attributes in the suppliedAttributes
to thisLdapAttributes
.- Parameters:
a
-Attributes
- Throws:
javax.naming.NamingException
- if the attributes cannot be read
-
removeAttribute
void removeAttribute(LdapAttribute a)
This removes an attribute from thisLdapAttributes
.- 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 aCollection
of attributes from thisLdapAttributes
. The collection should containLdapAttribute
objects.- Parameters:
c
-Collection
-
removeAttributes
void removeAttributes(javax.naming.directory.Attributes a) throws javax.naming.NamingException
This removes the attributes in the suppliedAttributes
from thisLdapAttributes
.- 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 thisLdapAttributes
.
-
toAttributes
javax.naming.directory.Attributes toAttributes()
This returns anAttributes
that represents this entry.- Returns:
Attributes
-
-