ch.mimo.netty.handler.codec.icap.IcapMessageDecoder Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2011 Michael Mimo Moratti.
 *
 * Michael Mimo Moratti licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *     http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *******************************************************************************/
package ch.mimo.netty.handler.codec.icap;

import org.jboss.netty.buffer.ChannelBuffer;
import org.jboss.netty.channel.Channel;
import org.jboss.netty.channel.ChannelHandlerContext;
import org.jboss.netty.handler.codec.replay.ReplayingDecoder;
import org.jboss.netty.logging.InternalLogger;
import org.jboss.netty.logging.InternalLoggerFactory;

/**
 * Main ICAP message decoder implementation. this decoder is bases on a @see {@link ReplayingDecoder}
 * 
 * Due to the complexity of an ICAP message the decoder was implement with individual states that reside
 * in their own classes.
 * 
 * For a full list of states that are used within this decoder: @see {@link StateEnum}  
 * 
 * @author Michael Mimo Moratti ([email protected])
 *
 * @see IcapRequestDecoder
 * @see IcapResponseDecoder
 */

public abstract class IcapMessageDecoder extends ReplayingDecoder {

	private final InternalLogger LOG;
	
    protected final int maxInitialLineLength;
    protected final int maxIcapHeaderSize;
    protected final int maxHttpHeaderSize;
    protected final int maxChunkSize;
    
	protected IcapMessage message;
	
	protected int currentChunkSize;
	
	
	
    /**
     * Creates a new instance with the default
     * {@code maxInitialLineLength (4096}}, {@code maxIcapHeaderSize (8192)}, {@code maxHttpHeaderSize (8192)}, and
     * {@code maxChunkSize (8192)}.
     */
    protected IcapMessageDecoder() {
        this(4096,8192,8192,8192);
    }
    
    /**
     * Creates a new instance with the specified parameters.
     * @param maxInitialLineLength
     * @param maxIcapHeaderSize
     * @param maxHttpHeaderSize
     * @param maxChunkSize
     */
    protected IcapMessageDecoder(int maxInitialLineLength, int maxIcapHeaderSize, int maxHttpHeaderSize, int maxChunkSize) {
        super(StateEnum.SKIP_CONTROL_CHARS,true);
        LOG = InternalLoggerFactory.getInstance(getClass());
        if (maxInitialLineLength <= 0) {
            throw new IllegalArgumentException("maxInitialLineLength must be a positive integer: " + maxInitialLineLength);
        }
        if (maxIcapHeaderSize <= 0) {
            throw new IllegalArgumentException("maxIcapHeaderSize must be a positive integer: " + maxIcapHeaderSize);
        }
        if(maxHttpHeaderSize <= 0) {
        	throw new IllegalArgumentException("maxHttpHeaderSize must be a positive integer: " + maxIcapHeaderSize);
        }
        if (maxChunkSize <= 0) {
            throw new IllegalArgumentException("maxChunkSize must be a positive integer: " + maxChunkSize);
        }
        this.maxInitialLineLength = maxInitialLineLength;
        this.maxIcapHeaderSize = maxIcapHeaderSize;
        this.maxHttpHeaderSize = maxHttpHeaderSize;
        this.maxChunkSize = maxChunkSize;
    }

	@SuppressWarnings({ "rawtypes", "unchecked" })
	@Override
	protected Object decode(ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer, StateEnum stateEnumValue) throws Exception {
		if(stateEnumValue != null) {
			try {
				State state = stateEnumValue.getState();
				LOG.debug("Executing state [" + state + ']');
				state.onEntry(buffer,this);
				StateReturnValue returnValue = state.execute(buffer,this);
				LOG.debug("Return value from state [" + state + "] = [" + returnValue + "]");
				StateEnum nextState = state.onExit(buffer,this,returnValue.getDecisionInformation());
				LOG.debug("Next State [" + nextState + "]");
				if(nextState != null) {
					checkpoint(nextState);
				} else {
					reset();
				}
				if(returnValue.isRelevant()) {
					return returnValue.getValue();
				}
			} catch(DecodingException e) {
				reset();
				throw e;
			}
		}
		return null;
	}
	
	/**
	 * set the decoders message to NULL and the next checkpoint to @see {@link StateEnum#SKIP_CONTROL_CHARS}
	 */
    private void reset() {
        this.message = null;
        checkpoint(StateEnum.SKIP_CONTROL_CHARS);
    }
	
	public abstract boolean isDecodingResponse();
	
	protected abstract IcapMessage createMessage(String[] initialLine);
}