AnnotatedActionMethods.java

/*
 * 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]".
 *
 * Copyright 2015-2017 ForgeRock AS.
 */

package org.forgerock.json.resource;

import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;

import org.forgerock.services.context.Context;
import org.forgerock.api.annotations.Action;
import org.forgerock.util.promise.Promise;

/**
 * This class is used to find all methods annotated with {@link Action}, and provides
 * a method for invoking the appropriate action method or handling the failure case
 * for when an action isn't supported - i.e. no matching annotated method exists.
 */
class AnnotatedActionMethods {

    private Map<String, AnnotatedMethod> methodsWithIdActions = new HashMap<>();

    private Map<String, AnnotatedMethod> methodsWithoutIdActions = new HashMap<>();

    Promise<ActionResponse, ResourceException> invoke(Context context, ActionRequest request) {
        return invoke(context, request, null, methodsWithoutIdActions.get(request.getAction()));
    }

    Promise<ActionResponse, ResourceException> invoke(Context context, ActionRequest request, String id) {
        return invoke(context, request, id, methodsWithIdActions.get(request.getAction()));
    }

    private Promise<ActionResponse, ResourceException> invoke(
        Context context, ActionRequest request, String id, AnnotatedMethod method) {
        if (method == null) {
            return new NotSupportedException(request.getAction() + " not supported").asPromise();
        }
        return method.invoke(context, request, id);
    }

    static AnnotatedActionMethods findAll(Object requestHandler, boolean needsId) {
        AnnotatedActionMethods methods = new AnnotatedActionMethods();
        for (Method method : requestHandler.getClass().getMethods()) {
            Action action = method.getAnnotation(Action.class);
            if (action != null) {
                AnnotatedMethod checked = AnnotatedMethod.checkMethod(Action.class, requestHandler, method, needsId);
                if (checked != null) {
                    String actionName = action.name();
                    if (actionName == null || actionName.length() == 0) {
                        actionName = method.getName();
                    }
                    if (checked.isUsingId()) {
                        methods.methodsWithIdActions.put(actionName, checked);
                    } else {
                        methods.methodsWithoutIdActions.put(actionName, checked);
                    }
                }
            }
        }
        return methods;
    }

}