com.exasol.bucketfs.jsonrpc.RpcCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bucketfs-java Show documentation

Java library for automating tasks on Exasol's BucketFS.

The newest version!

package com.exasol.bucketfs.jsonrpc;

/**
 * A command with job name (i.e. the action to run) and parameters that can be executed against the RPC interface. Child
 * classes can process the response payload and return a custom result type (e.g. a class containing information
 * returned by the server) by implementing {@link #processResult(String)}.
 *
 * @param  the result type
 */
abstract class RpcCommand {
    private final String jobName;

    /**
     * Creates a new command with the given job name, e.g. {@code "bucket_add"}.
     *
     * @param jobName job name for the new command
     */
    protected RpcCommand(final String jobName) {
        this.jobName = jobName;
    }

    /**
     * The job name.
     *
     * @return the job name
     */
    final String getJobName() {
        return this.jobName;
    }

    /**
     * Parameters for the RPC request.
     * 
     * The returned object must be serializable to JSON.
     *
     * @return the parameters for the RPC request.
     */
    abstract Object getParameters();

    /**
     * Processes the given response payload (e.g. by parsing it as JSON) and returns a result object.
     *
     * @param responsePayload response payload.
     * @return result object
     */
    abstract R processResult(String responsePayload);
}