Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.apache.james.mailbox.events.MailboxEvents Maven / Gradle / Ivy
/****************************************************************
* 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.mailbox.events;
import java.time.Instant;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.SortedMap;
import org.apache.james.core.Username;
import org.apache.james.core.quota.QuotaCountLimit;
import org.apache.james.core.quota.QuotaCountUsage;
import org.apache.james.core.quota.QuotaSizeLimit;
import org.apache.james.core.quota.QuotaSizeUsage;
import org.apache.james.events.Event;
import org.apache.james.mailbox.MailboxSession;
import org.apache.james.mailbox.MessageUid;
import org.apache.james.mailbox.acl.ACLDiff;
import org.apache.james.mailbox.model.MailboxACL;
import org.apache.james.mailbox.model.MailboxId;
import org.apache.james.mailbox.model.MailboxPath;
import org.apache.james.mailbox.model.MessageId;
import org.apache.james.mailbox.model.MessageMetaData;
import org.apache.james.mailbox.model.Quota;
import org.apache.james.mailbox.model.QuotaRoot;
import org.apache.james.mailbox.model.UpdatedFlags;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
public interface MailboxEvents {
interface QuotaEvent extends Event {
QuotaRoot getQuotaRoot();
}
class QuotaUsageUpdatedEvent implements QuotaEvent {
private final EventId eventId;
private final Username username;
private final QuotaRoot quotaRoot;
private final Quota countQuota;
private final Quota sizeQuota;
private final Instant instant;
public QuotaUsageUpdatedEvent(EventId eventId, Username username, QuotaRoot quotaRoot, Quota countQuota, Quota sizeQuota, Instant instant) {
this.eventId = eventId;
this.username = username;
this.quotaRoot = quotaRoot;
this.countQuota = countQuota;
this.sizeQuota = sizeQuota;
this.instant = instant;
}
@Override
public boolean isNoop() {
return false;
}
@Override
public Username getUsername() {
return username;
}
public Quota getCountQuota() {
return countQuota;
}
public Quota getSizeQuota() {
return sizeQuota;
}
@Override
public QuotaRoot getQuotaRoot() {
return quotaRoot;
}
public Instant getInstant() {
return instant;
}
@Override
public EventId getEventId() {
return eventId;
}
@Override
public final boolean equals(Object o) {
if (o instanceof QuotaUsageUpdatedEvent) {
QuotaUsageUpdatedEvent that = (QuotaUsageUpdatedEvent) o;
return Objects.equals(this.eventId, that.eventId)
&& Objects.equals(this.username, that.username)
&& Objects.equals(this.quotaRoot, that.quotaRoot)
&& Objects.equals(this.countQuota, that.countQuota)
&& Objects.equals(this.sizeQuota, that.sizeQuota)
&& Objects.equals(this.instant, that.instant);
}
return false;
}
@Override
public final int hashCode() {
return Objects.hash(eventId, username, quotaRoot, countQuota, sizeQuota, instant);
}
}
/**
* A mailbox event.
*/
abstract class MailboxEvent implements Event {
protected final MailboxPath path;
protected final MailboxId mailboxId;
protected final Username username;
protected final MailboxSession.SessionId sessionId;
protected final EventId eventId;
public MailboxEvent(MailboxSession.SessionId sessionId, Username username, MailboxPath path, MailboxId mailboxId, EventId eventId) {
this.username = username;
this.path = path;
this.mailboxId = mailboxId;
this.sessionId = sessionId;
this.eventId = eventId;
}
/**
* Gets the {@link Username} in which's context the {@link MailboxEvent}
* happened
*
* @return user
*/
@Override
public Username getUsername() {
return username;
}
@Override
public EventId getEventId() {
return eventId;
}
/**
* Gets the sessionId in which's context the {@link MailboxEvent}
* happened
*
* @return sessionId
*/
public MailboxSession.SessionId getSessionId() {
return sessionId;
}
/**
* Return the path of the Mailbox this event belongs to.
*
* @return path
*/
public MailboxPath getMailboxPath() {
return path;
}
/**
* Return the id of the Mailbox this event belongs to.
*
* @return mailboxId
*/
public MailboxId getMailboxId() {
return mailboxId;
}
}
/**
* Indicates that mailbox has been deleted.
*/
class MailboxDeletion extends MailboxEvent {
private final MailboxACL mailboxACL;
private final QuotaRoot quotaRoot;
private final QuotaCountUsage deletedMessageCount;
private final QuotaSizeUsage totalDeletedSize;
public MailboxDeletion(MailboxSession.SessionId sessionId, Username username, MailboxPath path, MailboxACL mailboxACL, QuotaRoot quotaRoot, QuotaCountUsage deletedMessageCount, QuotaSizeUsage totalDeletedSize,
MailboxId mailboxId, EventId eventId) {
super(sessionId, username, path, mailboxId, eventId);
this.mailboxACL = mailboxACL;
this.quotaRoot = quotaRoot;
this.deletedMessageCount = deletedMessageCount;
this.totalDeletedSize = totalDeletedSize;
}
@Override
public boolean isNoop() {
return false;
}
public MailboxACL getMailboxACL() {
return mailboxACL;
}
public QuotaRoot getQuotaRoot() {
return quotaRoot;
}
public QuotaCountUsage getDeletedMessageCount() {
return deletedMessageCount;
}
public QuotaSizeUsage getTotalDeletedSize() {
return totalDeletedSize;
}
@Override
public final boolean equals(Object o) {
if (o instanceof MailboxDeletion) {
MailboxDeletion that = (MailboxDeletion) o;
return Objects.equals(this.eventId, that.eventId)
&& Objects.equals(this.sessionId, that.sessionId)
&& Objects.equals(this.username, that.username)
&& Objects.equals(this.path, that.path)
&& Objects.equals(this.mailboxACL, that.mailboxACL)
&& Objects.equals(this.mailboxId, that.mailboxId)
&& Objects.equals(this.quotaRoot, that.quotaRoot)
&& Objects.equals(this.deletedMessageCount, that.deletedMessageCount)
&& Objects.equals(this.totalDeletedSize, that.totalDeletedSize);
}
return false;
}
@Override
public final int hashCode() {
return Objects.hash(eventId, sessionId, username, path, mailboxACL, mailboxId, quotaRoot, deletedMessageCount, totalDeletedSize);
}
}
/**
* Indicates that a mailbox has been Added.
*/
class MailboxAdded extends MailboxEvent {
public MailboxAdded(MailboxSession.SessionId sessionId, Username username, MailboxPath path, MailboxId mailboxId, EventId eventId) {
super(sessionId, username, path, mailboxId, eventId);
}
@Override
public boolean isNoop() {
return false;
}
@Override
public final boolean equals(Object o) {
if (o instanceof MailboxAdded) {
MailboxAdded that = (MailboxAdded) o;
return Objects.equals(this.eventId, that.eventId)
&& Objects.equals(this.sessionId, that.sessionId)
&& Objects.equals(this.username, that.username)
&& Objects.equals(this.path, that.path)
&& Objects.equals(this.mailboxId, that.mailboxId);
}
return false;
}
@Override
public final int hashCode() {
return Objects.hash(eventId, sessionId, username, path, mailboxId);
}
}
/**
* Indicates that a mailbox has been renamed.
*/
class MailboxRenamed extends MailboxEvent {
private final MailboxPath newPath;
public MailboxRenamed(MailboxSession.SessionId sessionId, Username username, MailboxPath path, MailboxId mailboxId, MailboxPath newPath, EventId eventId) {
super(sessionId, username, path, mailboxId, eventId);
this.newPath = newPath;
}
@Override
public boolean isNoop() {
return newPath.equals(path);
}
/**
* Gets the new name for this mailbox.
*
* @return name, not null
*/
public MailboxPath getNewPath() {
return newPath;
}
@Override
public final boolean equals(Object o) {
if (o instanceof MailboxRenamed) {
MailboxRenamed that = (MailboxRenamed) o;
return Objects.equals(this.eventId, that.eventId)
&& Objects.equals(this.sessionId, that.sessionId)
&& Objects.equals(this.username, that.username)
&& Objects.equals(this.path, that.path)
&& Objects.equals(this.mailboxId, that.mailboxId)
&& Objects.equals(this.newPath, that.newPath);
}
return false;
}
@Override
public final int hashCode() {
return Objects.hash(eventId, sessionId, username, path, mailboxId, newPath);
}
}
/**
* A mailbox event related to updated ACL
*/
class MailboxACLUpdated extends MailboxEvent {
private final ACLDiff aclDiff;
public MailboxACLUpdated(MailboxSession.SessionId sessionId, Username username, MailboxPath path, ACLDiff aclDiff, MailboxId mailboxId, EventId eventId) {
super(sessionId, username, path, mailboxId, eventId);
this.aclDiff = aclDiff;
}
public ACLDiff getAclDiff() {
return aclDiff;
}
@Override
public boolean isNoop() {
return aclDiff.getNewACL().equals(aclDiff.getOldACL());
}
@Override
public final boolean equals(Object o) {
if (o instanceof MailboxACLUpdated) {
MailboxACLUpdated that = (MailboxACLUpdated) o;
return Objects.equals(this.eventId, that.eventId)
&& Objects.equals(this.sessionId, that.sessionId)
&& Objects.equals(this.username, that.username)
&& Objects.equals(this.path, that.path)
&& Objects.equals(this.aclDiff, that.aclDiff)
&& Objects.equals(this.mailboxId, that.mailboxId);
}
return false;
}
@Override
public final int hashCode() {
return Objects.hash(eventId, sessionId, username, path, aclDiff, mailboxId);
}
}
/**
* A mailbox event related to a message.
*/
abstract class MessageEvent extends MailboxEvent {
public MessageEvent(MailboxSession.SessionId sessionId, Username username, MailboxPath path, MailboxId mailboxId, EventId eventId) {
super(sessionId, username, path, mailboxId, eventId);
}
/**
* Gets the message UIDs for the subject of this event.
*
* @return message uids
*/
public abstract Collection getUids();
}
abstract class MetaDataHoldingEvent extends MessageEvent {
public MetaDataHoldingEvent(MailboxSession.SessionId sessionId, Username username, MailboxPath path, MailboxId mailboxId, EventId eventId) {
super(sessionId, username, path, mailboxId, eventId);
}
/**
* Return the flags which were set for the affected message
*
* @return flags
*/
public abstract MessageMetaData getMetaData(MessageUid uid);
public ImmutableSet getMessageIds() {
return getUids()
.stream()
.map(uid -> getMetaData(uid).getMessageId())
.collect(ImmutableSet.toImmutableSet());
}
}
class Expunged extends MetaDataHoldingEvent {
private final Map expunged;
public Expunged(MailboxSession.SessionId sessionId, Username username, MailboxPath path, MailboxId mailboxId, Map uids, EventId eventId) {
super(sessionId, username, path, mailboxId, eventId);
this.expunged = ImmutableMap.copyOf(uids);
}
@Override
public Collection getUids() {
return expunged.keySet();
}
/**
* Return the flags which were set for the added message
*
* @return flags
*/
@Override
public MessageMetaData getMetaData(MessageUid uid) {
return expunged.get(uid);
}
public Map getExpunged() {
return expunged;
}
@Override
public boolean isNoop() {
return expunged.isEmpty();
}
@Override
public final boolean equals(Object o) {
if (o instanceof Expunged) {
Expunged that = (Expunged) o;
return Objects.equals(this.eventId, that.eventId)
&& Objects.equals(this.sessionId, that.sessionId)
&& Objects.equals(this.username, that.username)
&& Objects.equals(this.path, that.path)
&& Objects.equals(this.mailboxId, that.mailboxId)
&& Objects.equals(this.expunged, that.expunged);
}
return false;
}
@Override
public final int hashCode() {
return Objects.hash(eventId, sessionId, username, path, mailboxId, expunged);
}
}
/**
* A mailbox event related to updated flags
*/
class FlagsUpdated extends MessageEvent {
private final List updatedFlags;
public FlagsUpdated(MailboxSession.SessionId sessionId, Username username, MailboxPath path,
MailboxId mailboxId, List updatedFlags, EventId eventId) {
super(sessionId, username, path, mailboxId, eventId);
this.updatedFlags = ImmutableList.copyOf(updatedFlags);
}
@Override
public Collection getUids() {
return updatedFlags.stream()
.map(UpdatedFlags::getUid)
.collect(ImmutableList.toImmutableList());
}
public Collection getMessageIds() {
return updatedFlags.stream()
.map(UpdatedFlags::getMessageId)
.flatMap(Optional::stream)
.collect(ImmutableList.toImmutableList());
}
public List getUpdatedFlags() {
return updatedFlags;
}
@Override
public boolean isNoop() {
return updatedFlags.isEmpty();
}
@Override
public final boolean equals(Object o) {
if (o instanceof FlagsUpdated) {
FlagsUpdated that = (FlagsUpdated) o;
return Objects.equals(this.eventId, that.eventId)
&& Objects.equals(this.sessionId, that.sessionId)
&& Objects.equals(this.username, that.username)
&& Objects.equals(this.path, that.path)
&& Objects.equals(this.mailboxId, that.mailboxId)
&& Objects.equals(this.updatedFlags, that.updatedFlags);
}
return false;
}
@Override
public final int hashCode() {
return Objects.hash(eventId, sessionId, username, path, mailboxId, updatedFlags);
}
}
/**
* A mailbox event related to added message
*/
class Added extends MetaDataHoldingEvent {
private final Map added;
public Added(MailboxSession.SessionId sessionId, Username username, MailboxPath path, MailboxId mailboxId,
SortedMap uids, EventId eventId) {
super(sessionId, username, path, mailboxId, eventId);
this.added = ImmutableMap.copyOf(uids);
}
/**
* Return the flags which were set for the added message
*
* @return flags
*/
public MessageMetaData getMetaData(MessageUid uid) {
return added.get(uid);
}
@Override
public Collection getUids() {
return added.keySet();
}
public Map getAdded() {
return added;
}
@Override
public boolean isNoop() {
return added.isEmpty();
}
@Override
public final boolean equals(Object o) {
if (o instanceof Added) {
Added that = (Added) o;
return Objects.equals(this.eventId, that.eventId)
&& Objects.equals(this.sessionId, that.sessionId)
&& Objects.equals(this.username, that.username)
&& Objects.equals(this.path, that.path)
&& Objects.equals(this.mailboxId, that.mailboxId)
&& Objects.equals(this.added, that.added);
}
return false;
}
@Override
public final int hashCode() {
return Objects.hash(eventId, sessionId, username, path, mailboxId, added);
}
}
}
