Author: norman
Date: Sun Jun 27 13:06:37 2010
New Revision: 958383
URL: http://svn.apache.org/viewvc?rev=958383&view=rev
Log:
Add javadocs, fix typo in method name
Modified:
james/imap/trunk/jcr/src/main/java/org/apache/james/imap/jcr/user/JCRSubscriptionMapper.java
james/imap/trunk/jpa/src/main/java/org/apache/james/imap/jpa/mail/model/AbstractJPAMailboxMembership.java
james/imap/trunk/jpa/src/main/java/org/apache/james/imap/jpa/user/JPASubscriptionMapper.java
james/imap/trunk/mailbox/src/main/java/org/apache/james/imap/mailbox/MailboxSession.java
james/imap/trunk/mailbox/src/main/java/org/apache/james/imap/mailbox/MimeDescriptor.java
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/mail/InMemoryMailboxMapper.java
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/mail/InMemoryMessageMapper.java
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/user/InMemorySubscriptionMapper.java
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/Authenticator.java
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/StoreSubscriptionManager.java
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/user/SubscriptionMapper.java
Modified:
james/imap/trunk/jcr/src/main/java/org/apache/james/imap/jcr/user/JCRSubscriptionMapper.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/jcr/src/main/java/org/apache/james/imap/jcr/user/JCRSubscriptionMapper.java?rev=958383&r1=958382&r2=958383&view=diff
==============================================================================
---
james/imap/trunk/jcr/src/main/java/org/apache/james/imap/jcr/user/JCRSubscriptionMapper.java
(original)
+++
james/imap/trunk/jcr/src/main/java/org/apache/james/imap/jcr/user/JCRSubscriptionMapper.java
Sun Jun 27 13:06:37 2010
@@ -90,13 +90,13 @@ public class JCRSubscriptionMapper exten
}
+
+
/*
* (non-Javadoc)
- *
- * @see org.apache.james.imap.store.user.SubscriptionMapper#
- * findFindMailboxSubscriptionForUser(java.lang.String, java.lang.String)
+ * @see
org.apache.james.imap.store.user.SubscriptionMapper#findMailboxSubscriptionForUser(java.lang.String,
java.lang.String)
*/
- public Subscription findFindMailboxSubscriptionForUser(String user, String
mailbox) throws SubscriptionException {
+ public Subscription findMailboxSubscriptionForUser(String user, String
mailbox) throws SubscriptionException {
try {
String queryString = "/jcr:root/" + MAILBOXES_PATH +
"//element(*,jamesMailbox:user)[@" + JCRSubscription.USERNAME_PROPERTY + "='" +
user + "'] AND [@" + JCRSubscription.MAILBOXES_PROPERTY +"='" + mailbox + "']";
@@ -168,7 +168,7 @@ public class JCRSubscriptionMapper exten
Node node = null;
- JCRSubscription sub = (JCRSubscription)
findFindMailboxSubscriptionForUser(username, mailbox);
+ JCRSubscription sub = (JCRSubscription)
findMailboxSubscriptionForUser(username, mailbox);
// its a new subscription
if (sub == null) {
Modified:
james/imap/trunk/jpa/src/main/java/org/apache/james/imap/jpa/mail/model/AbstractJPAMailboxMembership.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/jpa/src/main/java/org/apache/james/imap/jpa/mail/model/AbstractJPAMailboxMembership.java?rev=958383&r1=958382&r2=958383&view=diff
==============================================================================
---
james/imap/trunk/jpa/src/main/java/org/apache/james/imap/jpa/mail/model/AbstractJPAMailboxMembership.java
(original)
+++
james/imap/trunk/jpa/src/main/java/org/apache/james/imap/jpa/mail/model/AbstractJPAMailboxMembership.java
Sun Jun 27 13:06:37 2010
@@ -35,6 +35,7 @@ import org.apache.james.imap.mailbox.Mai
import org.apache.james.imap.store.mail.model.AbstractMailboxMembership;
import org.apache.james.imap.store.mail.model.MailboxMembership;
import org.apache.james.imap.store.mail.model.PropertyBuilder;
+import org.apache.openjpa.persistence.jdbc.Index;
@MappedSuperclass
@IdClass(AbstractJPAMailboxMembership.MailboxIdUidKey.class)
@@ -122,7 +123,7 @@ public abstract class AbstractJPAMailbox
@Basic(optional=false) private boolean answered = false;
/** The value for the deleted field */
- @Basic(optional=false) private boolean deleted = false;
+ @Basic(optional=false) @Index private boolean deleted = false;
/** The value for the draft field */
@Basic(optional=false) private boolean draft = false;
@@ -131,10 +132,10 @@ public abstract class AbstractJPAMailbox
@Basic(optional=false) private boolean flagged = false;
/** The value for the recent field */
- @Basic(optional=false) private boolean recent = false;
+ @Basic(optional=false) @Index private boolean recent = false;
/** The value for the seen field */
- @Basic(optional=false) private boolean seen = false;
+ @Basic(optional=false) @Index private boolean seen = false;
/**
Modified:
james/imap/trunk/jpa/src/main/java/org/apache/james/imap/jpa/user/JPASubscriptionMapper.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/jpa/src/main/java/org/apache/james/imap/jpa/user/JPASubscriptionMapper.java?rev=958383&r1=958382&r2=958383&view=diff
==============================================================================
---
james/imap/trunk/jpa/src/main/java/org/apache/james/imap/jpa/user/JPASubscriptionMapper.java
(original)
+++
james/imap/trunk/jpa/src/main/java/org/apache/james/imap/jpa/user/JPASubscriptionMapper.java
Sun Jun 27 13:06:37 2010
@@ -39,11 +39,12 @@ public class JPASubscriptionMapper exten
super(entityManagerFactory);
}
- /**
- * @throws SubscriptionException
- * @see
org.apache.james.imap.store.user.SubscriptionMapper#findFindMailboxSubscriptionForUser(java.lang.String,
java.lang.String)
+
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.imap.store.user.SubscriptionMapper#findMailboxSubscriptionForUser(java.lang.String,
java.lang.String)
*/
- public Subscription findFindMailboxSubscriptionForUser(final String user,
final String mailbox) throws SubscriptionException {
+ public Subscription findMailboxSubscriptionForUser(final String user,
final String mailbox) throws SubscriptionException {
try {
return (Subscription)
getEntityManager().createNamedQuery("findFindMailboxSubscriptionForUser")
.setParameter("userParam", user).setParameter("mailboxParam",
mailbox).getSingleResult();
Modified:
james/imap/trunk/mailbox/src/main/java/org/apache/james/imap/mailbox/MailboxSession.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/mailbox/src/main/java/org/apache/james/imap/mailbox/MailboxSession.java?rev=958383&r1=958382&r2=958383&view=diff
==============================================================================
---
james/imap/trunk/mailbox/src/main/java/org/apache/james/imap/mailbox/MailboxSession.java
(original)
+++
james/imap/trunk/mailbox/src/main/java/org/apache/james/imap/mailbox/MailboxSession.java
Sun Jun 27 13:06:37 2010
@@ -119,6 +119,11 @@ public interface MailboxSession {
public Collection<Namespace> getSharedSpaces();
+ /**
+ * Return the stored attributes for this {...@link MailboxSession}.
+ *
+ * @return attributes
+ */
public Map<Object,Object> getAttributes();
/**
Modified:
james/imap/trunk/mailbox/src/main/java/org/apache/james/imap/mailbox/MimeDescriptor.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/mailbox/src/main/java/org/apache/james/imap/mailbox/MimeDescriptor.java?rev=958383&r1=958382&r2=958383&view=diff
==============================================================================
---
james/imap/trunk/mailbox/src/main/java/org/apache/james/imap/mailbox/MimeDescriptor.java
(original)
+++
james/imap/trunk/mailbox/src/main/java/org/apache/james/imap/mailbox/MimeDescriptor.java
Sun Jun 27 13:06:37 2010
@@ -133,12 +133,6 @@ public interface MimeDescriptor extends
*/
public MimeDescriptor embeddedMessage();
- /**
- * Gets headers.
- *
- * @return <code>Header</code> <code>Iterator</code>, not null
- */
- public Iterator<Header> headers();
/**
* Gets MIME body parameters parsed from <code>Content-Type</code>.
Modified:
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/mail/InMemoryMailboxMapper.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/mail/InMemoryMailboxMapper.java?rev=958383&r1=958382&r2=958383&view=diff
==============================================================================
---
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/mail/InMemoryMailboxMapper.java
(original)
+++
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/mail/InMemoryMailboxMapper.java
Sun Jun 27 13:06:37 2010
@@ -112,9 +112,11 @@ public class InMemoryMailboxMapper imple
transaction.run();
}
+ /**
+ * Do nothing
+ */
public void endRequest() {
- // TODO Auto-generated method stub
-
+ // Do nothing
}
/*
Modified:
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/mail/InMemoryMessageMapper.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/mail/InMemoryMessageMapper.java?rev=958383&r1=958382&r2=958383&view=diff
==============================================================================
---
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/mail/InMemoryMessageMapper.java
(original)
+++
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/mail/InMemoryMessageMapper.java
Sun Jun 27 13:06:37 2010
@@ -64,6 +64,10 @@ public class InMemoryMessageMapper imple
getMembershipByUidForMailbox(mailboxId).remove(message.getUid());
}
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.imap.store.mail.MessageMapper#findInMailbox(java.lang.Object,
org.apache.james.imap.mailbox.MessageRange)
+ */
@SuppressWarnings("unchecked")
public List<MailboxMembership<Long>> findInMailbox(Long mailboxId,
MessageRange set) throws StorageException {
final List<MailboxMembership<Long>> results;
@@ -181,6 +185,9 @@ public class InMemoryMessageMapper imple
mailboxByUid.clear();
}
+ /**
+ * Do nothing
+ */
public void endRequest() {
// Do nothing
}
Modified:
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/user/InMemorySubscriptionMapper.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/user/InMemorySubscriptionMapper.java?rev=958383&r1=958382&r2=958383&view=diff
==============================================================================
---
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/user/InMemorySubscriptionMapper.java
(original)
+++
james/imap/trunk/memory/src/main/java/org/apache/james/imap/inmemory/user/InMemorySubscriptionMapper.java
Sun Jun 27 13:06:37 2010
@@ -37,6 +37,10 @@ public class InMemorySubscriptionMapper
subscriptionsByUser = new ConcurrentHashMap<String,
List<Subscription>>(INITIAL_SIZE);
}
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.imap.store.user.SubscriptionMapper#delete(org.apache.james.imap.store.user.model.Subscription)
+ */
public synchronized void delete(Subscription subscription) {
final String user = subscription.getUser();
final List<Subscription> subscriptions = subscriptionsByUser.get(user);
@@ -45,7 +49,11 @@ public class InMemorySubscriptionMapper
}
}
- public Subscription findFindMailboxSubscriptionForUser(String user, String
mailbox) {
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.imap.store.user.SubscriptionMapper#findMailboxSubscriptionForUser(java.lang.String,
java.lang.String)
+ */
+ public Subscription findMailboxSubscriptionForUser(String user, String
mailbox) {
final List<Subscription> subscriptions = subscriptionsByUser.get(user);
Subscription result = null;
if (subscriptions != null) {
@@ -59,6 +67,10 @@ public class InMemorySubscriptionMapper
return result;
}
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.imap.store.user.SubscriptionMapper#findSubscriptionsForUser(java.lang.String)
+ */
@SuppressWarnings("unchecked")
public List<Subscription> findSubscriptionsForUser(String user) {
final List<Subscription> subcriptions = subscriptionsByUser.get(user);
@@ -72,6 +84,10 @@ public class InMemorySubscriptionMapper
return results;
}
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.imap.store.user.SubscriptionMapper#save(org.apache.james.imap.store.user.model.Subscription)
+ */
public synchronized void save(Subscription subscription) {
final String user = subscription.getUser();
final List<Subscription> subscriptions = subscriptionsByUser.get(user);
@@ -84,6 +100,10 @@ public class InMemorySubscriptionMapper
}
}
+ /*
+ * (non-Javadoc)
+ * @see
org.apache.james.imap.store.transaction.TransactionalMapper#execute(org.apache.james.imap.store.transaction.TransactionalMapper.Transaction)
+ */
public void execute(Transaction transaction) throws MailboxException {
transaction.run();
}
@@ -92,8 +112,11 @@ public class InMemorySubscriptionMapper
subscriptionsByUser.clear();
}
+ /**
+ * Do nothing
+ */
public void endRequest() {
- // TODO Auto-generated method stub
+ // nothing todo
}
Modified:
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/Authenticator.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/store/src/main/java/org/apache/james/imap/store/Authenticator.java?rev=958383&r1=958382&r2=958383&view=diff
==============================================================================
---
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/Authenticator.java
(original)
+++
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/Authenticator.java
Sun Jun 27 13:06:37 2010
@@ -26,6 +26,7 @@ public interface Authenticator {
/**
* Is the given user authentic?
+ *
* @param userid not null
* @param passwd not null
* @return true when the user is authentic,
Modified:
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/StoreSubscriptionManager.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/store/src/main/java/org/apache/james/imap/store/StoreSubscriptionManager.java?rev=958383&r1=958382&r2=958383&view=diff
==============================================================================
---
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/StoreSubscriptionManager.java
(original)
+++
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/StoreSubscriptionManager.java
Sun Jun 27 13:06:37 2010
@@ -52,7 +52,7 @@ public abstract class StoreSubscriptionM
mapper.execute(new TransactionalMapper.Transaction() {
public void run() throws MailboxException {
- final Subscription subscription =
mapper.findFindMailboxSubscriptionForUser(session.getUser().getUserName(),
mailbox);
+ final Subscription subscription =
mapper.findMailboxSubscriptionForUser(session.getUser().getUserName(), mailbox);
if (subscription == null) {
final Subscription newSubscription =
createSubscription(session, mailbox);
mapper.save(newSubscription);
@@ -98,7 +98,7 @@ public abstract class StoreSubscriptionM
mapper.execute(new TransactionalMapper.Transaction() {
public void run() throws MailboxException {
- final Subscription subscription =
mapper.findFindMailboxSubscriptionForUser(session.getUser().getUserName(),
mailbox);
+ final Subscription subscription =
mapper.findMailboxSubscriptionForUser(session.getUser().getUserName(), mailbox);
if (subscription != null) {
mapper.delete(subscription);
}
Modified:
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/user/SubscriptionMapper.java
URL:
http://svn.apache.org/viewvc/james/imap/trunk/store/src/main/java/org/apache/james/imap/store/user/SubscriptionMapper.java?rev=958383&r1=958382&r2=958383&view=diff
==============================================================================
---
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/user/SubscriptionMapper.java
(original)
+++
james/imap/trunk/store/src/main/java/org/apache/james/imap/store/user/SubscriptionMapper.java
Sun Jun 27 13:06:37 2010
@@ -38,7 +38,7 @@ public interface SubscriptionMapper exte
* @return <code>Subscription</code>,
* or null when the user is not subscribed to the given mailbox
*/
- public abstract Subscription findFindMailboxSubscriptionForUser(
+ public abstract Subscription findMailboxSubscriptionForUser(
final String user, final String mailbox) throws
SubscriptionException;
/**
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
