/*
 * Copyright 2013-2015 EMC Corporation. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 * http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 * or in the "license" file accompanying this file. This file 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.emc.ecs.sync;

import com.emc.ecs.sync.config.SyncOptions;
import com.emc.ecs.sync.filter.SyncFilter;
import com.emc.ecs.sync.storage.SyncStorage;
import com.emc.ecs.sync.util.Function;
import com.emc.ecs.sync.util.TimingUtil;

import java.util.Iterator;
import java.util.concurrent.Callable;

/**
 * Basic SyncPlugin parent class.  All plugins should inherit from this class.
 * To have your plugin participate in command-line parsing, implement the
 * following methods:
 * <ul>
 * <li>getName()</li>
 * <li>getDocumentation()</li>
 * <li>getCustomOptions()</li>
 * <li>parseCustomOptions()</li>
 * </ul>
 * If you do not want your plugin to configure itself via the command line,
 * (e.g. if you are using Spring), you can simply leave those methods empty.
 *
 * @author cwikj
 */
public abstract class AbstractPlugin<C> implements SyncPlugin<C> {
    protected C config;
    protected SyncOptions options = new SyncOptions();

    @Override
    public void configure(SyncStorage source, Iterator<SyncFilter> filters, SyncStorage target) {
        assert config != null : "config is null";
        assert options != null : "options is null";
    }

    /**
     * Override to perform any necessary cleanup logic after the entire sync is complete (i.e. close file handles,
     * streams, DB connections, etc.) NOTE: be sure to call super if you override this!
     */
    @Override
    public void close() {
    }

    protected <T> T time(Function<T> function, String name) {
        return TimingUtil.time(options, getTimingPrefix() + name, function);
    }

    protected <T> T time(Callable<T> timeable, String name) throws Exception {
        return TimingUtil.time(options, getTimingPrefix() + name, timeable);
    }

    protected void timeOperationStart(String name) {
        TimingUtil.startOperation(options, getTimingPrefix() + name);
    }

    protected void timeOperationComplete(String name) {
        TimingUtil.completeOperation(options, getTimingPrefix() + name);
    }

    protected void timeOperationFailed(String name) {
        TimingUtil.failOperation(options, getTimingPrefix() + name);
    }

    protected String getTimingPrefix() {
        return getClass().getSimpleName() + "::";
    }

    @Override
    public C getConfig() {
        return config;
    }

    @Override
    public void setConfig(C config) {
        this.config = config;
    }

    @Override
    public SyncOptions getOptions() {
        return options;
    }

    @Override
    public void setOptions(SyncOptions options) {
        this.options = options;
    }

    public AbstractPlugin withConfig(C config) {
        setConfig(config);
        return this;
    }

    public AbstractPlugin withOptions(SyncOptions options) {
        setOptions(options);
        return this;
    }
}