001 /* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2006-2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.types.operation; 028 029 030 031 import org.opends.server.protocols.asn1.ASN1OctetString; 032 033 034 035 /** 036 * This class defines a set of methods that are available for use by 037 * pre-operation plugins for extended operations. Note that this 038 * interface is intended only to define an API for use by plugins and 039 * is not intended to be implemented by any custom classes. 040 */ 041 @org.opends.server.types.PublicAPI( 042 stability=org.opends.server.types.StabilityLevel.UNCOMMITTED, 043 mayInstantiate=false, 044 mayExtend=false, 045 mayInvoke=true) 046 public interface PreOperationExtendedOperation 047 extends PreOperationOperation 048 { 049 /** 050 * Retrieves the OID for the request associated with this extended 051 * operation. 052 * 053 * @return The OID for the request associated with this extended 054 * operation. 055 */ 056 public String getRequestOID(); 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 public ASN1OctetString getRequestValue(); 068 069 070 071 /** 072 * Specifies the OID to include in the response to the client. 073 * 074 * @param responseOID The OID to include in the response to the 075 * client. 076 */ 077 public void setResponseOID(String responseOID); 078 079 080 081 /** 082 * Specifies the value to include in the response to the client. 083 * 084 * @param responseValue The value to include in the response to 085 * the client. 086 */ 087 public void setResponseValue(ASN1OctetString responseValue); 088 } 089