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