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.codec.util.LdapURLEncodingException;
032 import org.apache.directory.shared.ldap.message.ResultCodeEnum;
033 import org.apache.directory.shared.ldap.util.LdapURL;
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 add a referral to a LdapTresult
041 *
042 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
043 * @version $Rev$, $Date$,
044 */
045 public class ReferralAction extends GrammarAction
046 {
047 /** The logger */
048 private static final Logger log = LoggerFactory.getLogger( ReferralAction.class );
049
050 /** Speedup for logs */
051 private static final boolean IS_DEBUG = log.isDebugEnabled();
052
053 public ReferralAction()
054 {
055 super( "Add a referral" );
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 TLV tlv = ldapMessageContainer.getCurrentTLV();
068
069 if ( tlv.getLength() == 0 )
070 {
071 ldapResult.addReferral( LdapURL.EMPTY_URL );
072 }
073 else
074 {
075 if ( ldapResult.getResultCode() == ResultCodeEnum.REFERRAL )
076 {
077 try
078 {
079 ldapResult.addReferral( new LdapURL( tlv.getValue().getData() ) );
080 }
081 catch ( LdapURLEncodingException luee )
082 {
083 String badUrl = StringTools.utf8ToString( tlv.getValue().getData() );
084 log.error( I18n.err( I18n.ERR_04015, badUrl, luee.getMessage() ) );
085 throw new DecoderException( I18n.err( I18n.ERR_04016, luee.getMessage() ) );
086 }
087 }
088 else
089 {
090 log.warn( "The Referral error message is not allowed when havind an error code no equals to REFERRAL" );
091 ldapResult.addReferral( LdapURL.EMPTY_URL );
092 }
093 }
094
095 // We can have an END transition
096 ldapMessageContainer.grammarEndAllowed( true );
097
098 if ( IS_DEBUG )
099 {
100 StringBuffer sb = new StringBuffer();
101 boolean isFirst = true;
102
103 for ( LdapURL url:ldapResult.getReferrals() )
104 {
105 if ( isFirst )
106 {
107 isFirst = false;
108 }
109 else
110 {
111 sb.append( ", " );
112 }
113
114 sb.append( url );
115 }
116
117 log.debug( "The referral error message is set to " + sb.toString() );
118 }
119 }
120 }