org.lsc.beans

Interface IBean

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

LscBean, OrderedValuesBean, SimpleBean

public interface IBean
extends Cloneable, Serializable

General interface of a bean. A bean in LSC describes an object in a source or destination. It has nothing to do with Java beans (in fact, LSC beans do not have any get- or set- methods).

An object is described in this bean as datasets (set of named values) and main identifier.

Most methods are convenience methods to get the values of each dataset.

Author:

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

Method Summary

Modifier and Type	Method and Description
IBean	clone() Clone this object.
LscDatasets	datasets()
Set<Object>	getAttributeAsSetById(String id) Deprecated.
Attribute	getAttributeById(String id) Deprecated.
String	getAttributeFirstValueById(String id) Deprecated.
Set<String>	getAttributesNames() Deprecated. Since LSC 2.0
List<String>	getAttributeValuesById(String id) Deprecated. See getDatasetById(String id)
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
String	getDistinguishedName() Deprecated. Since LSC 2.0 - switch to getMainIdentifier()
String	getMainIdentifier()
void	setAttribute(Attribute attr) Deprecated. Since LSC 2.0
void	setAttribute(String attrName, Set<Object> attrValues) Deprecated. Since LSC 2.0
void	setDataset(String name, Set<Object> values) Set an dataset.
void	setDatasets(LscDatasets datasets)
void	setDistinguishName(String dn) Deprecated. Since LSC 2.0 - switch to setMainIdentifier(String mainIdentifier)
void	setMainIdentifier(String mainIdentifier)

Method Detail

getAttributeById

@Deprecated
Attribute getAttributeById(String id)

Deprecated.

Get an attribute from its name.

Parameters:

id - the name

Returns:

the LDAP attribute

getDatasetById

Set<Object> getDatasetById(String id)

Get an dataset from its name.

Parameters:

id - the name

Returns:

the values dataset or null if non existent

getAttributeAsSetById

@Deprecated
Set<Object> getAttributeAsSetById(String id)

Deprecated.

Get an attribute from its name as a Set.

Parameters:

id - the name

Returns:

the LDAP attribute

getAttributeFirstValueById

@Deprecated
String getAttributeFirstValueById(String id)
                                       throws NamingException

Deprecated.

Get the first value of an attribute from its name

Parameters:

id - The attribute name (case insensitive)

Returns:

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

Throws:

NamingException

getDatasetFirstValueById

String getDatasetFirstValueById(String id)
                         throws NamingException

Get the first value of an attribute from its name

Parameters:

id - The attribute name (case insensitive)

Returns:

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

Throws:

NamingException

getDatasetFirstBinaryValueById

byte[] getDatasetFirstBinaryValueById(String id)
                               throws NamingException

Get the first binary value of an attribute from its name

Parameters:

id - The attribute name (case insensitive)

Returns:

byte[] The first value of the attribute, or null.

Throws:

NamingException

getAttributeValuesById

@Deprecated
List<String> getAttributeValuesById(String id)
                                         throws NamingException

Deprecated. See getDatasetById(String id)

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

getAttributesNames

@Deprecated
Set<String> getAttributesNames()

Deprecated. Since LSC 2.0

Get the attributes name.

Returns:

a set containing all the attributes name

setAttribute

@Deprecated
void setAttribute(Attribute attr)

Deprecated. Since LSC 2.0

Set an attribute.

Parameters:

attr - the attribute to set

setAttribute

@Deprecated
void setAttribute(String attrName,
                              Set<Object> attrValues)

Deprecated. Since LSC 2.0

Set an attribute.

Parameters:

attrName - The attribute name.

attrValues - A set of values for the attribute.

setDataset

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

Set an dataset.

Parameters:

name - The dataset name.

values - A set of values for this dataset.

getDistinguishedName

@Deprecated
String getDistinguishedName()

Deprecated. Since LSC 2.0 - switch to getMainIdentifier()

Get the distinguished name.

Returns:

the distinguished name

setDistinguishName

@Deprecated
void setDistinguishName(String dn)

Deprecated. Since LSC 2.0 - switch to setMainIdentifier(String mainIdentifier)

Set the distinguished name.

Parameters:

dn - The distinguishedName to set

setDatasets

void setDatasets(LscDatasets datasets)

datasets

LscDatasets datasets()

getMainIdentifier

String getMainIdentifier()

setMainIdentifier

void setMainIdentifier(String mainIdentifier)

clone

IBean clone()
     throws CloneNotSupportedException

Clone this object.

Returns:

Object

Throws:

CloneNotSupportedException