org.apache.mina.handler.chain.ChainedIoHandler Maven / Gradle / Ivy

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF 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 org.apache.mina.handler.chain;

import org.apache.mina.core.service.IoHandler;
import org.apache.mina.core.service.IoHandlerAdapter;
import org.apache.mina.core.session.IoSession;

/**
 * An {@link IoHandler} which executes an {@link IoHandlerChain}
 * on a messageReceived event.
 *
 * @author Apache MINA Project
 */
public class ChainedIoHandler extends IoHandlerAdapter {
    private final IoHandlerChain chain;

    /**
     * Creates a new instance which contains an empty {@link IoHandlerChain}.
     */
    public ChainedIoHandler() {
        chain = new IoHandlerChain();
    }

    /**
     * Creates a new instance which executes the specified
     * {@link IoHandlerChain} on a messageReceived event.
     *
     * @param chain an {@link IoHandlerChain} to execute
     */
    public ChainedIoHandler(IoHandlerChain chain) {
        if (chain == null) {
            throw new IllegalArgumentException("chain");
        }
        
        this.chain = chain;
    }

    /**
     * @return the {@link IoHandlerCommand} this handler will use to
     * handle messageReceived events.
     */
    public IoHandlerChain getChain() {
        return chain;
    }

    /**
     * Handles the specified messageReceived event with the
     * {@link IoHandlerCommand} or {@link IoHandlerChain} you specified
     * in the constructor.
     */
    @Override
    public void messageReceived(IoSession session, Object message) throws Exception {
        chain.execute(null, session, message);
    }
}