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