sg.dex.starfish.Operation Maven / Gradle / Ivy

Go to download
package sg.dex.starfish;

import sg.dex.starfish.constant.Constant;
import sg.dex.starfish.exception.StarfishValidationException;
import sg.dex.starfish.util.Params;

import java.util.List;
import java.util.Map;

import static sg.dex.starfish.constant.Constant.*;


/**
 * Interface representing an invokable Operation
 *
 * @author Mike
 * @version 0.5
 */
public interface Operation extends Asset {

    @Override
    default boolean isOperation() {
        return true;
    }

    /**
     * Invokes this operation with the given positional parameters.
     *
     * @param params Positional parameters for this invoke job
     * @return The Job for this invoked operation
     * @throws IllegalArgumentException if required parameters are not available.
     */
    default Job invoke(Object... params) {
        return invoke(Params.namedParams(this, params));
    }

    /**
     * Invokes this operation with the given named parameters. Operations should
     * override this method to provide an implementation of asynchronous invocation
     * via the Job interface
     *
     * @param params Positional parameters for this invoke job
     * @return The Job for this invoked operation
     * @throws IllegalArgumentException if required parameters are not available, or
     *                                  of incorrect type
     */
    Job invokeAsync(Map params);

    /**
     * Invokes this operation with the given named parameters. Operations should
     * override this method to provide an implementation of synchronous invocation
     * via the Job interface
     *
     * @param params Positional parameters for this invoke job
     * @return The result for this invoked operation
     * @throws IllegalArgumentException if required parameters are not available, or
     *                                  of incorrect type
     */
    Map invokeResult(Map params);

    /**
     * Invokes this operation with the given named parameters. Operations should
     * override this method to provide an implementation of asynchronous invocation
     * via the Job interface
     *
     * @param params Positional parameters for this invoke job
     * @return The Job for this invoked operation
     * @throws IllegalArgumentException if required parameters are not available, or
     *                                  of incorrect type
     */
    Job invoke(Map params);

    /**
     * Returns the operation specification for this operation. Operations may
     * override this method to define:

     * - what operation inputs are accepted

     * - what operation results are created

     * 
     * TODO: add brief description of format and link to DEP6
     *
     * @return A map of parameter names to specifications
     */
    @SuppressWarnings("unchecked")
    default Map getOperationSpec() {
        return (Map) getMetadata().get(Constant.OPERATION);
    }

    /**
     * Returns the parameter specification for this operation. Operations may
     * override this method to define what parameters they accept.
     * 
     * TODO: add brief description of format and link to DEP6
     *
     * @return A map of parameter names to specifications
     */
    @SuppressWarnings("unchecked")
    default Map getParamsSpec() {
        return (Map) getOperationSpec().get("params");
    }

    /**
     * Return the list of modes supported for invocations of this operation.
     * Currently supported modes are "sync" and "async"
     */
    @SuppressWarnings("unchecked")
    default List getOperationModes() {
        Map operationData = getOperationSpec();
        if (operationData == null) {
            throw new StarfishValidationException("No operation metadata found");
        }

        if (operationData.get(MODES) == null) {
            // return default list (all supported modes) as per DEP6
            return List.of(SYNC, ASYNC);
        }
        List modeLst = (List) operationData.get(MODES);
        for (String mode : modeLst) {
            if (mode.equals(SYNC) ||
                    mode.equals(ASYNC)) {
            } else {
                throw new StarfishValidationException("Invalid mode in operation metadata: " + mode);
            }
        }

        return modeLst;
    }

}