openicf/syncfailure/SimpleRetrySyncFailureHandler.java

	SimpleRetrySyncFailureHandler.java revision 21dcdac963f79c098a5ea1a2c5c5e109429c9786
/*
 * Copyright 2013 ForgeRock, AS.
 *
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 */
package org.forgerock.openidm.provisioner.openicf.syncfailure;

import org.forgerock.services.context.Context;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Map;


/**
 * A simple sync failure handler that counts retries.
 *
 */
public class SimpleRetrySyncFailureHandler implements SyncFailureHandler {

    /** Logger */
    private static final Logger logger = LoggerFactory.getLogger(SimpleRetrySyncFailureHandler.class);

    /** how many times to retry live sync of a particular sync token */
    private final int syncFailureRetries;

    /** the handler to call after the retries are exhausted */
    private final SyncFailureHandler postRetryHandler;

    /** current token being retried */
    private Object currentSyncToken;

    /** number of retries on current token */
    private int currentRetries;

    /**
     * Construct the SyncFailureHandler.
     *
     * @param syncFailureRetries the number of retries
     */
    public SimpleRetrySyncFailureHandler(int syncFailureRetries, SyncFailureHandler postRetryHandler) {
        this.syncFailureRetries = syncFailureRetries;
        this.postRetryHandler = postRetryHandler;
    }

    /**
     * Handle sync failure by counting retries on this sync token, passing to
     * (optional) post-retry handler when retries are exceeded.
     *
     * @param context the request context associated with the invocation
     * @param syncFailure contains sync failure data
     * @param failureCause the cause of the sync failure
     * @throws SyncHandlerException when retries are not exceeded
     */
    public void invoke(Context context, Map<String, Object> syncFailure, Exception failureCause)
        throws SyncHandlerException {

        final Object token = syncFailure.get("token");

        if (token != null && token.equals(currentSyncToken)) {
            currentRetries++;
        }
        else {
            currentSyncToken = token;
            currentRetries = 0;
        }

        if (currentRetries >= syncFailureRetries) {
            logger.info("{}:{} sync retries = {}/{}, retries exhausted",
                    syncFailure.get("systemIdentifier"), syncFailure.get("uid"),
                    currentRetries, syncFailureRetries);
            postRetryHandler.invoke(context, syncFailure, failureCause);
        } else {
            logger.info("{}:{} sync retries = {}/{}, retrying",
                    syncFailure.get("systemIdentifier"), syncFailure.get("uid"),
                    currentRetries, syncFailureRetries);
            throw new SyncHandlerException("Failed to synchronize " + syncFailure.get("uid")
                    + " object on " + syncFailure.get("systemIdentifier") +
                    ", retries (" + currentRetries + ") not exhausted.",
                    failureCause);
        }
    }
}