ldap/codec/core/src/main/java/org/apache/directory/api/ldap/codec/api/ControlFactory.java

/*
 *   Licensed to the Apache Software Foundation (ASF) under one
 *   or more contributor license agreements.  See the NOTICE file
 *   distributed with this work for additional information
 *   regarding copyright ownership.  The ASF licenses this file
 *   to you under the Apache License, Version 2.0 (the
 *   "License"); you may not use this file except in compliance
 *   with the License.  You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing,
 *   software distributed under the License is distributed on an
 *   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *   KIND, either express or implied.  See the License for the
 *   specific language governing permissions and limitations
 *   under the License.
 *
 */
package org.apache.directory.api.ldap.codec.api;


import org.apache.directory.api.asn1.DecoderException;
import org.apache.directory.api.asn1.util.Asn1Buffer;
import org.apache.directory.api.ldap.model.message.Control;


/**
 * Implementors of new codec control extensions must implement a factory using
 * this factory interface, Factory implementations for specific controls are
 * then registered with the codec and used by the codec to encode and decode
 * those controls.
 *
 * @param <C> The Control to create
 *
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public interface ControlFactory<C extends Control>
{
    /**
     * @return The OID of the Control this factory creates.
     */
    String getOid();


    /**
     * Creates and returns a version of the Control.
     *
     * @return The {@link CodecControl} decorated version of the Control.
     */
    Control newControl();


    /**
     * Encode the value part of the control.
     *
     * @param buffer The buffer into which to put the encoded value
     * @param control The control to encode
     */
    void encodeValue( Asn1Buffer buffer, Control control );
    
    


    /**
     * Decode a Control's value. It will feed the Control.
     * 
     *  @param container The Asn1Container containing the control to feed
     *  @param control The control to feed
     *  @param controlBytes The data to decode
     *  @throws DecoderException If the value can't be decoded
     */
    void decodeValue( ControlContainer container, Control control, byte[] controlBytes ) throws DecoderException;
    
    
    /**
     * Decode a Control's value. It will feed the Control.
     * 
     *  @param control The control to feed
     *  @param controlBytes The data to decode
     *  @throws DecoderException If the value can't be decoded
     */
    void decodeValue( Control control, byte[] controlBytes ) throws DecoderException;
}