001/*
002 *   Licensed to the Apache Software Foundation (ASF) under one
003 *   or more contributor license agreements.  See the NOTICE file
004 *   distributed with this work for additional information
005 *   regarding copyright ownership.  The ASF licenses this file
006 *   to you under the Apache License, Version 2.0 (the
007 *   "License"); you may not use this file except in compliance
008 *   with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *   Unless required by applicable law or agreed to in writing,
013 *   software distributed under the License is distributed on an
014 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *   KIND, either express or implied.  See the License for the
016 *   specific language governing permissions and limitations
017 *   under the License.
018 *
019 */
020package org.apache.directory.shared.ldap.codec.api;
021
022
023import org.apache.directory.shared.asn1.DecoderException;
024import org.apache.directory.shared.ldap.model.message.ExtendedResponse;
025
026
027/**
028 * A factory which generates unsolicited server ExtendedResponses without 
029 * requiring an initiating client ExtendedRequest.
030 *
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 * @version $Rev$, $Date$
033 */
034public interface UnsolicitedResponseFactory<R extends ExtendedResponse>
035{
036    /**
037     * Gets the OID of the {@link ExtendedResponse} this factory generates.
038     *
039     * @return the extended response OID
040     */
041    String getOid();
042    
043    
044    /**
045     *  @return A new instance of the ExtendedResponse.
046     */
047    R newResponse( byte[] encodedValue ) throws DecoderException;
048
049
050    /**
051     * Decorates an existing extended operation response.
052     * 
053     * @param decoratedMessage the extended response to be decorated
054     * @return the decorated message
055     */
056    ExtendedResponseDecorator<R> decorate( ExtendedResponse decoratedMessage );
057}