You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by no...@apache.org on 2011/04/01 15:18:36 UTC
svn commit: r1087696 - in /james/imap/trunk/processor/src:
main/java/org/apache/james/imap/processor/
main/java/org/apache/james/imap/processor/base/
test/java/org/apache/james/imap/processor/base/
Author: norman
Date: Fri Apr 1 13:18:36 2011
New Revision: 1087696
URL: http://svn.apache.org/viewvc?rev=1087696&view=rev
Log:
Make sure MailboxListeners get unregistered once the ImapSession was closed. See IMAP-274
Added:
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/ImapStateAwareMailboxListener.java
Modified:
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/AbstractSelectionProcessor.java
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/IdleProcessor.java
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/MailboxEventAnalyser.java
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/SelectedMailboxImpl.java
james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/UidToMsnConverter.java
james/imap/trunk/processor/src/test/java/org/apache/james/imap/processor/base/MailboxEventAnalyserTest.java
Modified: james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/AbstractSelectionProcessor.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/AbstractSelectionProcessor.java?rev=1087696&r1=1087695&r2=1087696&view=diff
==============================================================================
--- james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/AbstractSelectionProcessor.java (original)
+++ james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/AbstractSelectionProcessor.java Fri Apr 1 13:18:36 2011
@@ -204,7 +204,7 @@ abstract class AbstractSelectionProcesso
// See https://issues.apache.org/jira/browse/IMAP-192
final Iterator<Long> it = mailbox.search(query, mailboxSession);
- final SelectedMailbox sessionMailbox = new SelectedMailboxImpl(getMailboxManager(), it, mailboxSession, path);
+ final SelectedMailbox sessionMailbox = new SelectedMailboxImpl(getMailboxManager(), it, session, path);
session.selected(sessionMailbox);
return sessionMailbox;
}
Modified: james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/IdleProcessor.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/IdleProcessor.java?rev=1087696&r1=1087695&r2=1087696&view=diff
==============================================================================
--- james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/IdleProcessor.java (original)
+++ james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/IdleProcessor.java Fri Apr 1 13:18:36 2011
@@ -41,8 +41,8 @@ import org.apache.james.imap.api.process
import org.apache.james.imap.api.process.SelectedMailbox;
import org.apache.james.imap.message.request.IdleRequest;
import org.apache.james.imap.message.response.ContinuationResponse;
+import org.apache.james.imap.processor.base.ImapStateAwareMailboxListener;
import org.apache.james.mailbox.MailboxException;
-import org.apache.james.mailbox.MailboxListener;
import org.apache.james.mailbox.MailboxManager;
import org.apache.james.mailbox.MailboxSession;
@@ -161,15 +161,14 @@ public class IdleProcessor extends Abstr
return Arrays.asList(SUPPORTS_IDLE);
}
- private class IdleMailboxListener implements MailboxListener {
+ private class IdleMailboxListener extends ImapStateAwareMailboxListener {
private final AtomicBoolean closed;
- private final ImapSession session;
private final Responder responder;
public IdleMailboxListener(AtomicBoolean closed, ImapSession session, Responder responder) {
+ super(session);
this.closed = closed;
- this.session = session;
this.responder = responder;
}
@@ -183,8 +182,12 @@ public class IdleProcessor extends Abstr
}
}
}
-
- public boolean isClosed() {
+
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.processor.ImapSessionAwareMailboxListener#isListenerClosed()
+ */
+ protected boolean isListenerClosed() {
return closed.get();
}
Added: james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/ImapStateAwareMailboxListener.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/ImapStateAwareMailboxListener.java?rev=1087696&view=auto
==============================================================================
--- james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/ImapStateAwareMailboxListener.java (added)
+++ james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/ImapStateAwareMailboxListener.java Fri Apr 1 13:18:36 2011
@@ -0,0 +1,56 @@
+/****************************************************************
+ * 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.imap.processor.base;
+
+import org.apache.james.imap.api.ImapSessionState;
+import org.apache.james.imap.api.process.ImapSession;
+import org.apache.james.mailbox.MailboxListener;
+
+/**
+ * Abstract base class for {@link MailboxListener} which should be handled as closed if the {@link ImapSessionState} is {@link ImapSessionState#LOGOUT} is true
+ *
+ * This class should be used by all IMAP specifc {@link MailboxListener} implementation!
+ */
+public abstract class ImapStateAwareMailboxListener implements MailboxListener {
+
+ protected final ImapSession session;
+
+ public ImapStateAwareMailboxListener(ImapSession session) {
+ this.session = session;
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.mailbox.MailboxListener#isClosed()
+ */
+ public boolean isClosed() {
+ if (ImapSessionState.LOGOUT.equals(session.getState()) || isListenerClosed()) {
+ return true;
+ } else {
+ return false;
+ }
+ }
+
+ /**
+ * Return true if the listener should handled as closed and get unregistered
+ *
+ * @return closed
+ */
+ protected abstract boolean isListenerClosed();
+}
Modified: james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/MailboxEventAnalyser.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/MailboxEventAnalyser.java?rev=1087696&r1=1087695&r2=1087696&view=diff
==============================================================================
--- james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/MailboxEventAnalyser.java (original)
+++ james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/MailboxEventAnalyser.java Fri Apr 1 13:18:36 2011
@@ -27,6 +27,8 @@ import java.util.TreeSet;
import javax.mail.Flags;
+import org.apache.james.imap.api.ImapSessionUtils;
+import org.apache.james.imap.api.process.ImapSession;
import org.apache.james.mailbox.MailboxListener;
import org.apache.james.mailbox.MailboxPath;
@@ -35,7 +37,7 @@ import org.apache.james.mailbox.MailboxP
* analyze these. It will only act on {@link Event} notifications which are sent for the registered
* MailboxPath
*/
-public class MailboxEventAnalyser implements MailboxListener {
+public class MailboxEventAnalyser extends ImapStateAwareMailboxListener {
private final long sessionId;
private Set<Long> flagUpdateUids;
@@ -48,9 +50,10 @@ public class MailboxEventAnalyser implem
private MailboxPath mailboxPath;
private boolean closed = false;
- public MailboxEventAnalyser(final long sessionId, final MailboxPath mailboxPath) {
- super();
- this.sessionId = sessionId;
+ public MailboxEventAnalyser(final ImapSession session, final MailboxPath mailboxPath) {
+ super(session);
+ this.sessionId = ImapSessionUtils.getMailboxSession(session).getSessionId();
+ System.out.println("ID=" +sessionId);
flagUpdateUids = new TreeSet<Long>();
expungedUids = new TreeSet<Long>();
uninterestingFlag = Flags.Flag.RECENT;
@@ -230,11 +233,12 @@ public class MailboxEventAnalyser implem
expungedUids = null;
}
+
/*
* (non-Javadoc)
- * @see org.apache.james.mailbox.MailboxListener#isClosed()
+ * @see org.apache.james.imap.processor.base.ImapStateAwareMailboxListener#isListenerClosed()
*/
- public synchronized boolean isClosed() {
+ protected synchronized boolean isListenerClosed() {
return closed;
}
}
Modified: james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/SelectedMailboxImpl.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/SelectedMailboxImpl.java?rev=1087696&r1=1087695&r2=1087696&view=diff
==============================================================================
--- james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/SelectedMailboxImpl.java (original)
+++ james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/SelectedMailboxImpl.java Fri Apr 1 13:18:36 2011
@@ -25,6 +25,8 @@ import java.util.Iterator;
import java.util.Set;
import java.util.TreeSet;
+import org.apache.james.imap.api.ImapSessionUtils;
+import org.apache.james.imap.api.process.ImapSession;
import org.apache.james.imap.api.process.SelectedMailbox;
import org.apache.james.mailbox.MailboxException;
import org.apache.james.mailbox.MailboxManager;
@@ -46,15 +48,15 @@ public class SelectedMailboxImpl impleme
private boolean recentUidRemoved;
public SelectedMailboxImpl(final MailboxManager mailboxManager, final Iterator<Long> uids,
- final MailboxSession mailboxSession, final MailboxPath path) throws MailboxException {
+ final ImapSession session, final MailboxPath path) throws MailboxException {
recentUids = new TreeSet<Long>();
recentUidRemoved = false;
- final long sessionId = mailboxSession.getSessionId();
- events = new MailboxEventAnalyser(sessionId, path);
+ MailboxSession mailboxSession = ImapSessionUtils.getMailboxSession(session);
+ events = new MailboxEventAnalyser(session, path);
// Ignore events from our session
events.setSilentFlagChanges(true);
mailboxManager.addListener(path, events, mailboxSession);
- converter = new UidToMsnConverter(uids);
+ converter = new UidToMsnConverter(session, uids);
mailboxManager.addListener(path, converter, mailboxSession);
}
Modified: james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/UidToMsnConverter.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/UidToMsnConverter.java?rev=1087696&r1=1087695&r2=1087696&view=diff
==============================================================================
--- james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/UidToMsnConverter.java (original)
+++ james/imap/trunk/processor/src/main/java/org/apache/james/imap/processor/base/UidToMsnConverter.java Fri Apr 1 13:18:36 2011
@@ -25,6 +25,7 @@ import java.util.List;
import java.util.SortedMap;
import java.util.TreeMap;
+import org.apache.james.imap.api.process.ImapSession;
import org.apache.james.imap.api.process.SelectedMailbox;
import org.apache.james.mailbox.MailboxListener;
@@ -35,7 +36,7 @@ import org.apache.james.mailbox.MailboxL
* TODO: This is a major memory hog
* TODO: Each concurrent session requires one, and typical clients now open many
*/
-public class UidToMsnConverter implements MailboxListener {
+public class UidToMsnConverter extends ImapStateAwareMailboxListener {
private SortedMap<Integer, Long> msnToUid;
private SortedMap<Long, Integer> uidToMsn;
@@ -46,7 +47,8 @@ public class UidToMsnConverter implement
private boolean closed = false;
- public UidToMsnConverter(final Iterator<Long> uids) {
+ public UidToMsnConverter(final ImapSession session, final Iterator<Long> uids) {
+ super(session);
msnToUid = new TreeMap<Integer, Long>();
uidToMsn = new TreeMap<Long, Integer>();
if (uids != null) {
@@ -182,18 +184,18 @@ public class UidToMsnConverter implement
closed = true;
}
- /*
- * (non-Javadoc)
- * @see org.apache.james.mailbox.MailboxListener#isClosed()
- */
- public synchronized boolean isClosed() {
- return closed;
- }
-
/**
* @see SelectedMailbox#existsCount()
*/
public synchronized long getCount() {
return uidToMsn.size();
}
+
+ /*
+ * (non-Javadoc)
+ * @see org.apache.james.imap.processor.ImapSessionAwareMailboxListener#isListenerClosed()
+ */
+ protected synchronized boolean isListenerClosed() {
+ return closed;
+ }
}
Modified: james/imap/trunk/processor/src/test/java/org/apache/james/imap/processor/base/MailboxEventAnalyserTest.java
URL: http://svn.apache.org/viewvc/james/imap/trunk/processor/src/test/java/org/apache/james/imap/processor/base/MailboxEventAnalyserTest.java?rev=1087696&r1=1087695&r2=1087696&view=diff
==============================================================================
--- james/imap/trunk/processor/src/test/java/org/apache/james/imap/processor/base/MailboxEventAnalyserTest.java (original)
+++ james/imap/trunk/processor/src/test/java/org/apache/james/imap/processor/base/MailboxEventAnalyserTest.java Fri Apr 1 13:18:36 2011
@@ -30,6 +30,11 @@ import java.util.Map;
import javax.mail.Flags;
+import org.apache.james.imap.api.ImapSessionState;
+import org.apache.james.imap.api.ImapSessionUtils;
+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.mailbox.MailboxListener;
import org.apache.james.mailbox.MailboxPath;
import org.apache.james.mailbox.MailboxSession;
@@ -42,8 +47,7 @@ public class MailboxEventAnalyserTest {
private static final long BASE_SESSION_ID = 99;
- private MailboxEventAnalyser analyser;
- MailboxPath mailboxPath = new MailboxPath("namespace", "user", "name");
+ private MailboxPath mailboxPath = new MailboxPath("namespace", "user", "name");
private final class MyMailboxSession implements MailboxSession {
private long sessionId;
@@ -98,14 +102,86 @@ public class MailboxEventAnalyserTest {
}
- @Before
- public void setUp() throws Exception {
- analyser = new MailboxEventAnalyser(BASE_SESSION_ID, mailboxPath);
- }
+ private class MyImapSession implements ImapSession{
+ private MailboxSession mSession;
+
+ public MyImapSession(MailboxSession mSession) {
+ this.mSession = mSession;
+ }
+
+ public boolean supportStartTLS() {
+ return false;
+ }
+
+ public boolean startTLS() {
+ return false;
+ }
+
+ public boolean startCompression() {
+ return false;
+ }
+
+ public void setAttribute(String key, Object value) {
+ }
+
+ public void selected(SelectedMailbox mailbox) {
+
+ }
+
+ public void pushLineHandler(ImapLineHandler lineHandler) {
+
+ }
+
+ public void popLineHandler() {
+
+ }
+
+ public void logout() {
+
+ }
+
+ public boolean isCompressionSupported() {
+ return false;
+ }
+
+ public ImapSessionState getState() {
+ return ImapSessionState.AUTHENTICATED;
+ }
+
+ public SelectedMailbox getSelected() {
+ return null;
+ }
+
+ public Logger getLog() {
+ return null;
+ }
+
+ public Object getAttribute(String key) {
+ if (key.equals(ImapSessionUtils.MAILBOX_SESSION_ATTRIBUTE_SESSION_KEY)) {
+ return mSession;
+ }
+ return null;
+ }
+
+ public void deselect() {
+
+ }
+
+ public void authenticated() {
+
+ }
+ };
+
@Test
public void testShouldBeNoSizeChangeOnOtherEvent() throws Exception {
- final MailboxListener.Event event = new MailboxListener.Event(new MyMailboxSession(0), mailboxPath) {};
+ MyMailboxSession mSession = new MyMailboxSession(0);
+
+ MyImapSession imapsession = new MyImapSession(mSession);
+
+ MailboxEventAnalyser analyser = new MailboxEventAnalyser(imapsession, mailboxPath);
+
+ final MailboxListener.Event event = new MailboxListener.Event(mSession, mailboxPath) {};
analyser.event(event);
assertFalse(analyser.isSizeChanged());
@@ -113,21 +189,39 @@ public class MailboxEventAnalyserTest {
@Test
public void testShouldBeNoSizeChangeOnAdded() throws Exception {
- analyser.event(new FakeMailboxListenerAdded(new MyMailboxSession(0), 11, mailboxPath));
+ MyMailboxSession mSession = new MyMailboxSession(0);
+
+ MyImapSession imapsession = new MyImapSession(mSession);
+
+ MailboxEventAnalyser analyser = new MailboxEventAnalyser(imapsession, mailboxPath);
+
+ analyser.event(new FakeMailboxListenerAdded(mSession, 11, mailboxPath));
assertTrue(analyser.isSizeChanged());
}
@Test
public void testShouldNoSizeChangeAfterReset() throws Exception {
- analyser.event(new FakeMailboxListenerAdded(new MyMailboxSession(99), 11, mailboxPath));
+ MyMailboxSession mSession = new MyMailboxSession(99);
+
+ MyImapSession imapsession = new MyImapSession(mSession);
+
+ MailboxEventAnalyser analyser = new MailboxEventAnalyser(imapsession, mailboxPath);
+
+ analyser.event(new FakeMailboxListenerAdded(mSession, 11, mailboxPath));
analyser.reset();
assertFalse(analyser.isSizeChanged());
}
@Test
public void testShouldNotSetUidWhenNoSystemFlagChange() throws Exception {
+ MyMailboxSession mSession = new MyMailboxSession(11);
+
+ MyImapSession imapsession = new MyImapSession(mSession);
+
+ MailboxEventAnalyser analyser = new MailboxEventAnalyser(imapsession, mailboxPath);
+
final FakeMailboxListenerFlagsUpdate update = new FakeMailboxListenerFlagsUpdate(
- new MyMailboxSession(11), 90, new Flags(), mailboxPath);
+ mSession, 90, new Flags(), mailboxPath);
analyser.event(update);
assertNotNull(analyser.flagUpdateUids());
assertFalse(analyser.flagUpdateUids().iterator().hasNext());
@@ -136,8 +230,15 @@ public class MailboxEventAnalyserTest {
@Test
public void testShouldSetUidWhenSystemFlagChange() throws Exception {
final long uid = 900L;
+ MyMailboxSession mSession = new MyMailboxSession(11);
+
+ MyImapSession imapsession = new MyImapSession(mSession);
+
+ MailboxEventAnalyser analyser = new MailboxEventAnalyser(imapsession, mailboxPath);
+
+
final FakeMailboxListenerFlagsUpdate update = new FakeMailboxListenerFlagsUpdate(
- new MyMailboxSession(11), uid, new Flags(), mailboxPath);
+ mSession, uid, new Flags(), mailboxPath);
update.flags.add(Flags.Flag.ANSWERED);
analyser.event(update);
final Iterator<Long> iterator = analyser.flagUpdateUids().iterator();
@@ -150,8 +251,12 @@ public class MailboxEventAnalyserTest {
@Test
public void testShouldClearFlagUidsUponReset() throws Exception {
final long uid = 900L;
+ MyMailboxSession mSession = new MyMailboxSession(11);
+ MyImapSession imapsession = new MyImapSession(mSession);
+ MailboxEventAnalyser analyser = new MailboxEventAnalyser(imapsession, mailboxPath);
+
final FakeMailboxListenerFlagsUpdate update = new FakeMailboxListenerFlagsUpdate(
- new MyMailboxSession(11), uid, new Flags(), mailboxPath);
+ mSession, uid, new Flags(), mailboxPath);
update.flags.add(Flags.Flag.ANSWERED);
analyser.event(update);
analyser.reset();
@@ -160,11 +265,16 @@ public class MailboxEventAnalyserTest {
}
@Test
- public void testShouldNotSetUidWhenSystemFlagChangeDifferentSessionInSilentMode()
+ public void testShouldSetUidWhenSystemFlagChangeDifferentSessionInSilentMode()
throws Exception {
final long uid = 900L;
+
+ MyMailboxSession mSession = new MyMailboxSession(11);
+ MyImapSession imapsession = new MyImapSession(mSession);
+ MailboxEventAnalyser analyser = new MailboxEventAnalyser(imapsession, mailboxPath);
+
final FakeMailboxListenerFlagsUpdate update = new FakeMailboxListenerFlagsUpdate(
- new MyMailboxSession(11), uid, new Flags(), mailboxPath);
+ new MyMailboxSession(BASE_SESSION_ID), uid, new Flags(), mailboxPath);
update.flags.add(Flags.Flag.ANSWERED);
analyser.setSilentFlagChanges(true);
analyser.event(update);
@@ -178,8 +288,13 @@ public class MailboxEventAnalyserTest {
@Test
public void testShouldNotSetUidWhenSystemFlagChangeSameSessionInSilentMode()
throws Exception {
+ MyMailboxSession mSession = new MyMailboxSession(BASE_SESSION_ID);
+ MyImapSession imapsession = new MyImapSession(mSession);
+ MailboxEventAnalyser analyser = new MailboxEventAnalyser(imapsession, mailboxPath);
+
+
final FakeMailboxListenerFlagsUpdate update = new FakeMailboxListenerFlagsUpdate(
- new MyMailboxSession(BASE_SESSION_ID) ,345, new Flags(), mailboxPath);
+ mSession ,345, new Flags(), mailboxPath);
update.flags.add(Flags.Flag.ANSWERED);
analyser.setSilentFlagChanges(true);
analyser.event(update);
@@ -190,8 +305,13 @@ public class MailboxEventAnalyserTest {
@Test
public void testShouldNotSetUidWhenOnlyRecentFlagUpdated() throws Exception {
+ MyMailboxSession mSession = new MyMailboxSession(BASE_SESSION_ID);
+ MyImapSession imapsession = new MyImapSession(mSession);
+ MailboxEventAnalyser analyser = new MailboxEventAnalyser(imapsession, mailboxPath);
+
+
final FakeMailboxListenerFlagsUpdate update = new FakeMailboxListenerFlagsUpdate(
- new MyMailboxSession(BASE_SESSION_ID), 886, new Flags() ,mailboxPath);
+ mSession, 886, new Flags() ,mailboxPath);
update.flags.add(Flags.Flag.RECENT);
analyser.event(update);
final Iterator<Long> iterator = analyser.flagUpdateUids().iterator();
---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org