001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2016 ForgeRock AS.
015 *
016 */
017package org.forgerock.opendj.rest2ldap;
018
019import org.forgerock.json.resource.ActionRequest;
020import org.forgerock.json.resource.ActionResponse;
021import org.forgerock.json.resource.CreateRequest;
022import org.forgerock.json.resource.DeleteRequest;
023import org.forgerock.json.resource.PatchRequest;
024import org.forgerock.json.resource.QueryRequest;
025import org.forgerock.json.resource.QueryResourceHandler;
026import org.forgerock.json.resource.QueryResponse;
027import org.forgerock.json.resource.ReadRequest;
028import org.forgerock.json.resource.Request;
029import org.forgerock.json.resource.RequestHandler;
030import org.forgerock.json.resource.ResourceException;
031import org.forgerock.json.resource.ResourceResponse;
032import org.forgerock.json.resource.UpdateRequest;
033import org.forgerock.services.context.Context;
034import org.forgerock.util.promise.Promise;
035
036/**
037 * An abstract base class from which request handlers may be easily implemented. The default implementation of each
038 * method is to invoke the {@link #handleRequest(Context, Request)} method.
039 */
040public abstract class AbstractRequestHandler implements RequestHandler {
041    /** Creates a new {@code AbstractRequestHandler}. */
042    protected AbstractRequestHandler() {
043        // Nothing to do.
044    }
045
046    @Override
047    public Promise<ActionResponse, ResourceException> handleAction(final Context context, final ActionRequest request) {
048        return handleRequest(context, request);
049    }
050
051    @Override
052    public Promise<ResourceResponse, ResourceException> handleCreate(final Context context,
053                                                                     final CreateRequest request) {
054        return handleRequest(context, request);
055    }
056
057    @Override
058    public Promise<ResourceResponse, ResourceException> handleDelete(final Context context,
059                                                                     final DeleteRequest request) {
060        return handleRequest(context, request);
061    }
062
063    @Override
064    public Promise<ResourceResponse, ResourceException> handlePatch(final Context context, final PatchRequest request) {
065        return handleRequest(context, request);
066    }
067
068    @Override
069    public Promise<QueryResponse, ResourceException> handleQuery(final Context context, final QueryRequest request,
070                                                                 final QueryResourceHandler handler) {
071        return handleRequest(context, request);
072    }
073
074    @Override
075    public Promise<ResourceResponse, ResourceException> handleRead(final Context context, final ReadRequest request) {
076        return handleRequest(context, request);
077    }
078
079    @Override
080    public Promise<ResourceResponse, ResourceException> handleUpdate(final Context context,
081                                                                     final UpdateRequest request) {
082        return handleRequest(context, request);
083    }
084
085    /**
086     * Implement this method in order to provide a default behavior when processing requests.
087     *
088     * @param <V>
089     *         The type of response.
090     * @param context
091     *         The request context.
092     * @param request
093     *         The request.
094     * @return A {@code Promise} containing the result of the operation.
095     */
096    protected abstract <V> Promise<V, ResourceException> handleRequest(final Context context, final Request request);
097}