org.apache.mina.proxy.event.IoSessionEventQueue 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.event;
import java.util.LinkedList;
import java.util.Queue;
import org.apache.mina.proxy.handlers.socks.SocksProxyRequest;
import org.apache.mina.proxy.session.ProxyIoSession;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* IoSessionEventQueue.java - Queue that contains filtered session events
* while handshake isn't done.
*
* @author Apache MINA Project
* @since MINA 2.0.0-M3
*/
public class IoSessionEventQueue {
private final static Logger logger = LoggerFactory
.getLogger(IoSessionEventQueue.class);
/**
* The proxy session object.
*/
private ProxyIoSession proxyIoSession;
/**
* Queue of session events which occurred before the proxy handshake had completed.
*/
private Queue sessionEventsQueue = new LinkedList();
public IoSessionEventQueue(ProxyIoSession proxyIoSession) {
this.proxyIoSession = proxyIoSession;
}
/**
* Discard all events from the queue.
*/
private void discardSessionQueueEvents() {
synchronized (sessionEventsQueue) {
// Free queue
sessionEventsQueue.clear();
logger.debug("Event queue CLEARED");
}
}
/**
* Event is enqueued only if necessary :
* - socks proxies do not need the reconnection feature so events are always
* forwarded for these.
* - http proxies events will be enqueued while handshake has not been completed
* or until connection was closed.
* If connection was prematurely closed previous events are discarded and only the
* session closed is delivered.
*
* @param evt the event to enqueue
*/
public void enqueueEventIfNecessary(final IoSessionEvent evt) {
logger.debug("??? >> Enqueue {}", evt);
if (proxyIoSession.getRequest() instanceof SocksProxyRequest) {
// No reconnection used
evt.deliverEvent();
return;
}
if (proxyIoSession.getHandler().isHandshakeComplete()) {
evt.deliverEvent();
} else {
if (evt.getType() == IoSessionEventType.CLOSED) {
if (proxyIoSession.isAuthenticationFailed()) {
proxyIoSession.getConnector().cancelConnectFuture();
discardSessionQueueEvents();
evt.deliverEvent();
} else {
discardSessionQueueEvents();
}
} else if (evt.getType() == IoSessionEventType.OPENED) {
// Enqueue event cause it will not reach IoHandler but deliver it to enable
// session creation.
enqueueSessionEvent(evt);
evt.deliverEvent();
} else {
enqueueSessionEvent(evt);
}
}
}
/**
* Send any session event which were queued while waiting for handshaking to complete.
*
* Please note this is an internal method. DO NOT USE it in your code.
*/
public void flushPendingSessionEvents() throws Exception {
synchronized (sessionEventsQueue) {
IoSessionEvent evt;
while ((evt = sessionEventsQueue.poll()) != null) {
logger.debug(" Flushing buffered event: {}", evt);
evt.deliverEvent();
}
}
}
/**
* Enqueue an event to be delivered once handshaking is complete.
*
* @param evt the session event to enqueue
*/
private void enqueueSessionEvent(final IoSessionEvent evt) {
synchronized (sessionEventsQueue) {
logger.debug("Enqueuing event: {}", evt);
sessionEventsQueue.offer(evt);
}
}
}