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.api.ldap.extras.extended.ads_impl.endTransaction.controls.actions;
021
022
023import org.apache.directory.api.asn1.DecoderException;
024import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
025import org.apache.directory.api.asn1.ber.tlv.TLV;
026import org.apache.directory.api.asn1.util.Oid;
027import org.apache.directory.api.i18n.I18n;
028import org.apache.directory.api.ldap.codec.api.ControlFactory;
029import org.apache.directory.api.ldap.extras.extended.ads_impl.endTransaction.controls.ControlsContainer;
030import org.apache.directory.api.ldap.model.message.Control;
031import org.apache.directory.api.util.Strings;
032import org.slf4j.Logger;
033import org.slf4j.LoggerFactory;
034
035
036/**
037 * The action used add a new control. We store its OID.
038 * <pre>
039 * Control ::= SEQUENCE {
040 *     controlType             LDAPOID,
041 *     ...
042 * </pre>
043 *
044 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
045 */
046public class AddControl extends GrammarAction<ControlsContainer>
047{
048    /** The logger */
049    private static final Logger LOG = LoggerFactory.getLogger( AddControl.class );
050
051    /**
052     * Instantiates a new AddControl action.
053     */
054    public AddControl()
055    {
056        super( "Add a new control" );
057    }
058
059
060    /**
061     * {@inheritDoc}
062     */
063    @Override
064    public void action( ControlsContainer container ) throws DecoderException
065    {
066        TLV tlv = container.getCurrentTLV();
067
068        // Store the type
069        // We have to handle the special case of a 0 length OID
070        if ( tlv.getLength() == 0 )
071        {
072            String msg = I18n.err( I18n.ERR_08214_NULL_OID );
073            LOG.error( msg );
074
075            // This will generate a PROTOCOL_ERROR
076            throw new DecoderException( msg );
077        }
078
079        byte[] value = tlv.getValue().getData();
080        String oidValue = Strings.asciiBytesToString( value );
081
082        // The OID is encoded as a String, not an Object Id
083        if ( !Oid.isOid( oidValue ) )
084        {
085            String msg = I18n.err( I18n.ERR_08215_INVALID_CONTROL_OID, oidValue );
086            LOG.error( msg );
087
088            // This will generate a PROTOCOL_ERROR
089            throw new DecoderException( msg );
090        }
091
092        ControlFactory<?> factory = container.getLdapCodecService().getResponseControlFactories().get( oidValue );
093        container.setFactory( factory );
094        Control control = factory.newControl();
095
096        container.setCurrentControl( control );
097        container.addControl( control );
098
099        // We can have an END transition
100        container.setGrammarEndAllowed( true );
101
102        if ( LOG.isDebugEnabled() )
103        {
104            LOG.debug( I18n.msg( I18n.MSG_08201_CONTROL_OID, oidValue ) );
105        }
106    }
107}