org.opensearch.jobscheduler.transport.AcquireLockRequest Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of opensearch-job-scheduler Show documentation
OpenSearch Job Scheduler plugin
There is a newer version: 2.17.0.0
Show newest version
/*
 * Copyright OpenSearch Contributors
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */
package org.opensearch.jobscheduler.transport;

import java.io.IOException;
import java.util.Objects;
import org.opensearch.action.ActionRequest;
import org.opensearch.action.ActionRequestValidationException;
import org.opensearch.core.common.io.stream.StreamInput;
import org.opensearch.core.common.io.stream.StreamOutput;
import org.opensearch.core.xcontent.ToXContentObject;
import org.opensearch.core.xcontent.XContentBuilder;
import org.opensearch.core.xcontent.XContentParser;
import org.opensearch.core.xcontent.XContentParserUtils;

/**
 * Request from extensions to acquire a lock for scheduled job execution
 */
public class AcquireLockRequest extends ActionRequest implements ToXContentObject {

    /**
     * the id of the job
     */
    private final String jobId;

    /**
     * the name of the job index
     */
    private final String jobIndexName;

    /**
     * the duration for which this lock will be acquired
     */
    private final long lockDurationSeconds;

    public static final String JOB_ID = "job_id";
    public static final String JOB_INDEX_NAME = "job_index_name";
    public static final String LOCK_DURATION_SECONDS = "lock_duration_seconds";

    /**
     * Instantiates a new AcquireLockRequest
     *
     * @param jobId the id of the job in which the lock will be given to
     * @param jobIndexName the name of the job index
     * @param lockDurationSeconds the duration for which this lock will be acquired
     */
    public AcquireLockRequest(String jobId, String jobIndexName, long lockDurationSeconds) {
        super();
        this.jobId = Objects.requireNonNull(jobId);
        this.jobIndexName = Objects.requireNonNull(jobIndexName);
        this.lockDurationSeconds = Objects.requireNonNull(lockDurationSeconds);
    }

    /**
     * Instantiates a new AcquireLockRequest from {@link StreamInput}
     *
     * @param in is the byte stream input used to de-serialize the message.
     * @throws IOException IOException when message de-serialization fails.
     */
    public AcquireLockRequest(StreamInput in) throws IOException {
        super(in);
        this.jobId = in.readString();
        this.jobIndexName = in.readString();
        this.lockDurationSeconds = in.readLong();
    }

    @Override
    public void writeTo(StreamOutput out) throws IOException {
        super.writeTo(out);
        out.writeString(this.jobId);
        out.writeString(this.jobIndexName);
        out.writeLong(this.lockDurationSeconds);
    }

    public String getJobId() {
        return this.jobId;
    }

    public String getJobIndexName() {
        return this.jobIndexName;
    }

    public long getLockDurationSeconds() {
        return this.lockDurationSeconds;
    }

    @Override
    public ActionRequestValidationException validate() {
        return null;
    }

    public static AcquireLockRequest parse(XContentParser parser) throws IOException {

        String jobId = null;
        String jobIndexName = null;
        Long lockDurationSeconds = null;

        XContentParserUtils.ensureExpectedToken(XContentParser.Token.START_OBJECT, parser.currentToken(), parser);
        while (parser.nextToken() != XContentParser.Token.END_OBJECT) {
            String fieldName = parser.currentName();
            parser.nextToken();

            switch (fieldName) {
                case JOB_ID:
                    jobId = parser.text();
                    break;
                case JOB_INDEX_NAME:
                    jobIndexName = parser.text();
                    break;
                case LOCK_DURATION_SECONDS:
                    lockDurationSeconds = parser.longValue();
                    break;
                default:
                    parser.skipChildren();
                    break;
            }
        }
        return new AcquireLockRequest(jobId, jobIndexName, lockDurationSeconds);
    }

    @Override
    public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
        builder.startObject();
        builder.field(JOB_ID, jobId);
        builder.field(JOB_INDEX_NAME, jobIndexName);
        builder.field(LOCK_DURATION_SECONDS, lockDurationSeconds);
        builder.endObject();
        return builder;
    }

}