com.groiss.ldap
Class AttributeMapping

java.lang.Object
  com.groiss.ldap.AttributeMapping

public class AttributeMapping
extends java.lang.Object

Maps LDAP attribute names to field names of java objects. Is part of a class mapping. Different kinds of mapping can be specified via the provided finals.

Field Summary

static int	BY_BOOL Reference type BY_BOOL designates a reference based on a boolean value (TRUE/FALSE)
static int	BY_CLASS Reference type BY_CLASS designates a reference based on the name of the Java objects class
static int	BY_DN Reference type BY_DN designates a reference based on the distinguished name (LDAP-DN) of the class mapping of the objects class
static int	BY_ID Reference type BY_ID designates a reference based on the value of the id field of the Java Object
static int	BY_ID_CHAIN Reference type BY_ID_CHAIN designates a reference based on a chain of id references
static int	BY_OID Reference type BY_OID designates a reference based on the value of field oid of the java object
static int	BY_PWD Reference type BY_PWD designates a special treatment of the password field according to RFC 2307
static int	BY_VALUE Reference type BY_VALUE designates a reference based on the attributes value.

Constructor Summary

AttributeMapping(ClassMapping cm, java.lang.String attName, java.lang.String fieldName)
Constructs a new AttributeMapping and adds it to a Class Mapping

Method Summary

java.lang.String	getAttName() Returns the LDAP attribute name of this attribute mapping
ClassMapping	getCm() Returns the class mapping this attribute mapping belongs to
java.lang.String	getFieldName() Returns the Java field name of this attribute mapping
int	getRefType() Returns the reference type of this mapping
void	setRefType(int refType) Sets the reference type of this mapping

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BY_VALUE

public static final int BY_VALUE

Reference type BY_VALUE designates a reference based on the attributes value. This is the default reference type.

See Also:

Constant Field Values

BY_ID

public static final int BY_ID

Reference type BY_ID designates a reference based on the value of the id field of the Java Object

See Also:

Constant Field Values

BY_DN

public static final int BY_DN

Reference type BY_DN designates a reference based on the distinguished name (LDAP-DN) of the class mapping of the objects class

See Also:

Constant Field Values

BY_BOOL

public static final int BY_BOOL

Reference type BY_BOOL designates a reference based on a boolean value (TRUE/FALSE)

See Also:

Constant Field Values

BY_ID_CHAIN

public static final int BY_ID_CHAIN

Reference type BY_ID_CHAIN designates a reference based on a chain of id references

See Also:

Constant Field Values

BY_OID

public static final int BY_OID

Reference type BY_OID designates a reference based on the value of field oid of the java object

See Also:

Constant Field Values

BY_CLASS

public static final int BY_CLASS

Reference type BY_CLASS designates a reference based on the name of the Java objects class

See Also:

Constant Field Values

BY_PWD

public static final int BY_PWD

Reference type BY_PWD designates a special treatment of the password field according to RFC 2307

See Also:

Constant Field Values

Constructor Detail

AttributeMapping

public AttributeMapping(ClassMapping cm,
                        java.lang.String attName,
                        java.lang.String fieldName)

Constructs a new AttributeMapping and adds it to a Class Mapping

Parameters:

cm - the class mapping to which the attribute mapping is added

attName - the LDAP attribute name

fieldName - the Java field name

Method Detail

getCm

public ClassMapping getCm()

Returns the class mapping this attribute mapping belongs to

Returns:

the class mapping

getFieldName

public java.lang.String getFieldName()

Returns the Java field name of this attribute mapping

Returns:

the Java field name

getAttName

public java.lang.String getAttName()

Returns the LDAP attribute name of this attribute mapping

Returns:

the LDAP attribute name

setRefType

public void setRefType(int refType)

Sets the reference type of this mapping

Parameters:

refType -

getRefType

public int getRefType()

Returns the reference type of this mapping

Returns:

the reference type of this mapping