org.apache.directory.server.core.api.entry

Class ServerEntryUtils

java.lang.Object

org.apache.directory.server.core.api.entry.ServerEntryUtils

public final class ServerEntryUtils
extends java.lang.Object

A helper class used to manipulate Entries, Attributes and Values.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ServerEntryUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.List<org.apache.directory.api.ldap.model.entry.Modification>	convertToServerModification(java.util.List<javax.naming.directory.ModificationItem> modificationItems, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Convert a list of ModificationItemImpl to a list of
static void	filterContents(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, FilteringOperationContext operationContext, org.apache.directory.api.ldap.model.entry.Entry entry) Filters an entry accordingly to the requested Attribute list.
static org.apache.directory.api.ldap.model.entry.Attribute	getAttribute(java.util.List<org.apache.directory.api.ldap.model.entry.Modification> mods, org.apache.directory.api.ldap.model.schema.AttributeType type) Utility method to extract an attribute from a list of modifications.
static org.apache.directory.api.ldap.model.entry.Modification	getModificationItem(java.util.List<org.apache.directory.api.ldap.model.entry.Modification> mods, org.apache.directory.api.ldap.model.schema.AttributeType type) Utility method to extract a modification item from an array of modifications.
private static java.util.Set<java.lang.String>	getOptions(java.lang.String attributeId) Get the options from the attributeType.
static org.apache.directory.api.ldap.model.entry.Entry	getTargetEntry(org.apache.directory.api.ldap.model.entry.Modification mod, org.apache.directory.api.ldap.model.entry.Entry entry, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Gets the target entry as it would look after a modification operation was performed on it.
static org.apache.directory.api.ldap.model.entry.Attribute	getUnion(org.apache.directory.api.ldap.model.entry.Attribute attr0, org.apache.directory.api.ldap.model.entry.Attribute attr1) Creates a new attribute which contains the values representing the union of two attributes.
private static java.lang.String	stripOptions(java.lang.String attributeId) Remove the options from the attributeType, and returns the ID.
static javax.naming.directory.Attribute	toBasicAttribute(org.apache.directory.api.ldap.model.entry.Attribute entryAttribute) Convert a ServerAttribute into a BasicAttribute.
static javax.naming.directory.Attributes	toBasicAttributes(org.apache.directory.api.ldap.model.entry.Entry entry) Convert a ServerEntry into a BasicAttributes.
static javax.naming.NamingEnumeration<javax.naming.directory.SearchResult>	toSearchResultEnum(javax.naming.NamingEnumeration<ServerSearchResult> result) Encapsulate a ServerSearchResult enumeration into a SearchResult enumeration
static org.apache.directory.api.ldap.model.entry.Attribute	toServerAttribute(javax.naming.directory.Attribute attribute, org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Convert a BasicAttribute or a AttributeImpl to a ServerAtribute
static org.apache.directory.api.ldap.model.entry.Entry	toServerEntry(javax.naming.directory.Attributes attributes, org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Convert a BasicAttributes or a AttributesImpl to a ServerEntry
static java.util.List<org.apache.directory.api.ldap.model.entry.Modification>	toServerModification(org.apache.directory.api.ldap.model.entry.Modification[] modifications, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
private static org.apache.directory.api.ldap.model.entry.Modification	toServerModification(org.apache.directory.api.ldap.model.entry.Modification modification, org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Convert a Modification to an instance of a ServerModification object.
static java.util.List<org.apache.directory.api.ldap.model.entry.Modification>	toServerModification(javax.naming.directory.ModificationItem[] modifications, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
private static org.apache.directory.api.ldap.model.entry.Modification	toServerModification(javax.naming.directory.ModificationItem modificationImpl, org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Convert a ModificationItem to an instance of a ServerModification object

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerEntryUtils

private ServerEntryUtils()

Method Detail

toBasicAttribute

public static javax.naming.directory.Attribute toBasicAttribute(org.apache.directory.api.ldap.model.entry.Attribute entryAttribute)

Convert a ServerAttribute into a BasicAttribute. The Dn is lost during this conversion, as the Attributes object does not store this element.

Returns:

An instance of a AttributesImpl() object

toBasicAttributes

public static javax.naming.directory.Attributes toBasicAttributes(org.apache.directory.api.ldap.model.entry.Entry entry)

Convert a ServerEntry into a BasicAttributes. The Dn is lost during this conversion, as the Attributes object does not store this element.

Returns:

An instance of a AttributesImpl() object

toServerAttribute

public static org.apache.directory.api.ldap.model.entry.Attribute toServerAttribute(javax.naming.directory.Attribute attribute,
                                                                                    org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
                                                                             throws org.apache.directory.api.ldap.model.exception.LdapException

Convert a BasicAttribute or a AttributeImpl to a ServerAtribute

Parameters:

attribute - the BasicAttributes or AttributesImpl instance to convert

attributeType -

Returns:

An instance of a ServerEntry object

Throws:

InvalidAttributeIdentifierException - If we had an incorrect attribute

org.apache.directory.api.ldap.model.exception.LdapException

toServerEntry

public static org.apache.directory.api.ldap.model.entry.Entry toServerEntry(javax.naming.directory.Attributes attributes,
                                                                            org.apache.directory.api.ldap.model.name.Dn dn,
                                                                            org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
                                                                     throws org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeTypeException

Convert a BasicAttributes or a AttributesImpl to a ServerEntry

Parameters:

attributes - the BasicAttributes or AttributesImpl instance to convert

registries - The registries, needed ro build a ServerEntry

dn - The Dn which is needed by the ServerEntry

Returns:

An instance of a ServerEntry object

Throws:

org.apache.directory.api.ldap.model.exception.LdapInvalidAttributeTypeException - If we get an invalid attribute

getTargetEntry

public static org.apache.directory.api.ldap.model.entry.Entry getTargetEntry(org.apache.directory.api.ldap.model.entry.Modification mod,
                                                                             org.apache.directory.api.ldap.model.entry.Entry entry,
                                                                             org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
                                                                      throws org.apache.directory.api.ldap.model.exception.LdapException

Gets the target entry as it would look after a modification operation was performed on it.

Parameters:

mod - the modification

entry - the source entry that is modified

Returns:

the resultant entry after the modification has taken place

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there are problems accessing attributes

getUnion

public static org.apache.directory.api.ldap.model.entry.Attribute getUnion(org.apache.directory.api.ldap.model.entry.Attribute attr0,
                                                                           org.apache.directory.api.ldap.model.entry.Attribute attr1)
                                                                    throws org.apache.directory.api.ldap.model.exception.LdapException

Creates a new attribute which contains the values representing the union of two attributes. If one attribute is null then the resultant attribute returned is a copy of the non-null attribute. If both are null then we cannot determine the attribute ID and an IllegalArgumentException is raised.

Parameters:

attr0 - the first attribute

attr1 - the second attribute

Returns:

a new attribute with the union of values from both attribute arguments

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there are problems accessing attribute values

toServerModification

private static org.apache.directory.api.ldap.model.entry.Modification toServerModification(javax.naming.directory.ModificationItem modificationImpl,
                                                                                           org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
                                                                                    throws org.apache.directory.api.ldap.model.exception.LdapException

Convert a ModificationItem to an instance of a ServerModification object

Parameters:

modificationImpl - the modification instance to convert

attributeType - the associated attributeType

Returns:

a instance of a ServerModification object

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

convertToServerModification

public static java.util.List<org.apache.directory.api.ldap.model.entry.Modification> convertToServerModification(java.util.List<javax.naming.directory.ModificationItem> modificationItems,
                                                                                                                 org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
                                                                                                          throws org.apache.directory.api.ldap.model.exception.LdapException

Convert a list of ModificationItemImpl to a list of

Parameters:

modificationImpls -

atRegistry -

Returns:

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

toServerModification

private static org.apache.directory.api.ldap.model.entry.Modification toServerModification(org.apache.directory.api.ldap.model.entry.Modification modification,
                                                                                           org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
                                                                                    throws org.apache.directory.api.ldap.model.exception.LdapException

Convert a Modification to an instance of a ServerModification object.

Parameters:

modificationImpl - the modification instance to convert

attributeType - the associated attributeType

Returns:

a instance of a ServerModification object

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

toServerModification

public static java.util.List<org.apache.directory.api.ldap.model.entry.Modification> toServerModification(org.apache.directory.api.ldap.model.entry.Modification[] modifications,
                                                                                                          org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
                                                                                                   throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

toServerModification

public static java.util.List<org.apache.directory.api.ldap.model.entry.Modification> toServerModification(javax.naming.directory.ModificationItem[] modifications,
                                                                                                          org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
                                                                                                   throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getModificationItem

public static org.apache.directory.api.ldap.model.entry.Modification getModificationItem(java.util.List<org.apache.directory.api.ldap.model.entry.Modification> mods,
                                                                                         org.apache.directory.api.ldap.model.schema.AttributeType type)

Utility method to extract a modification item from an array of modifications.

Parameters:

mods - the array of ModificationItems to extract the Attribute from.

type - the attributeType spec of the Attribute to extract

Returns:

the modification item on the attributeType specified

getAttribute

public static org.apache.directory.api.ldap.model.entry.Attribute getAttribute(java.util.List<org.apache.directory.api.ldap.model.entry.Modification> mods,
                                                                               org.apache.directory.api.ldap.model.schema.AttributeType type)

Utility method to extract an attribute from a list of modifications.

Parameters:

mods - the list of ModificationItems to extract the Attribute from.

type - the attributeType spec of the Attribute to extract

Returns:

the extract Attribute or null if no such attribute exists

toSearchResultEnum

public static javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> toSearchResultEnum(javax.naming.NamingEnumeration<ServerSearchResult> result)

Encapsulate a ServerSearchResult enumeration into a SearchResult enumeration

Parameters:

result - The ServerSearchResult enumeration

Returns:

A SearchResultEnumeration

stripOptions

private static java.lang.String stripOptions(java.lang.String attributeId)

Remove the options from the attributeType, and returns the ID. RFC 4512 : attributedescription = attributetype options attributetype = oid options = *( SEMI option ) option = 1*keychar

getOptions

private static java.util.Set<java.lang.String> getOptions(java.lang.String attributeId)

Get the options from the attributeType. For instance, given : jpegphoto;binary;lang=jp your get back a set containing { "binary", "lang=jp" }

filterContents

public static void filterContents(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                  FilteringOperationContext operationContext,
                                  org.apache.directory.api.ldap.model.entry.Entry entry)
                           throws org.apache.directory.api.ldap.model.exception.LdapException

Filters an entry accordingly to the requested Attribute list.

Parameters:

entry - The entry to filter

operationContext - The SearchingOperationContext

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the filtering fails