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.request.search.filter; 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.codec.search.SubstringFilter; 029import org.apache.directory.api.ldap.model.message.SearchRequest; 030import org.apache.directory.api.util.Strings; 031import org.slf4j.Logger; 032import org.slf4j.LoggerFactory; 033 034 035/** 036 * The action used to store a final value into a substring filter 037 * <pre> 038 * SubstringFilter ::= SEQUENCE { 039 * ... 040 * substrings SEQUENCE OF CHOICE { 041 * ... 042 * final [2] LDAPSTRING } 043 * </pre> 044 045 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 046 */ 047public class StoreFinal extends GrammarAction<LdapMessageContainer<SearchRequest>> 048{ 049 /** The logger */ 050 private static final Logger LOG = LoggerFactory.getLogger( StoreFinal.class ); 051 052 /** 053 * Instantiates a new store final action. 054 */ 055 public StoreFinal() 056 { 057 super( "Store a final value" ); 058 } 059 060 061 /** 062 * {@inheritDoc} 063 */ 064 public void action( LdapMessageContainer<SearchRequest> container ) throws DecoderException 065 { 066 TLV tlv = container.getCurrentTLV(); 067 068 // Store the value. 069 SubstringFilter substringFilter = ( SubstringFilter ) container.getTerminalFilter(); 070 071 if ( tlv.getLength() == 0 ) 072 { 073 String msg = I18n.err( I18n.ERR_05140_EMPTY_SUBSTRING_FINAL_FILTER_PDU ); 074 LOG.error( msg ); 075 throw new DecoderException( msg ); 076 } 077 078 String finalValue = Strings.utf8ToString( tlv.getValue().getData() ); 079 substringFilter.setFinalSubstrings( finalValue ); 080 081 // We now have to get back to the nearest filter which is 082 // not terminal. 083 container.unstackFilters(); 084 085 if ( LOG.isDebugEnabled() ) 086 { 087 LOG.debug( I18n.msg( I18n.MSG_05154_STORED_FINAL_SUBSTRING, finalValue ) ); 088 } 089 } 090}