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.shared.ldap.codec.actions.searchRequest; 021 022 023import org.apache.directory.shared.asn1.DecoderException; 024import org.apache.directory.shared.asn1.ber.grammar.GrammarAction; 025import org.apache.directory.shared.asn1.ber.tlv.BooleanDecoder; 026import org.apache.directory.shared.asn1.ber.tlv.BooleanDecoderException; 027import org.apache.directory.shared.asn1.ber.tlv.TLV; 028import org.apache.directory.shared.asn1.ber.tlv.Value; 029import org.apache.directory.shared.i18n.I18n; 030import org.apache.directory.shared.ldap.codec.api.LdapMessageContainer; 031import org.apache.directory.shared.ldap.codec.decorators.SearchRequestDecorator; 032import org.apache.directory.shared.ldap.model.message.SearchRequest; 033import org.apache.directory.shared.util.Strings; 034import org.slf4j.Logger; 035import org.slf4j.LoggerFactory; 036 037 038/** 039 * The action used to store the SearchRequest typesOnly flag 040 * <pre> 041 * SearchRequest ::= [APPLICATION 3] SEQUENCE { 042 * ... 043 * typesOnly BOOLEAN, 044 * ... 045 * </pre> 046 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 047 */ 048public class StoreSearchRequestTypesOnly extends GrammarAction<LdapMessageContainer<SearchRequestDecorator>> 049{ 050 /** The logger */ 051 private static final Logger LOG = LoggerFactory.getLogger( StoreSearchRequestTypesOnly.class ); 052 053 /** Speedup for logs */ 054 private static final boolean IS_DEBUG = LOG.isDebugEnabled(); 055 056 /** 057 * Instantiates a new action. 058 */ 059 public StoreSearchRequestTypesOnly() 060 { 061 super( "Store SearchRequest typesOnly flag" ); 062 } 063 064 065 /** 066 * {@inheritDoc} 067 */ 068 public void action( LdapMessageContainer<SearchRequestDecorator> container ) throws DecoderException 069 { 070 SearchRequest searchRequest = container.getMessage().getDecorated(); 071 072 TLV tlv = container.getCurrentTLV(); 073 074 // We get the value. If it's a 0, it's a FALSE. If it's 075 // a FF, it's a TRUE. Any other value should be an error, 076 // but we could relax this constraint. So if we have 077 // something 078 // which is not 0, it will be interpreted as TRUE, but we 079 // will generate a warning. 080 Value value = tlv.getValue(); 081 082 try 083 { 084 searchRequest.setTypesOnly( BooleanDecoder.parse( value ) ); 085 } 086 catch ( BooleanDecoderException bde ) 087 { 088 LOG.error( I18n 089 .err( I18n.ERR_04105, Strings.dumpBytes(value.getData()), bde.getMessage() ) ); 090 091 throw new DecoderException( bde.getMessage() ); 092 } 093 094 if ( IS_DEBUG ) 095 { 096 LOG.debug( "The search will return {}", ( searchRequest.getTypesOnly() ? "only attributs type" 097 : "attributes types and values" ) ); 098 } 099 } 100}