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.controls; 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.TLV; 026import org.apache.directory.shared.asn1.ber.tlv.Value; 027import org.apache.directory.shared.ldap.codec.api.CodecControl; 028import org.apache.directory.shared.ldap.codec.api.LdapMessageContainer; 029import org.apache.directory.shared.ldap.codec.api.MessageDecorator; 030import org.apache.directory.shared.ldap.model.message.Control; 031import org.apache.directory.shared.ldap.model.message.Message; 032import org.apache.directory.shared.util.StringConstants; 033import org.apache.directory.shared.util.Strings; 034import org.slf4j.Logger; 035import org.slf4j.LoggerFactory; 036 037 038/** 039 * The action used to set the value of a control. This is an extension point 040 * where different controls can be plugged in (at least eventually). For now we 041 * hard code controls. 042 * <pre> 043 * Control ::= SEQUENCE { 044 * ... 045 * controlValue OCTET STRING OPTIONAL } 046 * </pre> 047 * 048 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 049 */ 050public class StoreControlValue extends GrammarAction<LdapMessageContainer<MessageDecorator<? extends Message>>> 051{ 052 /** The logger */ 053 private static final Logger LOG = LoggerFactory.getLogger( StoreControlValue.class ); 054 055 /** Speedup for logs */ 056 private static final boolean IS_DEBUG = LOG.isDebugEnabled(); 057 058 059 /** 060 * Instantiates a new StoreControlValue action. 061 */ 062 public StoreControlValue() 063 { 064 super( "Store the control value" ); 065 } 066 067 068 /** 069 * {@inheritDoc} 070 */ 071 public void action( LdapMessageContainer<MessageDecorator<? extends Message>> container ) throws DecoderException 072 { 073 TLV tlv = container.getCurrentTLV(); 074 075 MessageDecorator<?> message = container.getMessage(); 076 CodecControl<? extends Control> control = message.getCurrentControl(); 077 078 // Get the current control 079 Value value = tlv.getValue(); 080 081 // Store the value - have to handle the special case of a 0 length value 082 if ( tlv.getLength() == 0 ) 083 { 084 control.setValue( StringConstants.EMPTY_BYTES ); 085 } 086 else 087 { 088 control.setValue( value.getData() ); 089 090 if ( control != null ) 091 { 092 control.decode( value.getData() ); 093 } 094 } 095 096 // We can have an END transition 097 container.setGrammarEndAllowed( true ); 098 099 if ( IS_DEBUG ) 100 { 101 LOG.debug( "Control value : " + Strings.dumpBytes(control.getValue()) ); 102 } 103 } 104}