org.apache.directory.server.core.partition.impl.btree.mavibot

Class MavibotEntrySerializer

java.lang.Object

org.apache.directory.mavibot.btree.serializer.AbstractElementSerializer<org.apache.directory.api.ldap.model.entry.Entry>

org.apache.directory.server.core.partition.impl.btree.mavibot.MavibotEntrySerializer

All Implemented Interfaces:

org.apache.directory.mavibot.btree.serializer.ElementSerializer<org.apache.directory.api.ldap.model.entry.Entry>

public class MavibotEntrySerializer
extends org.apache.directory.mavibot.btree.serializer.AbstractElementSerializer<org.apache.directory.api.ldap.model.entry.Entry>

Serialize and deserialize a ServerEntry. There is a big difference with the standard Entry serialization : we don't serialize the entry's Dn, we just serialize it's Rdn.

This class must *not* be used outside of the server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	MavibotEntrySerializer.EntryComparator

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Comparator<org.apache.directory.api.ldap.model.entry.Entry>	comparator
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG the logger for this class
private static org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The schemaManager reference
private static long	serialVersionUID The serialVersionUID

Constructor Summary

Constructors

Constructor and Description
MavibotEntrySerializer() Creates a new instance of ServerEntrySerializer.

Method Summary

Modifier and Type	Method and Description
org.apache.directory.api.ldap.model.entry.Entry	deserialize(org.apache.directory.mavibot.btree.serializer.BufferHandler bufferHandler)
org.apache.directory.api.ldap.model.entry.Entry	deserialize(java.nio.ByteBuffer buffer) Deserialize a Entry.
org.apache.directory.api.ldap.model.entry.Entry	fromBytes(byte[] buffer)
org.apache.directory.api.ldap.model.entry.Entry	fromBytes(byte[] buffer, int pos)
java.util.Comparator<org.apache.directory.api.ldap.model.entry.Entry>	getComparator()
java.lang.Class<?>	getType()
byte[]	serialize(org.apache.directory.api.ldap.model.entry.Entry entry) This is the place where we serialize entries, and all theirs elements.
static void	setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

Methods inherited from class org.apache.directory.mavibot.btree.serializer.AbstractElementSerializer

compare

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The serialVersionUID

See Also:

Constant Field Values

LOG

private static final org.slf4j.Logger LOG

the logger for this class

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

schemaManager

private static org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

The schemaManager reference

comparator

private static java.util.Comparator<org.apache.directory.api.ldap.model.entry.Entry> comparator

Constructor Detail

MavibotEntrySerializer

public MavibotEntrySerializer()

Creates a new instance of ServerEntrySerializer. The schemaManager MUST be set explicitly using the static setSchemaManager(SchemaManager)

Method Detail

getComparator

public java.util.Comparator<org.apache.directory.api.ldap.model.entry.Entry> getComparator()

Specified by:

getComparator in interface org.apache.directory.mavibot.btree.serializer.ElementSerializer<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

getComparator in class org.apache.directory.mavibot.btree.serializer.AbstractElementSerializer<org.apache.directory.api.ldap.model.entry.Entry>

serialize

public byte[] serialize(org.apache.directory.api.ldap.model.entry.Entry entry)

This is the place where we serialize entries, and all theirs elements. the reason why we don't call the underlying methods (ServerAttribute.write(), Value.write()) is that we need access to the registries to read back the values.

The structure used to store the entry is the following :

• [a byte] : if the Dn is empty 0 will be written else 1
• [Rdn] : The entry's Rdn.
• [numberAttr] : the bumber of attributes. Can be 0
• For each Attribute :
  • [attribute's oid] : The attribute's OID to get back the attributeType on deserialization
  • [Attribute] The attribute

deserialize

public org.apache.directory.api.ldap.model.entry.Entry deserialize(java.nio.ByteBuffer buffer)
                                                            throws java.io.IOException

Deserialize a Entry.

Parameters:

bytes - the byte array containing the serialized entry

Returns:

An instance of a Entry object

Throws:

java.io.IOException - if we can't deserialize the Entry

deserialize

public org.apache.directory.api.ldap.model.entry.Entry deserialize(org.apache.directory.mavibot.btree.serializer.BufferHandler bufferHandler)
                                                            throws java.io.IOException

Throws:

java.io.IOException

setSchemaManager

public static void setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

fromBytes

public org.apache.directory.api.ldap.model.entry.Entry fromBytes(byte[] buffer)
                                                          throws java.io.IOException

Throws:

java.io.IOException

fromBytes

public org.apache.directory.api.ldap.model.entry.Entry fromBytes(byte[] buffer,
                                                                 int pos)
                                                          throws java.io.IOException

Throws:

java.io.IOException

getType

public java.lang.Class<?> getType()

Specified by:

getType in interface org.apache.directory.mavibot.btree.serializer.ElementSerializer<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

getType in class org.apache.directory.mavibot.btree.serializer.AbstractElementSerializer<org.apache.directory.api.ldap.model.entry.Entry>