@PublicAPI(stability=VOLATILE, mayInstantiate=true, mayExtend=false, mayInvoke=true) public final class EntryEncodeConfig extends Object
Modifier and Type | Field and Description |
---|---|
static EntryEncodeConfig |
DEFAULT_CONFIG
A reference to an entry encode configuration with all the default settings.
|
Constructor and Description |
---|
EntryEncodeConfig()
Creates a new encoded entry configuration with the default settings.
|
EntryEncodeConfig(boolean excludeDN,
boolean compressAttrDescriptions,
boolean compressObjectClassSets)
Creates a new encoded entry configuration with the specified settings.
|
EntryEncodeConfig(boolean excludeDN,
boolean compressAttrDescriptions,
boolean compressObjectClassSets,
CompressedSchema compressedSchema)
Creates a new encoded entry configuration with the specified settings.
|
Modifier and Type | Method and Description |
---|---|
boolean |
compressAttributeDescriptions()
Indicates whether the encoded entry should use compressed attribute descriptions.
|
boolean |
compressObjectClassSets()
Indicates whether the encoded entry should use compressed object class sets.
|
static EntryEncodeConfig |
decode(org.forgerock.opendj.ldap.ByteSequenceReader buffer,
int length,
CompressedSchema compressedSchema)
Decodes the entry encode configuration from current position and length of the given byte array.
|
void |
encode(org.forgerock.opendj.ldap.ByteStringBuilder buffer)
Encodes this entry encode configuration into a byte array suitable for inclusion in the encoded entry.
|
boolean |
excludeDN()
Indicates whether the encoded entry should exclude the DN.
|
CompressedSchema |
getCompressedSchema()
Retrieves the compressed schema manager that may be used to generate compact schema encodings with this entry
encode configuration.
|
String |
toString() |
void |
toString(StringBuilder buffer)
Appends a string representation of this entry encode configuration to the provided buffer.
|
public static final EntryEncodeConfig DEFAULT_CONFIG
public EntryEncodeConfig()
public EntryEncodeConfig(boolean excludeDN, boolean compressAttrDescriptions, boolean compressObjectClassSets)
excludeDN
- Indicates whether to exclude the DN from the encoded entry.compressAttrDescriptions
- Indicates whether to compress attribute descriptions.compressObjectClassSets
- Indicates whether to compress object class sets.public EntryEncodeConfig(boolean excludeDN, boolean compressAttrDescriptions, boolean compressObjectClassSets, CompressedSchema compressedSchema)
excludeDN
- Indicates whether to exclude the DN from the encoded entry.compressAttrDescriptions
- Indicates whether to compress attribute descriptions.compressObjectClassSets
- Indicates whether to compress object class sets.compressedSchema
- The compressed schema manager for this encode config.public boolean excludeDN()
true
if the encoded entry should exclude the DN, or false
if not.public boolean compressAttributeDescriptions()
true
if the encoded entry should use compressed attribute descriptions, or false
if not.public boolean compressObjectClassSets()
true
if the encoded entry should use compressed object class sets, or false
if not.public CompressedSchema getCompressedSchema()
public void encode(org.forgerock.opendj.ldap.ByteStringBuilder buffer)
buffer
- The buffer to encode this configuration to.public static EntryEncodeConfig decode(org.forgerock.opendj.ldap.ByteSequenceReader buffer, int length, CompressedSchema compressedSchema) throws DirectoryException
buffer
- The byte array containing the encoded entry.length
- The number of bytes contained in the encode configuration.compressedSchema
- The compressed schema manager to use when decoding.DirectoryException
- If the configuration cannot be properly decoded.public void toString(StringBuilder buffer)
buffer
- The buffer to which the information should be appended.Copyright © 2010–2017 ForgeRock AS. All rights reserved.