001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2006-2008 Sun Microsystems, Inc.
015 * Portions Copyright 2014-2015 ForgeRock AS.
016 */
017package org.opends.server.types.operation;
018
019
020
021import org.forgerock.opendj.ldap.ByteString;
022
023
024/**
025 * This class defines a set of methods that are available for use by
026 * pre-parse plugins for extended operations.  Note that this
027 * interface is intended only to define an API for use by plugins and
028 * is not intended to be implemented by any custom classes.
029 */
030@org.opends.server.types.PublicAPI(
031     stability=org.opends.server.types.StabilityLevel.UNCOMMITTED,
032     mayInstantiate=false,
033     mayExtend=false,
034     mayInvoke=true)
035public interface PreParseExtendedOperation
036       extends PreParseOperation
037{
038  /**
039   * Retrieves the OID for the request associated with this extended
040   * operation.
041   *
042   * @return  The OID for the request associated with this extended
043   *          operation.
044   */
045  String getRequestOID();
046
047
048
049  /**
050   * Specifies the OID for the request associated with this extended
051   * operation.
052   *
053   * @param  requestOID  The OID for the request associated with this
054   *                     extended operation.
055   */
056  void setRequestOID(String requestOID);
057
058
059
060  /**
061   * Retrieves the value for the request associated with this extended
062   * operation.
063   *
064   * @return  The value for the request associated with this extended
065   *          operation.
066   */
067  ByteString getRequestValue();
068
069
070
071  /**
072   * Specifies the value for the request associated with this extended
073   * operation.
074   *
075   * @param  requestValue  The value for the request associated with
076   *                       this extended operation.
077   */
078  void setRequestValue(ByteString requestValue);
079
080
081
082  /**
083   * Specifies the OID to include in the response to the client.
084   *
085   * @param  responseOID  The OID to include in the response to the
086   *                      client.
087   */
088  void setResponseOID(String responseOID);
089
090
091
092  /**
093   * Specifies the value to include in the response to the client.
094   *
095   * @param  responseValue  The value to include in the response to
096   *                        the client.
097   */
098  void setResponseValue(ByteString responseValue);
099}
100