org.apache.james.imap.message.request.AbstractMailboxSelectionRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of protocols-imap
There is a newer version: 3.8.1
/****************************************************************
 * 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.message.request;

import java.util.Objects;

import org.apache.james.imap.api.ImapCommand;
import org.apache.james.imap.api.Tag;
import org.apache.james.imap.api.message.IdRange;
import org.apache.james.imap.api.message.UidRange;
import org.apache.james.imap.api.message.request.ImapRequest;
import org.apache.james.mailbox.model.UidValidity;

import com.google.common.base.Preconditions;

/**
 * {@link ImapRequest} which selects a Mailbox. 
 * 
 * This supports also the CONDSTORE and the QRESYNC extension
 */
public abstract class AbstractMailboxSelectionRequest extends AbstractImapRequest {
    public interface ClientSpecifiedUidValidity {
        ClientSpecifiedUidValidity UNKNOWN = new ClientSpecifiedUidValidity() {
            @Override
            public boolean isUnknown() {
                return true;
            }

            @Override
            public boolean correspondsTo(UidValidity uidValidity) {
                return false;
            }

            @Override
            public String toString() {
                return "UidValidity{UNKNOWN}";
            }
        };

        static ClientSpecifiedUidValidity of(long value) {
            if (UidValidity.isValid(value)) {
                return valid(UidValidity.of(value));
            }
            return invalid(value);
        }

        class Invalid implements ClientSpecifiedUidValidity {
            private final long invalidUidValidity;

            public Invalid(long invalidUidValidity) {
                Preconditions.checkArgument(!UidValidity.isValid(invalidUidValidity), "Need to supply an invalid value");
                this.invalidUidValidity = invalidUidValidity;
            }

            @Override
            public boolean isUnknown() {
                return false;
            }

            @Override
            public boolean correspondsTo(UidValidity uidValidity) {
                return false;
            }

            @Override
            public final boolean equals(Object o) {
                if (o instanceof Invalid) {
                    Invalid invalid = (Invalid) o;

                    return Objects.equals(this.invalidUidValidity, invalid.invalidUidValidity);
                }
                return false;
            }

            @Override
            public final int hashCode() {
                return Objects.hash(invalidUidValidity);
            }

            @Override
            public String toString() {
                return String.format("Invalid UidValidity{%d}", invalidUidValidity);
            }
        }

        class Valid implements ClientSpecifiedUidValidity {
            private final UidValidity uidValidity;

            public Valid(UidValidity uidValidity) {
                this.uidValidity = uidValidity;
            }

            @Override
            public boolean isUnknown() {
                return false;
            }

            @Override
            public boolean correspondsTo(UidValidity uidValidity) {
                return this.uidValidity.equals(uidValidity);
            }

            @Override
            public final boolean equals(Object o) {
                if (o instanceof Valid) {
                    Valid valid = (Valid) o;

                    return Objects.equals(this.uidValidity, valid.uidValidity);
                }
                return false;
            }

            @Override
            public final int hashCode() {
                return Objects.hash(uidValidity);
            }

            @Override
            public String toString() {
                return String.format("UidValidity{%d}", uidValidity.asLong());
            }
        }

        static ClientSpecifiedUidValidity invalid(long invalidValue) {
            return new Invalid(invalidValue);
        }

        static ClientSpecifiedUidValidity valid(UidValidity uidValidity) {
            return new Valid(uidValidity);
        }

        boolean isUnknown();

        boolean correspondsTo(UidValidity uidValidity);
    }

    private final String mailboxName;
    private final boolean condstore;
    private final ClientSpecifiedUidValidity lastKnownUidValidity;
    private final Long knownModSeq;
    private final UidRange[] uidSet;
    private final UidRange[] knownUidSet;
    private final IdRange[] knownSequenceSet;

    public AbstractMailboxSelectionRequest(ImapCommand command, String mailboxName, boolean condstore, ClientSpecifiedUidValidity lastKnownUidValidity, Long knownModSeq, UidRange[] uidSet, UidRange[] knownUidSet, IdRange[] knownSequenceSet, Tag tag) {
        super(tag, command);
        this.mailboxName = mailboxName;
        this.condstore = condstore;
        this.lastKnownUidValidity = lastKnownUidValidity;
        this.knownModSeq = knownModSeq;
        if ((lastKnownUidValidity.isUnknown() && knownModSeq != null) || (! lastKnownUidValidity.isUnknown() && knownModSeq == null)) {
            throw new IllegalArgumentException();
        }
        this.uidSet = uidSet;
        this.knownUidSet = knownUidSet;
        this.knownSequenceSet = knownSequenceSet;
    }

    /**
     * Return the mailbox to select
     * 
     * @return mailboxName
     */
    public final String getMailboxName() {
        return mailboxName;
    }
    
    /**
     * Return true if the CONDSTORE option was used while selecting the mailbox
     * 
     * @return condstore
     */
    public final boolean getCondstore() {
        return condstore;
    }
    
    /**
     * Return the last known UIDVALIDITY or null if it was not given. This is a MUST parameter when
     * using the QRESYNC option. So if this returns null you can be sure the QRESYNC was not used
     * 
     * @return lastKnownUidValidity
     */
    public final ClientSpecifiedUidValidity getLastKnownUidValidity() {
        return lastKnownUidValidity;
    }
    
    /**
     * Return the known MODSEQ or null if it was not given. This is a MUST parameter when
     * using the QRESYNC option. So if this returns null you can be sure the QRESYNC was not used
     * 
     * @return knownModSeq
     */
    public final Long getKnownModSeq() {
        return knownModSeq;
    }
    
   
    /**
     * Return the known uid set or null if it was not given. This is a OPTIONAL parameter when
     * using the QRESYNC option. 
     */
    public final UidRange[] getUidSet() {
        return uidSet;
    }
    
    /**
     * Return the known sequence-set or null if it was not given. This known sequence-set has the corresponding uids in {@link #getKnownUidSet()}. This is a OPTIONAL parameter when
     * using the QRESYNC option. 
     * 
     * @return knownSequenceSet
     */
    public final IdRange[] getKnownSequenceSet() {
        return knownSequenceSet;
    }
    
    
    /**
     * Return the known uid set or null if it was not given. This known uid set has the corresponding message numbers in {@link #getKnownSequenceSet()}. This is a OPTIONAL parameter when
     * using the QRESYNC option. 
     */
    public final UidRange[] getKnownUidSet() {
        return knownUidSet;
    }
}