ru.dezhik.sms.sender.api.ApiRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sms-sender Show documentation

Library for sending SMS via sms.ru gateway

There is a newer version: 0.1.3

package ru.dezhik.sms.sender.api;

import java.util.concurrent.atomic.AtomicInteger;

/**
 * @author ilya.dezhin
 */
public abstract class ApiRequest {
    public abstract H getHandler();

    /**
     * Number of attempts made to execute request. If the request is executed
     * from the first attempt then the value of this field would be equals to 1.
     */
    protected final AtomicInteger executionAttempt = new AtomicInteger(0);

    /**
     * Could be helpful with {@link ru.dezhik.sms.sender.AsyncSenderService#execute(ApiRequest, ApiCallback[])}}.
     * The idea is to attach some data which could be retrieved by {@link ApiCallback}.
     */
    protected volatile Object attachment;

    /**
     * Invocation status field, shouldn't be null.
     */
    protected volatile InvocationStatus status = InvocationStatus.QUEUED;
    /**
     * Is not empty iff this.status.isAbnormal() returns true.
     */
    protected volatile Throwable exception;

    public Object attachment() {
        return attachment;
    }

    public void attach(Object attachment) {
        this.attachment = attachment;
    }

    public int incrementExecutionAttempt() {
        return executionAttempt.incrementAndGet();
    }

    public int getExecutionAttempt() {
        return executionAttempt.get();
    }

    public InvocationStatus getStatus() {
        return status;
    }

    public void setStatus(InvocationStatus status) {
        this.status = status;
    }

    public Object getAttachment() {
        return attachment;
    }

    public void setAttachment(Object attachment) {
        this.attachment = attachment;
    }

    public Throwable getException() {
        return exception;
    }

    public void setException(Throwable exception) {
        this.exception = exception;
    }
}