AccountSummary.java

/**
 * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright ownership. Apereo
 * 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 the
 * following location:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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.jasig.portlet.emailpreview;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * Encapsulates basic information about the email INBOX. Typically sent to the browser via AJAX.
 *
 * @author Andreas Christoforides
 * @author Jen Bourey, jbourey@unicon.net
 * @author Drew Wills, drew@unicon.net
 */
public final class AccountSummary {

  private final String inboxUrl;
  private final List<? extends EmailMessage> messages;
  private final int numUnreadMessages;
  private final int numTotalMessages;
  private final int messagesStart;
  private final int messagesMax;
  private final boolean deleteSupported;
  private final Throwable errorCause;
  private final EmailQuota quota;

  public AccountSummary(
      String inboxUrl,
      List<? extends EmailMessage> messages,
      int numUnreadMessages,
      int numTotalMessages,
      int messagesStart,
      int messagesMax,
      boolean deleteSupported,
      EmailQuota quota) {

    // Assertions
    if (messages == null) {
      String msg = "Argument 'messages' cannot be null";
      throw new IllegalArgumentException(msg);
    }

    // Instance Members
    this.inboxUrl = inboxUrl; // NB:  May be null
    this.messages = Collections.unmodifiableList(new ArrayList<EmailMessage>(messages));
    this.numUnreadMessages = numUnreadMessages;
    this.numTotalMessages = numTotalMessages;
    this.messagesStart = messagesStart;
    this.messagesMax = messagesMax;
    this.deleteSupported = deleteSupported;
    this.errorCause = null;
    this.quota = quota;
  }

  /**
   * Indicates the account fetch did not succeed and provides the cause. Previously we would
   * communicate this fact by throwing an exception, but we learned that (1) the caching API we use
   * writes these exceptions to Catalina.out, and (2) occurances of {@link
   * MailAuthenticationException} are very common, and the logs were being flooded with them.
   *
   * @param errorCause
   */
  public AccountSummary(Throwable errorCause) {

    // Assertions.
    if (errorCause == null) {
      String msg = "Argument 'errorCause' cannot be null";
      throw new IllegalArgumentException(msg);
    }

    // Instance Members
    this.inboxUrl = null;
    this.numUnreadMessages = -1;
    this.numTotalMessages = -1;
    this.messages = null;
    this.messagesStart = -1;
    this.messagesMax = -1;
    this.deleteSupported = false;
    this.errorCause = errorCause;
    this.quota = null;
  }

  /**
   * Indicates if this object contains valid account details. Otherwise, it will contain an error
   * payload.
   *
   * @return False if this object represents an error condition instead of an account summary
   */
  public boolean isValid() {
    return errorCause == null;
  }

  public Throwable getErrorCause() {
    return errorCause;
  }

  /**
   * Provides the URL to the full-featured web-based mail client, if available.
   *
   * @return A valid web address or <code>null</code>
   */
  public String getInboxUrl() {
    return inboxUrl;
  }

  /**
   * Returns the number of unread messages in the user's inbox.
   *
   * @return The number of unread messages in the user's inbox.
   */
  public int getUnreadMessageCount() {
    return this.numUnreadMessages;
  }

  /**
   * Returns the total number messages in the user's inbox.
   *
   * @return The total number of messages in the user's inbox.
   */
  public int getTotalMessageCount() {
    return this.numTotalMessages;
  }

  /**
   * Returns a list that contains the emails bound by <code>messagesStart</code> and <code>
   * messagesCode</code>.
   *
   * @return A <code>List<EmailMessage></code> containing information about emails in the user's
   *     inbox
   */
  public List<? extends EmailMessage> getMessages() {

    return this.messages;
  }

  /**
   * Returns the index of the first message in the Messages list.
   *
   * @return
   */
  public int getMessagesStart() {
    return this.messagesStart;
  }

  /**
   * Returns the number of messages requested for the Messages list. The actual size of the list may
   * be lower.
   *
   * @return
   */
  public int getMessagesMax() {
    return this.messagesMax;
  }

  public boolean isDeleteSupported() {
    return deleteSupported;
  }

  /**
   * Returns the value of disk space , max & used
   *
   * @return
   */
  public EmailQuota getQuota() {
    return quota;
  }
}