Package org.forgerock.opendj.ldap.responses

Class Responses

java.lang.Object

org.forgerock.opendj.ldap.responses.Responses

public final class Responses
extends Object

This class contains various methods for creating and manipulating responses.

All copy constructors of the form copyOfXXXResult perform deep copies of their response parameter. More specifically, any controls, modifications, and attributes contained within the response will be duplicated.

Similarly, all unmodifiable views of responses returned by methods of the form unmodifiableXXXResult return deep unmodifiable views of their response parameter. More specifically, any controls, modifications, and attributes contained within the returned response will be unmodifiable.

Method Summary

Modifier and Type	Method	Description
static BindResult	copyOfBindResult(BindResult result)	Creates a new bind result that is an exact copy of the provided result.
static CompareResult	copyOfCompareResult(CompareResult result)	Creates a new compare result that is an exact copy of the provided result.
static GenericExtendedResult	copyOfGenericExtendedResult(GenericExtendedResult result)	Creates a new generic extended result that is an exact copy of the provided result.
static GenericIntermediateResponse	copyOfGenericIntermediateResponse(GenericIntermediateResponse result)	Creates a new generic intermediate response that is an exact copy of the provided response.
static PasswordModifyExtendedResult	copyOfPasswordModifyExtendedResult(PasswordModifyExtendedResult result)	Creates a new password modify extended result that is an exact copy of the provided result.
static Result	copyOfResult(Result result)	Creates a new result that is an exact copy of the provided result.
static SearchResultEntry	copyOfSearchResultEntry(SearchResultEntry entry)	Creates a new search result entry that is an exact copy of the provided result.
static SearchResultReference	copyOfSearchResultReference(SearchResultReference reference)	Creates a new search result reference that is an exact copy of the provided result.
static WhoAmIExtendedResult	copyOfWhoAmIExtendedResult(WhoAmIExtendedResult result)	Creates a new who am I extended result that is an exact copy of the provided result.
static BindResult	newBindResult(ResultCode resultCode)	Creates a new bind result using the provided result code.
static CompareResult	newCompareResult(ResultCode resultCode)	Creates a new compare result using the provided result code.
static GenericExtendedResult	newGenericExtendedResult(ResultCode resultCode)	Creates a new generic extended result using the provided result code.
static GenericIntermediateResponse	newGenericIntermediateResponse()	Creates a new generic intermediate response with no name or value.
static GenericIntermediateResponse	newGenericIntermediateResponse(String responseName, Object responseValue)	Creates a new generic intermediate response using the provided response name and value.
static PasswordModifyExtendedResult	newPasswordModifyExtendedResult(ResultCode resultCode)	Creates a new password modify extended result using the provided result code, and no generated password.
static Result	newResult(ResultCode resultCode)	Creates a new result using the provided result code.
static SearchResultEntry	newSearchResultEntry(String name)	Creates a new search result entry using the provided distinguished name decoded using the default schema.
static SearchResultEntry	newSearchResultEntry(String... ldifLines)	Creates a new search result entry using the provided lines of LDIF decoded using the default schema.
static SearchResultEntry	newSearchResultEntry(DN name)	Creates a new search result entry using the provided distinguished name.
static SearchResultEntry	newSearchResultEntry(Entry entry)	Creates a new search result entry backed by the provided entry.
static SearchResultReference	newSearchResultReference(String uri)	Creates a new search result reference using the provided continuation reference URI.
static WhoAmIExtendedResult	newWhoAmIExtendedResult(ResultCode resultCode)	Creates a new who am I extended result with the provided result code and no authorization ID.
static BindResult	unmodifiableBindResult(BindResult result)	Creates an unmodifiable bind result using the provided response.
static CompareResult	unmodifiableCompareResult(CompareResult result)	Creates an unmodifiable compare result using the provided response.
static GenericExtendedResult	unmodifiableGenericExtendedResult(GenericExtendedResult result)	Creates an unmodifiable generic extended result using the provided response.
static GenericIntermediateResponse	unmodifiableGenericIntermediateResponse(GenericIntermediateResponse response)	Creates an unmodifiable generic intermediate response using the provided response.
static PasswordModifyExtendedResult	unmodifiablePasswordModifyExtendedResult(PasswordModifyExtendedResult result)	Creates an unmodifiable password modify extended result using the provided response.
static Result	unmodifiableResult(Result result)	Creates an unmodifiable result using the provided response.
static SearchResultEntry	unmodifiableSearchResultEntry(SearchResultEntry entry)	Creates an unmodifiable search result entry using the provided response.
static SearchResultReference	unmodifiableSearchResultReference(SearchResultReference reference)	Creates an unmodifiable search result reference using the provided response.
static WhoAmIExtendedResult	unmodifiableWhoAmIExtendedResult(WhoAmIExtendedResult result)	Creates an unmodifiable who am I extended result using the provided response.

Methods inherited from class java.lang.Object

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

Method Details

copyOfBindResult

public static BindResult copyOfBindResult(BindResult result)

Creates a new bind result that is an exact copy of the provided result.

Parameters:

result - The bind result to be copied.

Returns:

The new bind result.

Throws:

NullPointerException - If result was null.

copyOfCompareResult

public static CompareResult copyOfCompareResult(CompareResult result)

Creates a new compare result that is an exact copy of the provided result.

Parameters:

result - The compare result to be copied.

Returns:

The new compare result.

Throws:

NullPointerException - If result was null.

copyOfGenericExtendedResult

public static GenericExtendedResult copyOfGenericExtendedResult(GenericExtendedResult result)

Creates a new generic extended result that is an exact copy of the provided result.

Parameters:

result - The generic extended result to be copied.

Returns:

The new generic extended result.

Throws:

NullPointerException - If result was null.

copyOfGenericIntermediateResponse

public static GenericIntermediateResponse copyOfGenericIntermediateResponse(GenericIntermediateResponse result)

Creates a new generic intermediate response that is an exact copy of the provided response.

Parameters:

result - The generic intermediate response to be copied.

Returns:

The new generic intermediate response.

Throws:

NullPointerException - If result was null.

copyOfPasswordModifyExtendedResult

public static PasswordModifyExtendedResult copyOfPasswordModifyExtendedResult(PasswordModifyExtendedResult result)

Creates a new password modify extended result that is an exact copy of the provided result.

Parameters:

result - The password modify extended result to be copied.

Returns:

The new password modify extended result.

Throws:

NullPointerException - If result was null.

copyOfResult

public static Result copyOfResult(Result result)

Creates a new result that is an exact copy of the provided result.

Parameters:

result - The result to be copied.

Returns:

The new result.

Throws:

NullPointerException - If result was null.

copyOfSearchResultEntry

public static SearchResultEntry copyOfSearchResultEntry(SearchResultEntry entry)

Creates a new search result entry that is an exact copy of the provided result.

Parameters:

entry - The search result entry to be copied.

Returns:

The new search result entry.

Throws:

NullPointerException - If entry was null.

copyOfSearchResultReference

public static SearchResultReference copyOfSearchResultReference(SearchResultReference reference)

Creates a new search result reference that is an exact copy of the provided result.

Parameters:

reference - The search result reference to be copied.

Returns:

The new search result reference.

Throws:

NullPointerException - If reference was null.

copyOfWhoAmIExtendedResult

public static WhoAmIExtendedResult copyOfWhoAmIExtendedResult(WhoAmIExtendedResult result)

Creates a new who am I extended result that is an exact copy of the provided result.

Parameters:

result - The who am I result to be copied.

Returns:

The new who am I extended result.

Throws:

NullPointerException - If result was null .

newBindResult

public static BindResult newBindResult(ResultCode resultCode)

Creates a new bind result using the provided result code.

Parameters:

resultCode - The result code.

Returns:

The new bind result.

Throws:

NullPointerException - If resultCode was null.

newCompareResult

public static CompareResult newCompareResult(ResultCode resultCode)

Creates a new compare result using the provided result code.

Parameters:

resultCode - The result code.

Returns:

The new compare result.

Throws:

NullPointerException - If resultCode was null.

newGenericExtendedResult

public static GenericExtendedResult newGenericExtendedResult(ResultCode resultCode)

Creates a new generic extended result using the provided result code.

Parameters:

resultCode - The result code.

Returns:

The new generic extended result.

Throws:

NullPointerException - If resultCode was null.

newGenericIntermediateResponse

public static GenericIntermediateResponse newGenericIntermediateResponse()

Creates a new generic intermediate response with no name or value.

Returns:

The new generic intermediate response.

newGenericIntermediateResponse

public static GenericIntermediateResponse newGenericIntermediateResponse(String responseName,
 Object responseValue)

Creates a new generic intermediate response using the provided response name and value.

If the response value is not an instance of ByteString then it will be converted using the ByteString.valueOfObject(Object) method.

Parameters:

responseName - The dotted-decimal representation of the unique OID corresponding to this intermediate response, which may be null indicating that none was provided.

responseValue - The response value associated with this generic intermediate response, which may be null indicating that none was provided.

Returns:

The new generic intermediate response.

newPasswordModifyExtendedResult

public static PasswordModifyExtendedResult newPasswordModifyExtendedResult(ResultCode resultCode)

Creates a new password modify extended result using the provided result code, and no generated password.

Parameters:

resultCode - The result code.

Returns:

The new password modify extended result.

Throws:

NullPointerException - If resultCode was null.

newResult

public static Result newResult(ResultCode resultCode)

Creates a new result using the provided result code.

Parameters:

resultCode - The result code.

Returns:

The new result.

Throws:

NullPointerException - If resultCode was null.

newSearchResultEntry

public static SearchResultEntry newSearchResultEntry(DN name)

Creates a new search result entry using the provided distinguished name.

Parameters:

name - The distinguished name of the entry.

Returns:

The new search result entry.

Throws:

NullPointerException - If name was null.

newSearchResultEntry

public static SearchResultEntry newSearchResultEntry(Entry entry)

Creates a new search result entry backed by the provided entry. Modifications made to entry will be reflected in the returned search result entry. The returned search result entry supports updates to its list of controls, as well as updates to the name and attributes if the underlying entry allows.

Parameters:

entry - The entry.

Returns:

The new search result entry.

Throws:

NullPointerException - If entry was null .

newSearchResultEntry

public static SearchResultEntry newSearchResultEntry(String name)

Creates a new search result entry using the provided distinguished name decoded using the default schema.

Parameters:

name - The distinguished name of the entry.

Returns:

The new search result entry.

Throws:

org.forgerock.i18n.LocalizedIllegalArgumentException - If name could not be decoded using the default schema.

NullPointerException - If name was null.

newSearchResultEntry

public static SearchResultEntry newSearchResultEntry(String... ldifLines)

Creates a new search result entry using the provided lines of LDIF decoded using the default schema.

Parameters:

ldifLines - Lines of LDIF containing an LDIF add change record or an LDIF entry record.

Returns:

The new search result entry.

Throws:

org.forgerock.i18n.LocalizedIllegalArgumentException - If ldifLines was empty, or contained invalid LDIF, or could not be decoded using the default schema.

NullPointerException - If ldifLines was null .

newSearchResultReference

public static SearchResultReference newSearchResultReference(String uri)

Creates a new search result reference using the provided continuation reference URI.

Parameters:

uri - The first continuation reference URI to be added to this search result reference.

Returns:

The new search result reference.

Throws:

NullPointerException - If uri was null.

newWhoAmIExtendedResult

public static WhoAmIExtendedResult newWhoAmIExtendedResult(ResultCode resultCode)

Creates a new who am I extended result with the provided result code and no authorization ID.

Parameters:

resultCode - The result code.

Returns:

The new who am I extended result.

Throws:

NullPointerException - If resultCode was null .

unmodifiableBindResult

public static BindResult unmodifiableBindResult(BindResult result)

Creates an unmodifiable bind result using the provided response.

Parameters:

result - The bind result to be copied.

Returns:

The unmodifiable bind result.

Throws:

NullPointerException - If result was null.

unmodifiableCompareResult

public static CompareResult unmodifiableCompareResult(CompareResult result)

Creates an unmodifiable compare result using the provided response.

Parameters:

result - The compare result to be copied.

Returns:

The unmodifiable compare result.

Throws:

NullPointerException - If result was null.

unmodifiableGenericExtendedResult

public static GenericExtendedResult unmodifiableGenericExtendedResult(GenericExtendedResult result)

Creates an unmodifiable generic extended result using the provided response.

Parameters:

result - The generic extended result to be copied.

Returns:

The unmodifiable generic extended result.

Throws:

NullPointerException - If result was null.

unmodifiableGenericIntermediateResponse

public static GenericIntermediateResponse unmodifiableGenericIntermediateResponse(GenericIntermediateResponse response)

Creates an unmodifiable generic intermediate response using the provided response.

Parameters:

response - The generic intermediate response to be copied.

Returns:

The unmodifiable generic intermediate response.

Throws:

NullPointerException - If response was null.

unmodifiablePasswordModifyExtendedResult

public static PasswordModifyExtendedResult unmodifiablePasswordModifyExtendedResult(PasswordModifyExtendedResult result)

Creates an unmodifiable password modify extended result using the provided response.

Parameters:

result - The password modify extended result to be copied.

Returns:

The unmodifiable password modify extended result.

Throws:

NullPointerException - If result was null.

unmodifiableResult

public static Result unmodifiableResult(Result result)

Creates an unmodifiable result using the provided response.

Parameters:

result - The result to be copied.

Returns:

The unmodifiable result.

Throws:

NullPointerException - If result was null.

unmodifiableSearchResultEntry

public static SearchResultEntry unmodifiableSearchResultEntry(SearchResultEntry entry)

Creates an unmodifiable search result entry using the provided response.

Parameters:

entry - The search result entry to be copied.

Returns:

The unmodifiable search result entry.

Throws:

NullPointerException - If entry was null.

unmodifiableSearchResultReference

public static SearchResultReference unmodifiableSearchResultReference(SearchResultReference reference)

Creates an unmodifiable search result reference using the provided response.

Parameters:

reference - The search result reference to be copied.

Returns:

The unmodifiable search result reference.

Throws:

NullPointerException - If searchResultReference was null.

unmodifiableWhoAmIExtendedResult

public static WhoAmIExtendedResult unmodifiableWhoAmIExtendedResult(WhoAmIExtendedResult result)

Creates an unmodifiable who am I extended result using the provided response.

Parameters:

result - The who am I result to be copied.

Returns:

The unmodifiable who am I extended result.

Throws:

NullPointerException - If result was null .