InfiniteRetrySyncFailureHandler.java

/*
 * 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 java.util.Map;

import org.forgerock.services.context.Context;

/**
 * A retry failure handler which retries infinitely.
 *
 */
public class InfiniteRetrySyncFailureHandler implements SyncFailureHandler {
    /** an instance of the InfiniteRetrySyncFailureHandler -- there only needs to be one */
    public static final SyncFailureHandler INSTANCE = new InfiniteRetrySyncFailureHandler();

    // restrict instantiation to the above INSTANCE
    private InfiniteRetrySyncFailureHandler() {
    }

    /** 
     * 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 {

        throw new SyncHandlerException("Failed to synchronize " + syncFailure.get("uid") + " object on "
                + syncFailure.get("systemIdentifier") + ": " + failureCause.getMessage(), failureCause);
    }
}