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 *    https://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.codec.actions.request.modify;
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.i18n.I18n;
027import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
028import org.apache.directory.api.ldap.codec.api.ResponseCarryingException;
029import org.apache.directory.api.ldap.model.entry.Attribute;
030import org.apache.directory.api.ldap.model.entry.DefaultAttribute;
031import org.apache.directory.api.ldap.model.entry.ModificationOperation;
032import org.apache.directory.api.ldap.model.message.ModifyRequest;
033import org.apache.directory.api.ldap.model.message.ModifyResponseImpl;
034import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
035import org.apache.directory.api.util.Strings;
036import org.slf4j.Logger;
037import org.slf4j.LoggerFactory;
038
039
040/**
041 * The action used to store the ModificationRequest's attribute type
042 * <pre>
043 * ModifyRequest ::= [APPLICATION 6] SEQUENCE {
044 *     ...
045 *     modification SEQUENCE OF SEQUENCE {
046 *             ...
047 *         modification   AttributeTypeAndValues }
048 *
049 * AttributeTypeAndValues ::= SEQUENCE {
050 *     type AttributeDescription,
051 *     ...
052 * </pre>
053 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
054 */
055public class AddModifyRequestAttribute extends GrammarAction<LdapMessageContainer<ModifyRequest>>
056{
057    /** The logger */
058    private static final Logger LOG = LoggerFactory.getLogger( AddModifyRequestAttribute.class );
059
060    /**
061     * Instantiates a new action.
062     */
063    public AddModifyRequestAttribute()
064    {
065        super( "Store Modify request operation type" );
066    }
067
068
069    /**
070     * {@inheritDoc}
071     */
072    @Override
073    public void action( LdapMessageContainer<ModifyRequest> container ) throws DecoderException
074    {
075        ModifyRequest modifyRequest = container.getMessage();
076
077        TLV tlv = container.getCurrentTLV();
078
079        // Store the value. It can't be null
080        String type;
081
082        if ( tlv.getLength() == 0 )
083        {
084            String msg = I18n.err( I18n.ERR_05123_TYPE_CANT_BE_NULL );
085            LOG.error( msg );
086
087            ModifyResponseImpl response = new ModifyResponseImpl( modifyRequest.getMessageId() );
088            throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_ATTRIBUTE_SYNTAX,
089                modifyRequest.getName(), null );
090        }
091        else
092        {
093            type = Strings.utf8ToString( tlv.getValue().getData() );
094            Attribute currentAttribute = new DefaultAttribute( type );
095            container.setCurrentAttribute( currentAttribute );
096            container.getCurrentModification().setAttribute( currentAttribute );
097        }
098
099        // We can have an END transition if the operation was INCREMENT
100        if ( container.getCurrentModification().getOperation() == ModificationOperation.INCREMENT_ATTRIBUTE )
101        {
102            container.setGrammarEndAllowed( true );
103        }
104
105        if ( LOG.isDebugEnabled() )
106        {
107            LOG.debug( I18n.msg( I18n.MSG_05128_MODIFYING_TYPE, type ) );
108        }
109    }
110}