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 2010 Sun Microsystems, Inc. 025 */ 026 027package org.forgerock.opendj.ldap.requests; 028 029import org.forgerock.opendj.ldap.DecodeException; 030import org.forgerock.opendj.ldap.DecodeOptions; 031import org.forgerock.opendj.ldap.responses.ExtendedResult; 032 033/** 034 * A factory interface for decoding a generic extended request as an extended 035 * request of specific type. 036 * 037 * @param <R> 038 * The type of extended request. 039 * @param <S> 040 * The type of result. 041 */ 042public interface ExtendedRequestDecoder<R extends ExtendedRequest<S>, S extends ExtendedResult> { 043 /** 044 * Decodes the provided extended operation request as an 045 * {@code ExtendedRequest} of type {@code R}. 046 * 047 * @param request 048 * The extended operation request to be decoded. 049 * @param options 050 * The set of decode options which should be used when decoding 051 * the extended operation request. 052 * @return The decoded extended operation request. 053 * @throws DecodeException 054 * If the provided extended operation request could not be 055 * decoded. For example, if the request name was wrong, or if 056 * the request value was invalid. 057 */ 058 R decodeExtendedRequest(ExtendedRequest<?> request, DecodeOptions options) 059 throws DecodeException; 060 061}