| Package | Description |
|---|---|
| org.forgerock.opendj.io |
Classes and interfaces providing I/O functionality.
|
| org.forgerock.opendj.ldap |
Classes and interfaces for core types including connections, entries, and
attributes.
|
| org.forgerock.opendj.ldap.controls |
Classes and interfaces for common LDAP controls.
|
| org.forgerock.opendj.ldap.requests |
Classes and interfaces for core LDAP requests.
|
| org.forgerock.opendj.ldap.responses |
Classes and interfaces for core LDAP responses.
|
| org.forgerock.opendj.ldap.schema |
Classes and interfaces for constructing and querying LDAP schemas.
|
| org.forgerock.opendj.ldap.spi |
Interfaces and classes for service providers.
|
| org.forgerock.opendj.ldif |
Classes and interfaces for reading and writing LDIF.
|
| Modifier and Type | Method and Description |
|---|---|
protected DecodeException |
AbstractLDAPMessageHandler.newUnexpectedRequestException(int messageID,
Request request)
Returns a decoding exception suitable for use when an unexpected LDAP
request is received.
|
protected DecodeException |
AbstractLDAPMessageHandler.newUnexpectedResponseException(int messageID,
Response response)
Returns a decoding exception suitable for use when an unexpected LDAP
response is received.
|
protected DecodeException |
AbstractLDAPMessageHandler.newUnsupportedMessageException(int messageID,
byte messageTag,
ByteString messageBytes)
Returns a decoding exception suitable for use when an unsupported LDAP
message is received.
|
| Modifier and Type | Method and Description |
|---|---|
void |
AbstractLDAPMessageHandler.abandonRequest(int messageID,
AbandonRequest request) |
void |
LDAPMessageHandler.abandonRequest(int messageID,
AbandonRequest request)
Handles an LDAP abandon request message.
|
void |
AbstractLDAPMessageHandler.addRequest(int messageID,
AddRequest request) |
void |
LDAPMessageHandler.addRequest(int messageID,
AddRequest request)
Handles an LDAP add request message.
|
void |
AbstractLDAPMessageHandler.addResult(int messageID,
Result result) |
void |
LDAPMessageHandler.addResult(int messageID,
Result result)
Handles an LDAP add result message.
|
void |
AbstractLDAPMessageHandler.bindRequest(int messageID,
int version,
GenericBindRequest request) |
void |
LDAPMessageHandler.bindRequest(int messageID,
int version,
GenericBindRequest request)
Handles an LDAP bind request message.
|
void |
AbstractLDAPMessageHandler.bindResult(int messageID,
BindResult result) |
void |
LDAPMessageHandler.bindResult(int messageID,
BindResult result)
Handles an LDAP bind result message.
|
void |
AbstractLDAPMessageHandler.compareRequest(int messageID,
CompareRequest request) |
void |
LDAPMessageHandler.compareRequest(int messageID,
CompareRequest request)
Handles an LDAP compare request message.
|
void |
AbstractLDAPMessageHandler.compareResult(int messageID,
CompareResult result) |
void |
LDAPMessageHandler.compareResult(int messageID,
CompareResult result)
Handles an LDAP compare result message.
|
void |
AbstractLDAPMessageHandler.deleteRequest(int messageID,
DeleteRequest request) |
void |
LDAPMessageHandler.deleteRequest(int messageID,
DeleteRequest request)
Handles an LDAP delete request message.
|
void |
AbstractLDAPMessageHandler.deleteResult(int messageID,
Result result) |
void |
LDAPMessageHandler.deleteResult(int messageID,
Result result)
Handles an LDAP delete result message.
|
boolean |
ASN1Reader.elementAvailable()
Indicates whether or not the next element can be read without blocking.
|
<R extends ExtendedResult> |
AbstractLDAPMessageHandler.extendedRequest(int messageID,
ExtendedRequest<R> request) |
<R extends ExtendedResult> |
LDAPMessageHandler.extendedRequest(int messageID,
ExtendedRequest<R> request)
Handles an LDAP extended request message.
|
void |
AbstractLDAPMessageHandler.extendedResult(int messageID,
ExtendedResult result) |
void |
LDAPMessageHandler.extendedResult(int messageID,
ExtendedResult result)
Handles an LDAP extended result message.
|
boolean |
LDAPReader.hasMessageAvailable()
Returns
true if the next LDAP message can be read without
blocking. |
boolean |
ASN1Reader.hasNextElement()
Indicates whether or not the current stream, sequence, or set contains
another element.
|
void |
AbstractLDAPMessageHandler.intermediateResponse(int messageID,
IntermediateResponse response) |
void |
LDAPMessageHandler.intermediateResponse(int messageID,
IntermediateResponse response)
Handles an LDAP intermediate response message.
|
void |
AbstractLDAPMessageHandler.modifyDNRequest(int messageID,
ModifyDNRequest request) |
void |
LDAPMessageHandler.modifyDNRequest(int messageID,
ModifyDNRequest request)
Handles an LDAP modify DN request message.
|
void |
AbstractLDAPMessageHandler.modifyDNResult(int messageID,
Result result) |
void |
LDAPMessageHandler.modifyDNResult(int messageID,
Result result)
Handles an LDAP modify DN result message.
|
void |
AbstractLDAPMessageHandler.modifyRequest(int messageID,
ModifyRequest request) |
void |
LDAPMessageHandler.modifyRequest(int messageID,
ModifyRequest request)
Handles an LDAP modify request message.
|
void |
AbstractLDAPMessageHandler.modifyResult(int messageID,
Result result) |
void |
LDAPMessageHandler.modifyResult(int messageID,
Result result)
Handles an LDAP modify result message.
|
int |
ASN1Reader.peekLength()
Returns the data length of the next element without actually reading it.
|
byte |
ASN1Reader.peekType()
Returns the type of the next element without actually reading it.
|
boolean |
ASN1Reader.readBoolean()
Reads the next element as a boolean having the Universal Boolean ASN.1
type tag.
|
boolean |
ASN1Reader.readBoolean(byte type)
Reads the next element as a boolean having the provided type tag.
|
void |
ASN1Reader.readEndExplicitTag()
Finishes reading an explicit tag and discards any unread elements.
|
void |
ASN1Reader.readEndSequence()
Finishes reading a sequence and discards any unread elements.
|
void |
ASN1Reader.readEndSet()
Finishes reading a set and discards any unread elements.
|
int |
ASN1Reader.readEnumerated()
Reads the next element as an enumerated having the Universal Enumerated
ASN.1 type tag.
|
int |
ASN1Reader.readEnumerated(byte type)
Reads the next element as an enumerated having the provided type tag.
|
long |
ASN1Reader.readInteger()
Reads the next element as an integer having the Universal Integer ASN.1
type tag.
|
long |
ASN1Reader.readInteger(byte type)
Reads the next element as an integer having the provided type tag.
|
void |
LDAPReader.readMessage(LDAPMessageHandler handler)
Reads the next LDAP message from the underlying ASN.1 reader.
|
void |
ASN1Reader.readNull()
Reads the next element as a null element having the Universal Null ASN.1
type tag.
|
void |
ASN1Reader.readNull(byte type)
Reads the next element as a null element having the provided type tag.
|
ByteString |
ASN1Reader.readOctetString()
Reads the next element as an octet string having the Universal Octet
String ASN.1 type tag.
|
ByteString |
ASN1Reader.readOctetString(byte type)
Reads the next element as an octet string having the provided type tag.
|
ByteStringBuilder |
ASN1Reader.readOctetString(byte type,
ByteStringBuilder builder)
Reads the next element as an octet string having the provided type tag
and appends it to the provided
ByteStringBuilder. |
ByteStringBuilder |
ASN1Reader.readOctetString(ByteStringBuilder builder)
Reads the next element as an octet string having the Universal Octet
String ASN.1 type tag and appends it to the provided
ByteStringBuilder. |
String |
ASN1Reader.readOctetStringAsString()
Reads the next element as an octet string having the Universal Octet
String ASN.1 type tag and decodes the value as a UTF-8 encoded string.
|
String |
ASN1Reader.readOctetStringAsString(byte type)
Reads the next element as an octet string having the provided type tag
and decodes the value as a UTF-8 encoded string.
|
void |
ASN1Reader.readStartExplicitTag()
Reads the next element as an explicit ignoring the ASN.1 type tag.
|
void |
ASN1Reader.readStartExplicitTag(byte type)
Reads the next element as an explicit tag having the provided tag type.
|
void |
ASN1Reader.readStartSequence()
Reads the next element as a sequence having the Universal Sequence ASN.1
type tag.
|
void |
ASN1Reader.readStartSequence(byte type)
Reads the next element as a sequence having the provided type tag.
|
void |
ASN1Reader.readStartSet()
Reads the next element as a set having the Universal Set ASN.1 type tag.
|
void |
ASN1Reader.readStartSet(byte type)
Reads the next element as a set having the provided type tag.
|
void |
AbstractLDAPMessageHandler.searchRequest(int messageID,
SearchRequest request) |
void |
LDAPMessageHandler.searchRequest(int messageID,
SearchRequest request)
Handles an LDAP search request message.
|
void |
AbstractLDAPMessageHandler.searchResult(int messageID,
Result result) |
void |
LDAPMessageHandler.searchResult(int messageID,
Result result)
Handles an LDAP search result message.
|
void |
AbstractLDAPMessageHandler.searchResultEntry(int messageID,
SearchResultEntry entry) |
void |
LDAPMessageHandler.searchResultEntry(int messageID,
SearchResultEntry entry)
Handles an LDAP search result entry message.
|
void |
AbstractLDAPMessageHandler.searchResultReference(int messageID,
SearchResultReference reference) |
void |
LDAPMessageHandler.searchResultReference(int messageID,
SearchResultReference reference)
Handles an LDAP search result reference message.
|
ASN1Reader |
ASN1Reader.skipElement()
Skips the next element without decoding it.
|
ASN1Reader |
ASN1Reader.skipElement(byte type)
Skips the next element having the provided type tag without decoding it.
|
void |
AbstractLDAPMessageHandler.unbindRequest(int messageID,
UnbindRequest request) |
void |
LDAPMessageHandler.unbindRequest(int messageID,
UnbindRequest request)
Handles an LDAP unbind request message.
|
void |
AbstractLDAPMessageHandler.unrecognizedMessage(int messageID,
byte messageTag,
ByteString messageBytes) |
void |
LDAPMessageHandler.unrecognizedMessage(int messageID,
byte messageTag,
ByteString messageBytes)
Handles an unrecognized LDAP message.
|
| Modifier and Type | Method and Description |
|---|---|
static DecodeException |
DecodeException.error(LocalizableMessage message)
Creates a new non-fatal decode exception with the provided message.
|
static DecodeException |
DecodeException.error(LocalizableMessage message,
Throwable cause)
Creates a new non-fatal decode exception with the provided message and
root cause.
|
static DecodeException |
DecodeException.fatalError(LocalizableMessage message)
Creates a new fatal decode exception with the provided message.
|
static DecodeException |
DecodeException.fatalError(LocalizableMessage message,
Throwable cause)
Creates a new fatal decode exception with the provided message and root
cause.
|
| Modifier and Type | Method and Description |
|---|---|
<T> T |
Assertion.createIndexQuery(IndexQueryFactory<T> factory)
Returns an index query appropriate for the provided attribute
value assertion.
|
BigInteger |
GSERParser.nextBigInteger()
Returns the next element as a BigInteger.
|
String |
GSERParser.nextChoiceValueIdentifier()
Return the identifier of the next IdentifiedChoiceValue element.
|
int |
GSERParser.nextInteger()
Returns the next element as an Integer.
|
String |
GSERParser.nextNamedValueIdentifier()
Returns the identifier of the next NamedValue element.
|
String |
GSERParser.nextString()
Returns the next element as a String.
|
GSERParser |
GSERParser.readEndSequence()
Skips the input matching the end of a sequence and preceding space
characters.
|
GSERParser |
GSERParser.readStartSequence()
Skips the input matching the start of a sequence and subsequent space
characters.
|
GSERParser |
GSERParser.skipMSP()
Skips the input matching one or more space characters.
|
GSERParser |
GSERParser.skipSeparator()
Skips the input matching the separator pattern (",") and subsequenct
space characters.
|
GSERParser |
GSERParser.skipSP()
Skips the input matching zero, one or more space characters.
|
| Modifier and Type | Method and Description |
|---|---|
C |
ControlDecoder.decodeControl(Control control,
DecodeOptions options)
Decodes the provided control as a
Control of type C. |
| Modifier and Type | Method and Description |
|---|---|
R |
ExtendedRequestDecoder.decodeExtendedRequest(ExtendedRequest<?> request,
DecodeOptions options)
Decodes the provided extended operation request as an
ExtendedRequest of type R. |
<C extends Control> |
BindRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
CompareRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
StartTLSExtendedRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
UnbindRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
SearchRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
SimpleBindRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
AddRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
AbandonRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
DeleteRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
SASLBindRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
GenericExtendedRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
AnonymousSASLBindRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
ModifyDNRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
ExternalSASLBindRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
GenericBindRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
PasswordModifyExtendedRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
WhoAmIExtendedRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
GSSAPISASLBindRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
DigestMD5SASLBindRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
CancelExtendedRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
PlainSASLBindRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
ExtendedRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
CRAMMD5SASLBindRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
ModifyRequest.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
Request.getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this request having an OID
corresponding to the provided control decoder.
|
| Modifier and Type | Method and Description |
|---|---|
S |
ExtendedResultDecoder.adaptDecodeException(DecodeException exception)
Creates a new extended operation error result using the provided decoding
exception.
|
S |
AbstractExtendedResultDecoder.adaptDecodeException(DecodeException exception) |
| Modifier and Type | Method and Description |
|---|---|
S |
ExtendedResultDecoder.decodeExtendedResult(ExtendedResult result,
DecodeOptions options)
Decodes the provided extended operation result as a
Result of
type S. |
abstract S |
AbstractExtendedResultDecoder.decodeExtendedResult(ExtendedResult result,
DecodeOptions options) |
<C extends Control> |
PasswordModifyExtendedResult.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
SearchResultEntry.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
Response.getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this response having an OID
corresponding to the provided control decoder.
|
<C extends Control> |
GenericIntermediateResponse.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
ExtendedResult.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
SearchResultReference.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
BindResult.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
CompareResult.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
GenericExtendedResult.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
WhoAmIExtendedResult.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
Result.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
<C extends Control> |
IntermediateResponse.getControl(ControlDecoder<C> decoder,
DecodeOptions options) |
| Modifier and Type | Method and Description |
|---|---|
Assertion |
MatchingRule.getAssertion(ByteSequence value)
Returns the normalized form of the provided assertion value, which is
best suited for efficiently performing matching operations on that value.
|
Assertion |
MatchingRuleImpl.getAssertion(Schema schema,
ByteSequence assertionValue)
Retrieves the normalized form of the provided assertion value, which is
best suited for efficiently performing less than matching operations on
that value.
|
Assertion |
MatchingRule.getGreaterOrEqualAssertion(ByteSequence value)
Returns the normalized form of the provided assertion value, which is
best suited for efficiently performing greater than or equal ordering
matching operations on that value.
|
Assertion |
MatchingRuleImpl.getGreaterOrEqualAssertion(Schema schema,
ByteSequence value)
Retrieves the normalized form of the provided assertion value, which is
best suited for efficiently performing greater than or equal matching
operations on that value.
|
Assertion |
MatchingRule.getLessOrEqualAssertion(ByteSequence value)
Returns the normalized form of the provided assertion value, which is
best suited for efficiently performing greater than or equal ordering
matching operations on that value.
|
Assertion |
MatchingRuleImpl.getLessOrEqualAssertion(Schema schema,
ByteSequence value)
Retrieves the normalized form of the provided assertion value, which is
best suited for efficiently performing less than or equal matching
operations on that value.
|
Assertion |
MatchingRule.getSubstringAssertion(ByteSequence subInitial,
List<? extends ByteSequence> subAnyElements,
ByteSequence subFinal)
Returns the normalized form of the provided assertion substring values,
which is best suited for efficiently performing matching operations on
that value.
|
Assertion |
MatchingRuleImpl.getSubstringAssertion(Schema schema,
ByteSequence subInitial,
List<? extends ByteSequence> subAnyElements,
ByteSequence subFinal)
Retrieves the normalized form of the provided assertion substring values,
which is best suited for efficiently performing matching operations on
that value.
|
ByteString |
MatchingRule.normalizeAttributeValue(ByteSequence value)
Returns the normalized form of the provided attribute value, which is
best suited for efficiently performing matching operations on that value.
|
ByteString |
MatchingRuleImpl.normalizeAttributeValue(Schema schema,
ByteSequence value)
Retrieves the normalized form of the provided attribute value, which is
best suited for efficiently performing matching operations on that value.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Indexer.createKeys(Schema schema,
ByteSequence value,
Collection<ByteString> keys)
Generates the set of index keys for an attribute.
|
S |
ExtendedResultLdapPromiseImpl.decodeResult(ExtendedResult result,
DecodeOptions options)
Decode an extended result.
|
| Modifier and Type | Method and Description |
|---|---|
<C extends Control> |
ChangeRecord.getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this request having an OID
corresponding to the provided control decoder.
|
Entry |
RejectedChangeRecordListener.handleDuplicateEntry(AddRequest change,
Entry existingEntry)
Invoked when an attempt was made to add an entry which already exists.
|
Entry |
RejectedChangeRecordListener.handleDuplicateEntry(ModifyDNRequest change,
Entry existingEntry,
Entry renamedEntry)
Invoked when an attempt was made to rename an entry which already exists.
|
void |
RejectedLDIFListener.handleMalformedRecord(long lineNumber,
List<String> lines,
LocalizableMessage reason)
Invoked when a record was rejected because it was malformed in some way
and could not be decoded.
|
void |
RejectedChangeRecordListener.handleRejectedChangeRecord(AddRequest change,
LocalizableMessage reason)
Invoked when an attempt to add an entry was rejected.
|
void |
RejectedChangeRecordListener.handleRejectedChangeRecord(DeleteRequest change,
LocalizableMessage reason)
Invoked when an attempt to delete an entry was rejected.
|
void |
RejectedChangeRecordListener.handleRejectedChangeRecord(ModifyDNRequest change,
LocalizableMessage reason)
Invoked when an attempt to rename an entry was rejected.
|
void |
RejectedChangeRecordListener.handleRejectedChangeRecord(ModifyRequest change,
LocalizableMessage reason)
Invoked when an attempt to modify an entry was rejected.
|
void |
RejectedLDIFListener.handleSchemaValidationFailure(long lineNumber,
List<String> lines,
List<LocalizableMessage> reasons)
Invoked when a record was rejected because it does not conform to the
schema and schema validation is enabled.
|
void |
RejectedLDIFListener.handleSchemaValidationWarning(long lineNumber,
List<String> lines,
List<LocalizableMessage> reasons)
Invoked when a record was not rejected but contained one or more schema
validation warnings.
|
void |
RejectedLDIFListener.handleSkippedRecord(long lineNumber,
List<String> lines,
LocalizableMessage reason)
Invoked when a record was skipped because it did not match filter
criteria defined by the reader.
|
boolean |
LDIFChangeRecordReader.hasNext()
Returns
true if this reader contains another change record,
blocking if necessary until either the next change record is available or
the end of the stream is reached. |
boolean |
LDIFEntryReader.hasNext()
Returns
true if this reader contains another entry, blocking if
necessary until either the next entry is available or the end of the
stream is reached. |
ChangeRecord |
LDIFChangeRecordReader.readChangeRecord()
Reads the next change record, blocking if necessary until a change record
is available.
|
Entry |
LDIFEntryReader.readEntry()
Reads the next entry, blocking if necessary until an entry is available.
|
Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.