org.apache.mina.proxy.ProxyLogicHandler Maven / Gradle / Ivy
/**
* Copyright 2007-2015, Kaazing Corporation. All rights reserved.
*
* Licensed 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.proxy;
import org.apache.mina.core.buffer.IoBuffer;
import org.apache.mina.core.filterchain.IoFilter.NextFilter;
import org.apache.mina.core.write.WriteRequest;
import org.apache.mina.proxy.session.ProxyIoSession;
/**
* ProxyLogicHandler.java - Interface implemented by classes containing proxy type specific logic.
*
* @author Apache MINA Project
* @since MINA 2.0.0-M3
*/
public interface ProxyLogicHandler {
/**
* Tests if handshake process is complete.
*
* @return true
if handshaking is complete and
* data can be sent through the proxy, false otherwise.
*/
public abstract boolean isHandshakeComplete();
/**
* Handle incoming data during the handshake process. Should consume only the
* handshake data from the buffer, leaving any extra data in place.
*
* @param nextFilter the next filter in the filter chain
* @param buf the buffer holding the received data
* @throws ProxyAuthException if authentication fails
*/
public abstract void messageReceived(NextFilter nextFilter, IoBuffer buf)
throws ProxyAuthException;
/**
* Called at each step of the handshake procedure.
*
* @param nextFilter the next filter in filter chain
* @throws ProxyAuthException if authentication fails
*/
public abstract void doHandshake(NextFilter nextFilter)
throws ProxyAuthException;
/**
* Returns the {@link ProxyIoSession}.
*
* @return the proxy session object
*/
public abstract ProxyIoSession getProxyIoSession();
/**
* Enqueue a message to be written once handshaking is complete.
*
* @param nextFilter the next filter in filter chain
* @param writeRequest the data to be written
*/
public abstract void enqueueWriteRequest(final NextFilter nextFilter,
final WriteRequest writeRequest);
}