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