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