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.request.compare; 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.exception.LdapInvalidDnException; 030import org.apache.directory.api.ldap.model.message.CompareRequest; 031import org.apache.directory.api.ldap.model.message.CompareResponseImpl; 032import org.apache.directory.api.ldap.model.message.ResultCodeEnum; 033import org.apache.directory.api.ldap.model.name.Dn; 034import org.apache.directory.api.util.Strings; 035import org.slf4j.Logger; 036import org.slf4j.LoggerFactory; 037 038 039/** 040 * The action used to store the Compare Request name 041 * <pre> 042 * CompareRequest ::= [APPLICATION 14] SEQUENCE { 043 * entry LDAPDN, 044 * ... 045 * </pre> 046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 047 */ 048public class StoreCompareRequestEntryName extends GrammarAction<LdapMessageContainer<CompareRequest>> 049{ 050 /** The logger */ 051 private static final Logger LOG = LoggerFactory.getLogger( StoreCompareRequestEntryName.class ); 052 053 /** 054 * Instantiates a new action. 055 */ 056 public StoreCompareRequestEntryName() 057 { 058 super( "Store CompareRequest entry Name" ); 059 } 060 061 062 /** 063 * {@inheritDoc} 064 */ 065 @Override 066 public void action( LdapMessageContainer<CompareRequest> container ) throws DecoderException 067 { 068 CompareRequest compareRequest = container.getMessage(); 069 070 // Get the Value and store it in the CompareRequest 071 TLV tlv = container.getCurrentTLV(); 072 073 // We have to handle the special case of a 0 length matched Dn 074 if ( tlv.getLength() == 0 ) 075 { 076 // This will generate a PROTOCOL_ERROR 077 throw new DecoderException( I18n.err( I18n.ERR_05119_NULL_ENTRY ) ); 078 } 079 else 080 { 081 byte[] dnBytes = tlv.getValue().getData(); 082 String dnStr = Strings.utf8ToString( dnBytes ); 083 084 try 085 { 086 Dn entry = new Dn( dnStr ); 087 compareRequest.setName( entry ); 088 } 089 catch ( LdapInvalidDnException ine ) 090 { 091 String msg = I18n.err( I18n.ERR_05113_INVALID_DN, dnStr, Strings.dumpBytes( dnBytes ) ); 092 LOG.error( I18n.err( I18n.ERR_05114_ERROR_MESSAGE, msg, ine.getMessage() ) ); 093 094 CompareResponseImpl response = new CompareResponseImpl( compareRequest.getMessageId() ); 095 throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_DN_SYNTAX, 096 Dn.EMPTY_DN, ine ); 097 } 098 } 099 100 if ( LOG.isDebugEnabled() ) 101 { 102 LOG.debug( I18n.msg( I18n.MSG_05123_COMPARING_DN, compareRequest.getName() ) ); 103 } 104 } 105}