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 */
020 package org.apache.directory.shared.ldap.codec.actions;
021
022
023 import org.apache.directory.shared.asn1.ber.IAsn1Container;
024 import org.apache.directory.shared.asn1.ber.grammar.GrammarAction;
025 import org.apache.directory.shared.asn1.ber.tlv.TLV;
026 import org.apache.directory.shared.asn1.codec.DecoderException;
027 import org.apache.directory.shared.i18n.I18n;
028 import org.apache.directory.shared.ldap.codec.LdapMessageContainer;
029 import org.apache.directory.shared.ldap.codec.LdapResponseCodec;
030 import org.apache.directory.shared.ldap.codec.LdapResultCodec;
031 import org.apache.directory.shared.ldap.exception.LdapInvalidDnException;
032 import org.apache.directory.shared.ldap.message.ResultCodeEnum;
033 import org.apache.directory.shared.ldap.name.DN;
034 import org.apache.directory.shared.ldap.util.StringTools;
035 import org.slf4j.Logger;
036 import org.slf4j.LoggerFactory;
037
038
039 /**
040 * The action used to set the LdapResult matched DN.
041 *
042 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
043 * @version $Rev$, $Date$,
044 */
045 public class MatchedDNAction extends GrammarAction
046 {
047 /** The logger */
048 private static final Logger log = LoggerFactory.getLogger( MatchedDNAction.class );
049
050 /** Speedup for logs */
051 private static final boolean IS_DEBUG = log.isDebugEnabled();
052
053 public MatchedDNAction()
054 {
055 super( "Store matched DN" );
056 }
057
058 /**
059 * The initialization action
060 */
061 public void action( IAsn1Container container ) throws DecoderException
062 {
063 LdapMessageContainer ldapMessageContainer = ( LdapMessageContainer ) container;
064 LdapResponseCodec response = ldapMessageContainer.getLdapResponse();
065 LdapResultCodec ldapResult = response.getLdapResult();
066
067 // Get the Value and store it in the BindResponse
068 TLV tlv = ldapMessageContainer.getCurrentTLV();
069
070 // We have to handle the special case of a 0 length matched
071 // DN
072 if ( tlv.getLength() == 0 )
073 {
074 ldapResult.setMatchedDN( DN.EMPTY_DN );
075 }
076 else
077 {
078 // A not null matchedDN is valid for resultCodes
079 // NoSuchObject, AliasProblem, InvalidDNSyntax and
080 // AliasDreferencingProblem.
081 ResultCodeEnum resultCode = ldapResult.getResultCode();
082
083 switch ( resultCode )
084 {
085 case NO_SUCH_OBJECT :
086 case ALIAS_PROBLEM :
087 case INVALID_DN_SYNTAX :
088 case ALIAS_DEREFERENCING_PROBLEM :
089 byte[] dnBytes = tlv.getValue().getData();
090 String dnStr = StringTools.utf8ToString( dnBytes );
091
092 try
093 {
094 ldapResult.setMatchedDN( new DN( dnStr ) );
095 }
096 catch ( LdapInvalidDnException ine )
097 {
098 // This is for the client side. We will never decode LdapResult on the server
099 String msg = I18n.err( I18n.ERR_04013, dnStr, StringTools.dumpBytes( dnBytes ), ine.getLocalizedMessage() );
100 log.error( msg );
101
102 throw new DecoderException( I18n.err( I18n.ERR_04014, ine.getLocalizedMessage() ) );
103 }
104
105 break;
106
107 default :
108 log.warn( "The matched DN should not be set when the result code is one of NoSuchObject," +
109 " AliasProblem, InvalidDNSyntax or AliasDreferencingProblem" );
110
111 ldapResult.setMatchedDN( DN.EMPTY_DN );
112 break;
113 }
114 }
115
116 if ( IS_DEBUG )
117 {
118 log.debug( "The matchedDN is " + ldapResult.getMatchedDN() );
119 }
120
121 return;
122 }
123 }