1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * https://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.directory.api.ldap.codec.actions.request.search.filter;
21
22
23 import org.apache.directory.api.asn1.DecoderException;
24 import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
25 import org.apache.directory.api.asn1.ber.tlv.TLV;
26 import org.apache.directory.api.i18n.I18n;
27 import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
28 import org.apache.directory.api.ldap.codec.search.SubstringFilter;
29 import org.apache.directory.api.ldap.model.message.SearchRequest;
30 import org.apache.directory.api.util.Strings;
31 import org.slf4j.Logger;
32 import org.slf4j.LoggerFactory;
33
34
35 /**
36 * The action used to store the Substring Filter type
37 * <pre>
38 * Filter ::= CHOICE {
39 * ...
40 * substrings [4] SubstringFilter,
41 * ...
42 *
43 * SubstringFilter ::= SEQUENCE {
44 * type AttributeDescription,
45 * ...
46 * </pre>
47 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
48 */
49 public class StoreSubstringFilterType extends GrammarAction<LdapMessageContainer<SearchRequest>>
50 {
51 /** The logger */
52 private static final Logger LOG = LoggerFactory.getLogger( StoreSubstringFilterType.class );
53
54
55 /**
56 * Instantiates a new action.
57 */
58 public StoreSubstringFilterType()
59 {
60 super( "Store Substring filter type" );
61 }
62
63
64 /**
65 * {@inheritDoc}
66 */
67 public void action( LdapMessageContainer<SearchRequest> container ) throws DecoderException
68 {
69 TLV tlv = container.getCurrentTLV();
70
71 // Store the value.
72 SubstringFilter substringFilter = ( SubstringFilter ) container.getTerminalFilter();
73
74 if ( tlv.getLength() == 0 )
75 {
76 String msg = I18n.err( I18n.ERR_05153_NULL_ATTRIBUTE_DESCRIPTION );
77 LOG.error( msg );
78 throw new DecoderException( msg );
79 }
80 else
81 {
82 String type = Strings.utf8ToString( tlv.getValue().getData() );
83 substringFilter.setType( type );
84
85 // We now have to get back to the nearest filter which
86 // is not terminal.
87 container.setTerminalFilter( substringFilter );
88 }
89 }
90 }