b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson/*
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * CDDL HEADER START
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson *
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * The contents of this file are subject to the terms of the
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Common Development and Distribution License, Version 1.0 only
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * (the "License"). You may not use this file except in compliance
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * with the License.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson *
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * or http://forgerock.org/license/CDDLv1.0.html.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * See the License for the specific language governing permissions
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * and limitations under the License.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson *
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * When distributing Covered Code, include this CDDL HEADER in each
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * file and include the License file at legal-notices/CDDLv1_0.txt.
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * If applicable, add the following below this CDDL HEADER, with the
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * fields enclosed by brackets "[]" replaced with your own identifying
8cf870d281dc8c242f083d14dfef05f24aa5fceeJnRouvignac * information:
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Portions Copyright [yyyy] [name of copyright owner]
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson *
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * CDDL HEADER END
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson *
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson *
a395dd575518d9e5280fc5d5d5ef47c61b174647ludovicp * Copyright 2006-2008 Sun Microsystems, Inc.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson */
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilsonpackage org.opends.server.types.operation;
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
7185b49f58c4cdb16d035ecc45e38ec9b1cd9bd0matthew_swiftimport org.opends.server.types.ByteString;
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson/**
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * This class defines a set of methods that are available for use by
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * pre-operation plugins for extended operations. Note that this
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * interface is intended only to define an API for use by plugins and
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * is not intended to be implemented by any custom classes.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson */
8d7126a8f999e88851c7dd851a17c27cb6d2ec3fneil_a_wilson@org.opends.server.types.PublicAPI(
8d7126a8f999e88851c7dd851a17c27cb6d2ec3fneil_a_wilson stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
8d7126a8f999e88851c7dd851a17c27cb6d2ec3fneil_a_wilson mayInstantiate=false,
8d7126a8f999e88851c7dd851a17c27cb6d2ec3fneil_a_wilson mayExtend=false,
8d7126a8f999e88851c7dd851a17c27cb6d2ec3fneil_a_wilson mayInvoke=true)
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilsonpublic interface PreOperationExtendedOperation
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson extends PreOperationOperation
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson{
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson /**
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves the OID for the request associated with this extended
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * operation.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson *
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return The OID for the request associated with this extended
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * operation.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson */
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson public String getRequestOID();
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson /**
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Retrieves the value for the request associated with this extended
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * operation.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson *
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @return The value for the request associated with this extended
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * operation.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson */
7185b49f58c4cdb16d035ecc45e38ec9b1cd9bd0matthew_swift public ByteString getRequestValue();
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson /**
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Specifies the OID to include in the response to the client.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson *
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @param responseOID The OID to include in the response to the
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * client.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson */
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson public void setResponseOID(String responseOID);
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson /**
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * Specifies the value to include in the response to the client.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson *
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * @param responseValue The value to include in the response to
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson * the client.
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson */
7185b49f58c4cdb16d035ecc45e38ec9b1cd9bd0matthew_swift public void setResponseValue(ByteString responseValue);
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson}
b4851fc75ef4634840dcbadec085d586d36b434dneil_a_wilson