PostResponseExtendedOperation.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
* or http://forgerock.org/license/CDDLv1.0.html.
* 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
*/
package org.opends.server.types.operation;
import org.forgerock.opendj.ldap.ByteString;
/**
* This class defines a set of methods that are available for use by
* post-response plugins for extended operations. Note that this
* interface is intended only to define an API for use by plugins and
* is not intended to be implemented by any custom classes.
*/
@org.opends.server.types.PublicAPI(
stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
mayInstantiate=false,
mayExtend=false,
mayInvoke=true)
public interface PostResponseExtendedOperation
extends PostOperationOperation
{
/**
* Retrieves the OID for the request associated with this extended
* operation.
*
* @return The OID for the request associated with this extended
* operation.
*/
String getRequestOID();
/**
* Retrieves the value for the request associated with this extended
* operation.
*
* @return The value for the request associated with this extended
* operation.
*/
ByteString getRequestValue();
/**
* Retrieves the OID to include in the response to the client.
*
* @return The OID to include in the response to the client.
*/
String getResponseOID();
/**
* Retrieves the value to include in the response to the client.
*
* @return The value to include in the response to the client.
*/
ByteString getResponseValue();
}