001/*
002 * The MIT License
003 *
004 * Copyright (c) 2012, Ninja Squad
005 *
006 * Permission is hereby granted, free of charge, to any person obtaining a copy
007 * of this software and associated documentation files (the "Software"), to deal
008 * in the Software without restriction, including without limitation the rights
009 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
010 * copies of the Software, and to permit persons to whom the Software is
011 * furnished to do so, subject to the following conditions:
012 *
013 * The above copyright notice and this permission notice shall be included in
014 * all copies or substantial portions of the Software.
015 *
016 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
017 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
018 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
019 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
020 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
021 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
022 * THE SOFTWARE.
023 */
024
025package com.ninja_squad.dbsetup.operation;
026
027import java.sql.Connection;
028import java.sql.SQLException;
029
030import com.ninja_squad.dbsetup.DbSetupTracker;
031import com.ninja_squad.dbsetup.bind.BinderConfiguration;
032
033/**
034 * An operation that the database setup executes. It's advised to make implementations of this interface
035 * immutable, and to make them implement equals and hashCode in order for {@link DbSetupTracker} to function
036 * properly.
037 * @author JB Nizet
038 */
039public interface Operation {
040
041    /**
042     * Executes the operation
043     * @param connection the connection used to execute the operation
044     * @param configuration the binder configuration, used to get appropriate binders based on the metadata of
045     * the prepared statements
046     * @throws SQLException if the execution throws a SQLException
047     */
048    void execute(Connection connection, BinderConfiguration configuration) throws SQLException;
049}