cz.active24.client.fred.data.poll.PollResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fred-client Show documentation

A Java EPP client for FRED (Free Registry for ENUM and Domains)

There is a newer version: 2.50

package cz.active24.client.fred.data.poll;

import cz.active24.client.fred.data.EppResponse;
import cz.active24.client.fred.eppclient.objectstrategy.PollMessageType;
import cz.active24.client.fred.eppclient.objectstrategy.ServerObjectType;

import java.io.Serializable;
import java.util.Date;

/**
 * A poll request command is used to obtain the message queue status (message count) and contents of the first message in the queue (the oldest one).
 *
 * 
 * {@link PollResponse#messageId} - current message identifier
 * {@link PollResponse#messageCount} - number of messages in the queue
 * {@link PollResponse#messageQDate} - the timestamp when the message was enqueued
 * {@link PollResponse#pollMessageType} - message type, see {@link PollMessageType}
 * 
 *
 * @see FRED documentation
 */
public class PollResponse extends EppResponse implements Serializable {

    private String messageId;

    private Integer messageCount;

    private Date messageQDate;

    private PollMessageType pollMessageType;

    public PollResponse() {
        setServerObjectType(ServerObjectType.OTHER);
        setPollMessageType(PollMessageType.EMPTY);
    }

    public String getMessageId() {
        return messageId;
    }

    public void setMessageId(String messageId) {
        this.messageId = messageId;
    }

    public Integer getMessageCount() {
        return messageCount;
    }

    public void setMessageCount(Integer messageCount) {
        this.messageCount = messageCount;
    }

    public Date getMessageQDate() {
        return messageQDate;
    }

    public void setMessageQDate(Date messageQDate) {
        this.messageQDate = messageQDate;
    }

    public PollMessageType getPollMessageType() {
        return pollMessageType;
    }

    public void setPollMessageType(PollMessageType pollMessageType) {
        this.pollMessageType = pollMessageType;
    }

    @Override
    public String toString() {
        final StringBuffer sb = new StringBuffer("PollResponse{");
        sb.append("messageId='").append(messageId).append('\'');
        sb.append(", messageCount=").append(messageCount);
        sb.append(", messageQDate=").append(messageQDate);
        sb.append(", pollMessageType=").append(pollMessageType);
        sb.append(", clientTransactionId='").append(getClientTransactionId()).append('\'');
        sb.append(", serverTransactionId='").append(getServerTransactionId()).append('\'');
        sb.append(", result=").append(getResult());
        sb.append(", serverObjectType=").append(getServerObjectType());
        sb.append('}');
        return sb.toString();
    }
}