/*
 * Copyright 2012 Nodeable Inc
 *
 *    Licensed 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 com.streamreduce.core.service;

import com.streamreduce.ConnectionNotFoundException;
import com.streamreduce.core.model.Account;
import com.streamreduce.core.model.Connection;
import com.streamreduce.core.model.TaggableService;
import com.streamreduce.core.model.User;
import com.streamreduce.core.service.exception.ConnectionExistsException;
import com.streamreduce.core.service.exception.InvalidCredentialsException;

import java.io.IOException;
import java.util.List;

import javax.annotation.Nullable;

import org.bson.types.ObjectId;

public interface ConnectionService extends TaggableService<Connection> {

    /**
     * Creates a connection.
     *
     * @param connection the connection to create
     *
     * @return the created connection
     *
     * @throws InvalidCredentialsException if the cloud credentials are invalid
     * @throws IOException if there is connectivity issue
     * @throws ConnectionExistsException if there is already a cloud object for provider/user/credentials combination
     */
    Connection createConnection(Connection connection) throws ConnectionExistsException,
            InvalidCredentialsException, IOException;

    /**
     * Returns all connections of a particular type or all connections if type is null.
     *
     * @param type the type to filter all connections by, or null to get all connections
     *
     * @return the connections
     */
    List<Connection> getConnections(@Nullable String type);

    /**
     * Returns all connections of a particular type that are public
     *
     * @param type the type to filter all connections by, or null to get all connections
     *
     * @return the connections
     */
    List<Connection> getPublicConnections(@Nullable String type);

    /**
     * Returns all connections of a particular type for the given user.
     *
     * @param type the type to filter all connections by
     * @param user the user to filter all connections by
     *
     * @return the connections
     */
    List<Connection> getConnections(String type, User user);

    List<Connection> getAccountConnections(Account account);

    /**
     * Returns the connection with the given id.
     *
     * @param id the id of the connection
     *
     * @return the connection
     */
    Connection getConnection(ObjectId id) throws ConnectionNotFoundException;

    /**
     * Updates the connection.
     *
     * @param connection the connection to update
     *
     * @return the updated connection
     *
     * @throws InvalidCredentialsException if the cloud credentials are invalid
     * @throws IOException if there is connectivity issue
     * @throws ConnectionExistsException if there is already a cloud object for provider/user/credentials combination
     */
    Connection updateConnection(Connection connection) throws ConnectionExistsException,
            InvalidCredentialsException, IOException;

    /**
     * Updates the connection but suppresses the object event.
     *
     * @param connection the connection to update
     * @param silentUpdate indicate whether or not suppress the connection event (events and validation are skipped if silent update)
     *
     * @return the updated connection
     *
     * @throws InvalidCredentialsException if the cloud credentials are invalid
     * @throws IOException if there is connectivity issue
     * @throws ConnectionExistsException if there is already a cloud object for provider/user/credentials combination
     */
    Connection updateConnection(Connection connection, boolean silentUpdate) throws ConnectionExistsException,
            InvalidCredentialsException, IOException;


    /**
     * Deletes the connection.
     *
     * @param connection the connection to delete
     */
    void deleteConnection(Connection connection);

    /**
     * Deletes the associated inventory of the connection.
     *
     * @param connectionId the id of the connection object
     */
    void deleteConnectionInventory(ObjectId connectionId);

    /**
     * Fires a one time high priority inventory refresh job for a single connection.
     *
     * @param connection the connection whose job to run
     *
     * @throws InvalidCredentialsException if the cloud credentials are invalid
     * @throws IOException if there is connectivity issue
     * @throws ConnectionExistsException if there is already a cloud object for provider/user/credentials combination
     */
    void fireOneTimeHighPriorityJobForConnection(Connection connection) throws ConnectionNotFoundException,
            InvalidCredentialsException, IOException;

    /**
     * Returns all Connections whose externalId property matches the passed in externalId owned by a given user.
     * If a connection with a given externalId is not found, or if the passed externalId was null or empty, an empty
     * List is returned.  Otherwise a List<Connection> of all connections whose externalId property is equal to the
     * passed in externalId is returned.
     *
     * Since uniqueness isn't enforced on the externalId property of a Connection, the client must be responsible for
     * handling the N number of possible connections that match.
     *
     * @param externalId the externalId expected on connection
     * @param user - the user who owns the connection
     * @return All connections whose externalId property matches the passed
     */
    List<Connection> getConnectionsByExternalId(String externalId, User user);

}