com.nimbusds.infinispan.persistence.ldap

Interface LDAPEntryTransformer<K,V>

public interface LDAPEntryTransformer<K,V>

Interface for transforming between Infinispan entries (key / value pair and metadata) and a corresponding LDAP entry (consisting of a Distinguished Name (DN) and attributes). Implementations must be thread-safe.

To specify an entry transformer for a given Infinispan cache that is backed by an LDAP store, provide its class name to the store configuration.

Method Summary

Modifier and Type	Method and Description
Set<String>	getModifiableAttributes() Returns the names of the LDAP directory attributes that may be modified when an Infinispan entry is updated or replaced via the Map interface.
boolean	includesAttributesWithOptions() Returns true if any of the modifiable attributes may include options (such as a flag indicating a binary value, or a language tag).
com.unboundid.ldap.sdk.RDN	resolveRDN(K key) Resolves the specified Infinispan entry key to a Relative Distinguished Name (RDN) for the matching LDAP directory entry.
com.nimbusds.infinispan.persistence.common.InfinispanEntry<K,V>	toInfinispanEntry(LDAPEntry ldapEntry) Transforms the specified LDAP entry to an Infinispan entry (key / value / metadata triple).
LDAPEntry	toLDAPEntry(com.unboundid.ldap.sdk.DN baseDN, com.nimbusds.infinispan.persistence.common.InfinispanEntry<K,V> infinispanEntry) Transforms the specified Infinispan entry (key / value pair with optional metadata) to an LDAP directory entry ready to be written.

Method Detail

getModifiableAttributes

Set<String> getModifiableAttributes()

Returns the names of the LDAP directory attributes that may be modified when an Infinispan entry is updated or replaced via the Map interface. Attributes that identify the LDAP entry (form its Relative Distinguished Name (RDN)) and the attribute objectClass that defined its classes are typically immutable for an entry and therefore must not be included. Operational (meta) attributes must not be included either.

Example:

• Java object User with fields id, givenName, surname and email.
• These fields map to the LDAP attributes uid, givenName, sn and mail of the LDAP class inetOrgPerson.
• Of of the above LDAP attributes, uid is never changed for a user, and only givenName, sn and mail may be updated. This method should then return the set givenName, sn, mail.

Returns:

The names of the modifiable directory attributes. Must not include objectClass, attributes that form the Relative Distinguished Name (RDN), or operational attributes. Must not be empty or null.

includesAttributesWithOptions

boolean includesAttributesWithOptions()

Returns true if any of the modifiable attributes may include options (such as a flag indicating a binary value, or a language tag).

Returns:

true if any of the modifiable attributes may include options (such as a binary flag or a language tag), else false.

resolveRDN

com.unboundid.ldap.sdk.RDN resolveRDN(K key)

Resolves the specified Infinispan entry key to a Relative Distinguished Name (RDN) for the matching LDAP directory entry.

Example:

• Java object User keyed by its id field which is a String.
• The Java id fields maps to the LDAP attribute uid.
• The "cae7t" key must then resolve to the RDN uid=cae7t.

Composite keys may map to RDNs with multiple attributes, e.g. uid=cae7t+ou=sales.

Parameters:

key - The key. Not null.

Returns:

The resolved RDN.

toLDAPEntry

LDAPEntry toLDAPEntry(com.unboundid.ldap.sdk.DN baseDN,
                      com.nimbusds.infinispan.persistence.common.InfinispanEntry<K,V> infinispanEntry)

Transforms the specified Infinispan entry (key / value pair with optional metadata) to an LDAP directory entry ready to be written. The LDAP entry may be supplied with an LDAPWriteStrategy.

Example:

• Base DN: ou=people,dc=wondlerland,dc=net
• Key: cae7t
• Value: Java POJO with fields uid=cae7t, givenName=Alice, surname=Adams and email=alice@wonderland.net.
• Metadata: Specifies the entry expiration and other properties.

Resulting LDAP entry:

 dn: uid=cae7t,ou=people,dc=wondlerland,dc=net
 objectClass: top
 objectClass: person
 objectClass: organizationalPerson
 objectClass: inetOrgPerson
 uid: cae7t
 cn: Alice Adams
 sn: Adams
 givenName: Alice
 mail: alice@wonderland.net
 

Parameters:

baseDN - The Distinguished Name (DN) of the directory branch where the entry is located. Not null.

infinispanEntry - The Infinispan entry. Not null.

Returns:

The LDAP entry.

toInfinispanEntry

com.nimbusds.infinispan.persistence.common.InfinispanEntry<K,V> toInfinispanEntry(LDAPEntry ldapEntry)

Transforms the specified LDAP entry to an Infinispan entry (key / value / metadata triple).

Example:

LDAP entry:

 dn: uid=cae7t,ou=people,dc=wondlerland,dc=net
 objectClass: top
 objectClass: person
 objectClass: organizationalPerson
 objectClass: inetOrgPerson
 uid: cae7t
 cn: Alice Adams
 sn: Adams
 givenName: Alice
 mail: alice@wonderland.net
 

Resulting key / value pair:

• Key: cae7t
• Value: Java POJO with fields uid=cae7t, givenName=Alice, surname=Adams and email=alice@wonderland.net.
• Metadata: Default metadata (no expiration, etc).

Parameters:

ldapEntry - The LDAP entry. Not null.

Returns:

The Infinispan entry (key / value pair with optional metadata).