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