org.lsc.beans

Class LscBean

java.lang.Object

org.lsc.beans.LscBean

All Implemented Interfaces:

Serializable, Cloneable, IBean

Direct Known Subclasses:

SimpleBean

public abstract class LscBean
extends Object
implements IBean, Serializable

Basic bean used to centralize methods across all beans

This object mainly provides methods to store and access "attributes", i.e. named fields and their values.

This implementation ignores the case of attribute names, and uses Java Sets to store lists of values, so values must be unique and are unordered.

Author:

Sebastien Bahloul <seb@lsc-project.org>, Jonathan Clarke <jonathan@phillipoux.net>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LscBean()

Method Summary

Modifier and Type	Method and Description
LscBean	clone() Clone this Bean object.
LscDatasets	datasets()
Set<Object>	getAttributeAsSetById(String id) Deprecated.
Attribute	getAttributeById(String id) Deprecated.
String	getAttributeFirstValueById(String id) Deprecated.
Set<String>	getAttributesNames() Get the attributes name.
List<String>	getAttributeValuesById(String id) Get all values of an attribute from its name
Set<Object>	getDatasetAsSetById(String id) Get an attribute from its name as a Set.
List<byte[]>	getDatasetBinaryValuesById(String id) Get all binary values of an attribute from its name
Set<Object>	getDatasetById(String id) Get an dataset from its name.
byte[]	getDatasetFirstBinaryValueById(String id) Get the first binary value of an attribute from its name
String	getDatasetFirstValueById(String id) Get the first value of an attribute from its name
byte[]	getDatasetsBytes()
Set<String>	getDatasetsNames() Get the attributes name list.
List<String>	getDatasetValuesById(String id) Get all values of an attribute from its name
String	getDistinguishedName() Deprecated.
String	getDN() Deprecated.
String	getFullDistinguishedName() Deprecated.
static LscBean	getInstance(SearchResult entry, String baseDn, Class<?> c) Set a bean from an LDAP entry
String	getMainIdentifier() Default distinguished name getter.
void	setAttribute(Attribute attr) Set an attribute.
void	setAttribute(String name, Set<Object> values) Deprecated.
void	setDataset(String name, Set<Object> values) Set a dataset.
void	setDatasets(LscDatasets datasets)
void	setDistinguishName(String dn) Deprecated.
void	setMainIdentifier(String id) Default main object identifier setter.
static void	setMetadata(ResultSetMetaData metaData) Manage something there !
String	toString() Bean pretty printer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LscBean

public LscBean()

Method Detail

getDatasetById

public final Set<Object> getDatasetById(String id)

Get an dataset from its name.

Specified by:

getDatasetById in interface IBean

Parameters:

id - the name

Returns:

the values dataset or null if non existent

getAttributeById

@Deprecated
public final Attribute getAttributeById(String id)

Deprecated.

Description copied from interface: IBean

Get an attribute from its name.

Specified by:

getAttributeById in interface IBean

Parameters:

id - the name

Returns:

the LDAP attribute

getDatasetAsSetById

public final Set<Object> getDatasetAsSetById(String id)

Get an attribute from its name as a Set.

Parameters:

id - the name

Returns:

the LDAP attribute

getAttributeAsSetById

@Deprecated
public final Set<Object> getAttributeAsSetById(String id)

Deprecated.

Description copied from interface: IBean

Get an attribute from its name as a Set.

Specified by:

getAttributeAsSetById in interface IBean

Parameters:

id - the name

Returns:

the LDAP attribute

getDatasetFirstValueById

public final String getDatasetFirstValueById(String id)
                                      throws NamingException

Get the first value of an attribute from its name

Specified by:

getDatasetFirstValueById in interface IBean

Parameters:

id - The attribute name (case insensitive)

Returns:

String The first value of the attribute, or the empty string ("")

Throws:

NamingException

getAttributeFirstValueById

@Deprecated
public final String getAttributeFirstValueById(String id)
                                                    throws NamingException

Deprecated.

Description copied from interface: IBean

Get the first value of an attribute from its name

Specified by:

getAttributeFirstValueById in interface IBean

Parameters:

id - The attribute name (case insensitive)

Returns:

String The first value of the attribute, or the empty string ("")

Throws:

NamingException

getDatasetFirstBinaryValueById

public byte[] getDatasetFirstBinaryValueById(String id)
                                      throws NamingException

Get the first binary value of an attribute from its name

Specified by:

getDatasetFirstBinaryValueById in interface IBean

Parameters:

id - The attribute name (case insensitive)

Returns:

String The first value of the attribute, or null.

Throws:

NamingException

getDatasetValuesById

public final List<String> getDatasetValuesById(String id)
                                        throws NamingException

Get all values of an attribute from its name

Parameters:

id - The attribute name (case insensitive)

Returns:

List List of attribute values, or an empty list

Throws:

NamingException

getDatasetBinaryValuesById

public final List<byte[]> getDatasetBinaryValuesById(String id)
                                              throws NamingException

Get all binary values of an attribute from its name

Parameters:

id - The attribute name (case insensitive)

Returns:

List List of attribute values, or an empty list

Throws:

NamingException

getAttributeValuesById

public final List<String> getAttributeValuesById(String id)
                                          throws NamingException

Description copied from interface: IBean

Get all values of an attribute from its name

Specified by:

getAttributeValuesById in interface IBean

Parameters:

id - The attribute name (case insensitive)

Returns:

List List of attribute values, or an empty list

Throws:

NamingException

getDatasetsNames

public final Set<String> getDatasetsNames()

Get the attributes name list.

Returns:

the attributes list

getAttributesNames

public final Set<String> getAttributesNames()

Description copied from interface: IBean

Get the attributes name.

Specified by:

getAttributesNames in interface IBean

Returns:

a set containing all the attributes name

setAttribute

public final void setAttribute(Attribute attr)

Set an attribute. API CHANGE: Do nothing if attribute is empty

Specified by:

setAttribute in interface IBean

Parameters:

attr - the attribute to set

setDataset

public final void setDataset(String name,
                             Set<Object> values)

Set a dataset.

Specified by:

setDataset in interface IBean

Parameters:

name - The dataset name.

values - A set of values for this dataset.

setAttribute

@Deprecated
public final void setAttribute(String name,
                                           Set<Object> values)

Deprecated.

Description copied from interface: IBean

Set an attribute.

Specified by:

setAttribute in interface IBean

Parameters:

name - The attribute name.

values - A set of values for the attribute.

getMainIdentifier

public final String getMainIdentifier()

Default distinguished name getter.

Specified by:

getMainIdentifier in interface IBean

Returns:

the distinguishedName

getDistinguishedName

@Deprecated
public final String getDistinguishedName()

Deprecated.

Description copied from interface: IBean

Get the distinguished name.

Specified by:

getDistinguishedName in interface IBean

Returns:

the distinguished name

getDN

@Deprecated
public final String getDN()

Deprecated.

Default distinguished name getter.

Returns:

the distinguishedName

getFullDistinguishedName

@Deprecated
public final String getFullDistinguishedName()

Deprecated.

Distinguish name getter that makes sure to return the FULL DN The mainIdentifier is always including the suffix, so this method is the same as getDistinguishedName()

Returns:

the distinguishedName

setMainIdentifier

public final void setMainIdentifier(String id)

Default main object identifier setter.

Specified by:

setMainIdentifier in interface IBean

Parameters:

id - The main identifier to set

setDistinguishName

@Deprecated
public final void setDistinguishName(String dn)

Deprecated.

Description copied from interface: IBean

Set the distinguished name.

Specified by:

setDistinguishName in interface IBean

Parameters:

dn - The distinguishedName to set

toString

public final String toString()

Bean pretty printer.

Overrides:

toString in class Object

Returns:

the pretty formatted string to display

clone

public LscBean clone()
              throws CloneNotSupportedException

Clone this Bean object.

Specified by:

clone in interface IBean

Overrides:

clone in class Object

Returns:

Object

Throws:

CloneNotSupportedException

setMetadata

public static void setMetadata(ResultSetMetaData metaData)

Manage something there !

Parameters:

metaData -

getInstance

public static LscBean getInstance(SearchResult entry,
                                  String baseDn,
                                  Class<?> c)
                           throws NamingException

Set a bean from an LDAP entry

Parameters:

entry - the LDAP entry

baseDn - the base Dn used to set the right Dn

c - class to instantiate

Returns:

the bean

Throws:

NamingException - thrown if a directory exception is encountered while looking at the entry

datasets

public LscDatasets datasets()

Specified by:

datasets in interface IBean

setDatasets

public void setDatasets(LscDatasets datasets)

Specified by:

setDatasets in interface IBean

getDatasetsBytes

public byte[] getDatasetsBytes()