/*

  * Copyright 2008 fastConnect.

  *    

  * This file is part of Composite BulkDataPersister.  

  *

  * This is free software; you can redistribute it and/or modify it

  * under the terms of the GNU Lesser General Public License as

  * published by the Free Software Foundation; either version 3 of

  * the License, or (at your option) any later version.

  *

  * This software is distributed in the hope that it will be useful,

  * but WITHOUT ANY WARRANTY; without even the implied warranty of

  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

  * Lesser General Public License for more details.

  *

  * You should have received a copy of the GNU Lesser General Public

  * License along with this software. If not, see <http://www.gnu.org/licenses/>.

  */

 package fr.fastconnect.gigaspaces.datasource;

 import java.util.List;

 import java.util.Properties;

 import com.gigaspaces.datasource.BulkDataPersister;

 import com.gigaspaces.datasource.BulkItem;

 import com.gigaspaces.datasource.DataSourceException;

 /**

  *Defines a mechanism allowing to handle failure to delegate to a particular {@link BulkDataPersister#executeBulk(List)} implementation.

  */

 public interface ExecutionFailureStrategy {

         /**

          * Allows the {@link ExecutionFailureStrategy} to be configured using the {@link Properties} object from {@link com.gigaspaces.datasource.ManagedDataSource.ManagedDataSource#init(Properties)}.

          * 

          * @param properties the {@link Properties} received by {@link com.gigaspaces.datasource.ManagedDataSource.ManagedDataSource#init(Properties)}

          * @throws DataSourceException if thrown is propagated to {@link com.gigaspaces.datasource.ManagedDataSource.ManagedDataSource#init(Properties)}

          */

         void init(Properties properties) throws DataSourceException;

         /**

          * Deals with the {@link DataException} thrown by a {@link BulkDataPersister#executeBulk(List)}.

          * <br />

          * If this method itself throws an exception then we delegate the call to {@link CompositeBulkDataPersister#handleUnrecuperableException(BulkDataPersister, List)}.

          * 

          * @param bulkDataPersister the persister used

          * @param bulkItems the information received

          * @param exception the {@link Exception} thrown by the {@link BulkDataPersister#executeBulk(List)} execution.

          * @throws Exception delegates failure to {@link CompositeBulkDataPersister#handleUnrecuperableException(BulkDataPersister, List)}

          */

         void handleExecutionFailure(BulkDataPersister bulkDataPersister, List<BulkItem> bulkItems, DataSourceException exception) throws Exception;

 }