com.yahoo.imapnio.async.client.ImapAsyncSession Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of imapnio.core Show documentation

imapnio component ${project.name}

The newest version!

package com.yahoo.imapnio.async.client;

import javax.annotation.Nonnull;

import com.yahoo.imapnio.async.exception.ImapAsyncClientException;
import com.yahoo.imapnio.async.request.ImapRequest;
import com.yahoo.imapnio.async.response.ImapAsyncResponse;

/**
 * A class that defines the behavior of Asynchronous IMAP session.
 */
public interface ImapAsyncSession {
    /**
     * Flag to turn on or off debugging for this session.
     */
    enum DebugMode {
        /** Debugging is off for this session. */
        DEBUG_OFF,
        /** Debugging is on for this session. */
        DEBUG_ON
    }

    /**
     * Starts the compression, assuming caller verified the support of compression capability in server.
     *
     * @param  the data type for returning in getNextCommandLineAfterContinuation call
     *
     * @return the future object for this command
     * @throws ImapAsyncClientException on failure
     */
     ImapFuture startCompression() throws ImapAsyncClientException;

    /**
     * Turns on or off the debugging.
     *
     * @param debugMode the debugging mode
     */
    void setDebugMode(DebugMode debugMode);

    /**
     * Sends a IMAP command to the server.
     *
     * @param  the data type for returning in getNextCommandLineAfterContinuation call
     *
     * @param command the command request.
     * @return the future object for this command
     * @throws ImapAsyncClientException on failure
     */
     ImapFuture execute(ImapRequest command) throws ImapAsyncClientException;

    /**
     * Terminates the current running command.
     *
     * @param command the command request.
     * @return the future object for this command
     * @throws ImapAsyncClientException on failure
     */
    ImapFuture terminateCommand(@Nonnull ImapRequest command) throws ImapAsyncClientException;

    /**
     * Closes/disconnects this session.
     *
     * @return a future when it is completed. True means successful, otherwise failure.
     */
    ImapFuture close();

    /**
     * @return true if channel is closed; false otherwise
     */
    boolean isChannelClosed();

}