LDAPPostReadResponseControl.java revision 94e9037522922b67e8af412b4cfe476f5e991118
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
* Portions Copyright 2014-2015 ForgeRock AS
*/
/**
* This class implements the post-read response control as defined in RFC 4527.
* This control holds the search result entry representing the state of the
* entry immediately before an add, modify, or modify DN operation.
*/
public class LDAPPostReadResponseControl
extends Control
{
/**
* ControlDecoder implementation to decode this control from a ByteString.
*/
private static final class Decoder
implements ControlDecoder<LDAPPostReadResponseControl>
{
/**
* {@inheritDoc}
*/
throws DirectoryException
{
{
}
try
{
}
catch (LDAPException le)
{
le);
}
}
{
return OID_LDAP_READENTRY_POSTREAD;
}
}
/**
* The Control Decoder that can be used to decode this control.
*/
new Decoder();
// The search result entry to include in the response control.
private SearchResultEntry searchEntry;
/**
* Creates a new instance of this LDAP post-read response control with the
* provided information.
*
* @param searchEntry The search result entry to include in the response
* control.
*/
{
this(false, searchEntry);
}
/**
* Creates a new instance of this LDAP post-read response control with the
* provided information.
*
* @param isCritical Indicates whether support for this control should be
* considered a critical part of the server processing.
* @param searchEntry The search result entry to include in the response
* control.
*/
public LDAPPostReadResponseControl(boolean isCritical,
{
super(OID_LDAP_READENTRY_POSTREAD, isCritical);
this.searchEntry = searchEntry;
}
/**
* Writes this control's value to an ASN.1 writer. The value (if any) must be
* written as an ASN1OctetString.
*
* @param writer The ASN.1 output stream to write to.
* @throws IOException If a problem occurs while writing to the stream.
*/
}
/**
* Retrieves the search result entry associated with this post-read response
* control.
*
* @return The search result entry associated with this post-read response
* control.
*/
public SearchResultEntry getSearchEntry()
{
return searchEntry;
}
/**
* Appends a string representation of this LDAP post-read response control to
* the provided buffer.
*
* @param buffer The buffer to which the information should be appended.
*/
{
}
}