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