IntermediateResponse.java revision 998747bfaaa3c6b28bbfaf0e282e6c0ccbf46bc0
/*
* 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 defines a data structure for holding information that
* may be sent to the client in the form of an intermediate response.
*/
mayInstantiate=true,
mayExtend=false,
mayInvoke=true)
public final class IntermediateResponse
{
// The value for this intermediate response.
private ByteString value;
// The set of controls for this intermediate response.
// The operation with which this intermediate response is
// associated.
// The OID for this intermediate response.
/**
* Creates a new intermediate response with the provided
* information.
*
* @param operation The operation with which this intermediate
* response is associated.
* @param oid The OID for this intermediate response.
* @param value The value for this intermediate response.
* @param controls The set of controls to for this intermediate
* response.
*/
{
{
}
else
{
}
}
/**
* Retrieves the operation with which this intermediate response
* message is associated.
*
* @return The operation with which this intermediate response
* message is associated.
*/
public Operation getOperation()
{
return operation;
}
/**
* Retrieves the OID for this intermediate response.
*
* @return The OID for this intermediate response, or
* <CODE>null</CODE> if there is none.
*/
{
return oid;
}
/**
* Specifies the OID for this intermediate response.
*
* @param oid The OID for this intermediate response.
*/
{
}
/**
* Retrieves the value for this intermediate response.
*
* @return The value for this intermediate response, or
* <CODE>null</CODE> if there is none.
*/
public ByteString getValue()
{
return value;
}
/**
* Specifies the value for this intermediate response.
*
* @param value The value for this intermediate response.
*/
{
}
/**
* Retrieves the set of controls for this intermediate response.
* The contents of the list may be altered by intermediate response
* plugins.
*
* @return The set of controls for this intermediate response.
*/
{
return controls;
}
/**
* Retrieves a string representation of this intermediate response.
*
* @return A string representation of this intermediate response.
*/
{
}
/**
* Appends a string representation of this intermediate response to
* the provided buffer.
*
* @param buffer The buffer to which the information should be
* appended.
*/
{
{
{
}
}
}
}