/****************************************************************
* 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.james.imapserver.netty;
import java.util.HashMap;
import java.util.Map;
import javax.net.ssl.SSLContext;
import org.apache.james.imap.api.ImapSessionState;
import org.apache.james.imap.api.process.ImapLineHandler;
import org.apache.james.imap.api.process.ImapSession;
import org.apache.james.imap.api.process.SelectedMailbox;
import org.apache.james.protocols.api.logger.ProtocolLoggerAdapter;
import org.apache.james.protocols.api.logger.ProtocolSessionLogger;
import org.apache.james.protocols.lib.Slf4jLoggerAdapter;
import org.jboss.netty.channel.Channel;
import org.jboss.netty.handler.codec.compression.ZlibDecoder;
import org.jboss.netty.handler.codec.compression.ZlibEncoder;
import org.jboss.netty.handler.codec.compression.ZlibWrapper;
import org.jboss.netty.handler.ssl.SslHandler;
import org.slf4j.Logger;
public class NettyImapSession implements ImapSession, NettyConstants {
private ImapSessionState state = ImapSessionState.NON_AUTHENTICATED;
private SelectedMailbox selectedMailbox;
private final Map<String, Object> attributesByKey = new HashMap<String, Object>();
private final SSLContext sslContext;
private final String[] enabledCipherSuites;
private final boolean compress;
private final ProtocolSessionLogger log;
private final Channel channel;
private int handlerCount;
private final boolean plainAuthDisallowed;
public NettyImapSession(Channel channel, Logger log, SSLContext sslContext, String[] enabledCipherSuites, boolean compress, boolean plainAuthDisallowed) {
this.channel = channel;
this.log = new ProtocolSessionLogger(channel.getId() + "", new ProtocolLoggerAdapter(log));
this.sslContext = sslContext;
this.enabledCipherSuites = enabledCipherSuites;
this.compress = compress;
this.plainAuthDisallowed = plainAuthDisallowed;
}
/**
* Return the wrapped {@link Channel} which this {@link ImapSession} is
* bound to
*
* @return channel
*/
public Channel getChannel() {
return channel;
}
/**
* @see org.apache.james.imap.api.process.ImapSession#logout()
*/
public void logout() {
closeMailbox();
state = ImapSessionState.LOGOUT;
}
/**
* @see org.apache.james.imap.api.process.ImapSession#authenticated()
*/
public void authenticated() {
this.state = ImapSessionState.AUTHENTICATED;
}
/**
* @see org.apache.james.imap.api.process.ImapSession#deselect()
*/
public void deselect() {
this.state = ImapSessionState.AUTHENTICATED;
closeMailbox();
}
/**
* @see
* org.apache.james.imap.api.process.ImapSession#selected(org.apache.james.imap.api.process.SelectedMailbox)
*/
public void selected(SelectedMailbox mailbox) {
this.state = ImapSessionState.SELECTED;
closeMailbox();
this.selectedMailbox = mailbox;
}
/**
* @see org.apache.james.imap.api.process.ImapSession#getSelected()
*/
public SelectedMailbox getSelected() {
return this.selectedMailbox;
}
/**
* @see org.apache.james.imap.api.process.ImapSession#getState()
*/
public ImapSessionState getState() {
return this.state;
}
private void closeMailbox() {
if (selectedMailbox != null) {
selectedMailbox.deselect();
selectedMailbox = null;
}
}
/**
* @see
* org.apache.james.imap.api.process.ImapSession#getAttribute(java.lang.String)
*/
public Object getAttribute(String key) {
final Object result = attributesByKey.get(key);
return result;
}
/**
* @see
* org.apache.james.imap.api.process.ImapSession#setAttribute(java.lang.String, java.lang.Object)
*/
public void setAttribute(String key, Object value) {
if (value == null) {
attributesByKey.remove(key);
} else {
attributesByKey.put(key, value);
}
}
/**
* @see org.apache.james.imap.api.process.ImapSession#startTLS()
*/
public boolean startTLS() {
if (!supportStartTLS())
return false;
channel.setReadable(false);
SslHandler filter = new SslHandler(sslContext.createSSLEngine(), false);
filter.getEngine().setUseClientMode(false);
if (enabledCipherSuites != null && enabledCipherSuites.length > 0) {
filter.getEngine().setEnabledCipherSuites(enabledCipherSuites);
}
channel.getPipeline().addFirst(SSL_HANDLER, filter);
channel.setReadable(true);
return true;
}
/**
* @see org.apache.james.imap.api.process.ImapSession#supportStartTLS()
*/
public boolean supportStartTLS() {
return sslContext != null;
}
/**
* @see
* org.apache.james.imap.api.process.ImapSession#isCompressionSupported()
*/
public boolean isCompressionSupported() {
return compress;
}
/**
* @see org.apache.james.imap.api.process.ImapSession#startCompression()
*/
public boolean startCompression() {
if (!isCompressionSupported())
return false;
channel.setReadable(false);
ZlibDecoder decoder = new ZlibDecoder(ZlibWrapper.NONE);
ZlibEncoder encoder = new ZlibEncoder(ZlibWrapper.NONE, 5);
// Check if we have the SslHandler in the pipeline already
// if so we need to move the compress encoder and decoder
// behind it in the chain
// See JAMES-1186
if (channel.getPipeline().get(SSL_HANDLER) == null) {
channel.getPipeline().addFirst(ZLIB_DECODER, decoder);
channel.getPipeline().addFirst(ZLIB_ENCODER, encoder);
} else {
channel.getPipeline().addAfter(SSL_HANDLER, ZLIB_DECODER, decoder);
channel.getPipeline().addAfter(SSL_HANDLER, ZLIB_ENCODER, encoder);
}
channel.setReadable(true);
return true;
}
/**
* @see
* org.apache.james.imap.api.process.ImapSession#pushLineHandler(org.apache.james.imap.api.process.ImapLineHandler)
*/
public void pushLineHandler(ImapLineHandler lineHandler) {
channel.setReadable(false);
channel.getPipeline().addBefore(REQUEST_DECODER, "lineHandler" + handlerCount++, new ImapLineHandlerAdapter(this, lineHandler));
channel.setReadable(true);
}
/**
* @see org.apache.james.imap.api.process.ImapSession#popLineHandler()
*/
public void popLineHandler() {
channel.setReadable(false);
channel.getPipeline().remove("lineHandler" + --handlerCount);
channel.setReadable(true);
}
/**
* @see org.apache.james.imap.api.process.ImapSession#getLog()
*/
public Logger getLog() {
return new Slf4jLoggerAdapter(log);
}
/**
* @see org.apache.james.imap.api.process.ImapSession#isPlainAuthDisallowed()
*/
public boolean isPlainAuthDisallowed() {
return plainAuthDisallowed;
}
/**
* @see org.apache.james.imap.api.process.ImapSession#isTLSActive()
*/
public boolean isTLSActive() {
return channel.getPipeline().get(SSL_HANDLER) != null;
}
/**
* @see org.apache.james.imap.api.process.ImapSession#supportMultipleNamespaces()
*/
public boolean supportMultipleNamespaces() {
return false;
}
/**
* @see org.apache.james.imap.api.process.ImapSession#isCompressionActive()
*/
public boolean isCompressionActive() {
return channel.getPipeline().get(ZLIB_DECODER) != null;
}
}