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 */ 020package org.apache.directory.api.ldap.codec.actions.response.search.reference; 021 022 023import org.apache.directory.api.asn1.DecoderException; 024import org.apache.directory.api.asn1.ber.grammar.GrammarAction; 025import org.apache.directory.api.asn1.ber.tlv.TLV; 026import org.apache.directory.api.i18n.I18n; 027import org.apache.directory.api.ldap.codec.api.LdapMessageContainer; 028import org.apache.directory.api.ldap.model.exception.LdapURLEncodingException; 029import org.apache.directory.api.ldap.model.message.Referral; 030import org.apache.directory.api.ldap.model.message.ReferralImpl; 031import org.apache.directory.api.ldap.model.message.SearchResultReference; 032import org.apache.directory.api.ldap.model.url.LdapUrl; 033import org.apache.directory.api.util.Strings; 034import org.slf4j.Logger; 035import org.slf4j.LoggerFactory; 036 037 038/** 039 * The action used to store a reference into a searchResultReference 040 * <pre> 041 * LdapMessage ::= ... SearchResultReference ... 042 * SearchResultReference ::= [APPLICATION 19] SEQUENCE OF LDAPURL 043 * </pre> 044 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 045 */ 046public class StoreReference extends GrammarAction<LdapMessageContainer<SearchResultReference>> 047{ 048 /** The logger */ 049 private static final Logger LOG = LoggerFactory.getLogger( StoreReference.class ); 050 051 /** 052 * Instantiates a new store reference action. 053 */ 054 public StoreReference() 055 { 056 super( "Store a reference" ); 057 } 058 059 060 /** 061 * {@inheritDoc} 062 */ 063 public void action( LdapMessageContainer<SearchResultReference> container ) throws DecoderException 064 { 065 SearchResultReference searchResultReference = container.getMessage(); 066 067 // Get the Value and store it in the BindRequest 068 TLV tlv = container.getCurrentTLV(); 069 070 // Get the referral, or create it if not existing 071 Referral referral = searchResultReference.getReferral(); 072 073 if ( referral == null ) 074 { 075 referral = new ReferralImpl(); 076 searchResultReference.setReferral( referral ); 077 } 078 079 // We have to handle the special case of a 0 length list of referrals 080 LdapUrl url = LdapUrl.EMPTY_URL; 081 082 if ( tlv.getLength() == 0 ) 083 { 084 referral.addLdapUrl( "" ); 085 } 086 else 087 { 088 String urlStr = Strings.utf8ToString( tlv.getValue().getData() ); 089 090 try 091 { 092 url = new LdapUrl( urlStr ); 093 referral.addLdapUrl( urlStr ); 094 } 095 catch ( LdapURLEncodingException luee ) 096 { 097 LOG.error( I18n.err( I18n.ERR_05103_INVALID_URL, urlStr, luee.getMessage() ) ); 098 throw new DecoderException( I18n.err( I18n.ERR_05104_INVALID_URL, luee.getMessage() ), luee ); 099 } 100 } 101 102 if ( LOG.isDebugEnabled() ) 103 { 104 LOG.debug( I18n.msg( I18n.MSG_05184_SEARCH_REFERENCE_URL, url ) ); 105 } 106 107 // We can have an END transition 108 container.setGrammarEndAllowed( true ); 109 } 110}