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.ldapMessage; 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.BerValue; 026import org.apache.directory.api.asn1.ber.tlv.IntegerDecoder; 027import org.apache.directory.api.asn1.ber.tlv.IntegerDecoderException; 028import org.apache.directory.api.asn1.ber.tlv.TLV; 029import org.apache.directory.api.i18n.I18n; 030import org.apache.directory.api.ldap.codec.api.LdapMessageContainer; 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 to store the LdapMessage MessageID. 039 * <pre> 040 * LDAPMessage --> ... MessageId ... 041 * 042 * Checks that MessageId is in [0 .. 2147483647] and store the value in 043 * the LdapMessage Object 044 * 045 * (2147483647 = Integer.MAX_VALUE) 046 * The next state will be MESSAGE_ID_STATE 047 * 048 * The message ID will be temporarily stored in the container, because we can't store it 049 * into an object. 050 * </pre> 051 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 052 */ 053public class StoreMessageId extends GrammarAction<LdapMessageContainer<Message>> 054{ 055 /** The logger */ 056 private static final Logger LOG = LoggerFactory.getLogger( StoreMessageId.class ); 057 058 059 /** 060 * Instantiates a new action. 061 */ 062 public StoreMessageId() 063 { 064 super( "Store MessageID" ); 065 } 066 067 068 /** 069 * {@inheritDoc} 070 */ 071 @Override 072 public void action( LdapMessageContainer<Message> container ) throws DecoderException 073 { 074 // The current TLV should be a integer 075 // We get it and store it in MessageId 076 TLV tlv = container.getCurrentTLV(); 077 078 // The Length should not be null 079 if ( tlv.getLength() == 0 ) 080 { 081 LOG.error( I18n.err( I18n.ERR_05100_ZERO_LENGTH_MESSAGE_ID_NOT_ALLOWED ) ); 082 083 // This will generate a PROTOCOL_ERROR 084 throw new DecoderException( I18n.err( I18n.ERR_05101_NULL_MESSAGE_ID_NOT_ALLOWED ) ); 085 } 086 087 BerValue value = tlv.getValue(); 088 089 try 090 { 091 int messageId = IntegerDecoder.parse( value, 0, Integer.MAX_VALUE ); 092 093 container.setMessageId( messageId ); 094 095 if ( LOG.isDebugEnabled() ) 096 { 097 LOG.debug( I18n.msg( I18n.MSG_05102_LDAP_MESSAGE_ID_DECODED, messageId ) ); 098 } 099 } 100 catch ( IntegerDecoderException ide ) 101 { 102 LOG.error( I18n.err( I18n.ERR_05102_INVALID_MESSAGE_ID, Strings.dumpBytes( value.getData() ), ide 103 .getLocalizedMessage() ) ); 104 105 // This will generate a PROTOCOL_ERROR 106 throw new DecoderException( ide.getMessage(), ide ); 107 } 108 } 109}