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 * post-operation 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 PostOperationExtendedOperation 036 extends PostOperationOperation 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 * Retrieves the value for the request associated with this extended 051 * operation. 052 * 053 * @return The value for the request associated with this extended 054 * operation. 055 */ 056 ByteString getRequestValue(); 057 058 059 060 /** 061 * Retrieves the OID to include in the response to the client. 062 * 063 * @return The OID to include in the response to the client. 064 */ 065 String getResponseOID(); 066 067 068 069 /** 070 * Specifies the OID to include in the response to the client. 071 * 072 * @param responseOID The OID to include in the response to the 073 * client. 074 */ 075 void setResponseOID(String responseOID); 076 077 078 079 /** 080 * Retrieves the value to include in the response to the client. 081 * 082 * @return The value to include in the response to the client. 083 */ 084 ByteString getResponseValue(); 085 086 087 088 /** 089 * Specifies the value to include in the response to the client. 090 * 091 * @param responseValue The value to include in the response to 092 * the client. 093 */ 094 void setResponseValue(ByteString responseValue); 095} 096