edu.vt.middleware.ldap.bean

Interface LdapAttribute

All Known Implementing Classes:

AbstractLdapAttribute, OrderedLdapBeanFactory.OrderedLdapAttribute, SortedLdapBeanFactory.SortedLdapAttribute, UnorderedLdapBeanFactory.UnorderedLdapAttribute

public interface LdapAttribute

LdapAttribute represents a single ldap attribute. Ldap attribute values must be unique per http://tools.ietf.org/html/rfc4512#section-2.3. For any given attribute, the values must all be of the same type.

Version:

$Revision: 1330 $ $Date: 2010-05-23 23:10:53 +0100 (Sun, 23 May 2010) $

Author:

Middleware Services

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() This returns the name of this LdapAttribute.
java.util.Set<java.lang.String>	getStringValues() This returns the value(s) of this LdapAttribute Values are encoded in base64 format if the underlying value is of type byte[].
java.util.Set<java.lang.Object>	getValues() This returns the value(s) of this LdapAttribute.
void	setAttribute(javax.naming.directory.Attribute attribute) This sets this LdapAttribute using the supplied attribute.
void	setName(java.lang.String name) This sets the name of this LdapAttribute.
javax.naming.directory.Attribute	toAttribute() This returns an Attribute that represents the values in this LdapAttribute.

Method Detail

getName

java.lang.String getName()

This returns the name of this LdapAttribute.

Returns:

String

getValues

java.util.Set<java.lang.Object> getValues()

This returns the value(s) of this LdapAttribute.

Returns:

Set

getStringValues

java.util.Set<java.lang.String> getStringValues()

This returns the value(s) of this LdapAttribute Values are encoded in base64 format if the underlying value is of type byte[]. The returned set is unmodifiable.

Returns:

unmodifiable Set

setAttribute

void setAttribute(javax.naming.directory.Attribute attribute)
                  throws javax.naming.NamingException

This sets this LdapAttribute using the supplied attribute.

Parameters:

attribute - Attribute

Throws:

javax.naming.NamingException - if the attribute values cannot be read

setName

void setName(java.lang.String name)

This sets the name of this LdapAttribute.

Parameters:

name - String

toAttribute

javax.naming.directory.Attribute toAttribute()

This returns an Attribute that represents the values in this LdapAttribute.

Returns:

Attribute