com.netflix.astyanax.recipes.queue.Message Maven / Gradle / Ivy
/**
* Copyright 2013 Netflix, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.netflix.astyanax.recipes.queue;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.TimeUnit;
import org.codehaus.jackson.annotate.JsonIgnore;
import com.google.common.collect.Maps;
import com.netflix.astyanax.recipes.queue.triggers.Trigger;
import com.netflix.astyanax.util.TimeUUIDUtils;
public class Message {
private static final int DEFAULT_TIMEOUT_SECONDS = 120;
/**
* Last execution time, this value changes as the task state is transitioned.
* The token is a timeUUID and represents the next execution/expiration time
* within the queue.
*/
private UUID token;
/**
* Random number associated with this message
*/
private UUID random;
/**
* Execution time for the task in milliseconds
*/
private Trigger trigger;
/**
* Map of message parameters that are stored with the queued item
*/
private Map parameters;
/**
* Lower value priority tasks get executed first
*/
private byte priority = 0;
/**
* Timeout value in seconds
*/
private int timeout = DEFAULT_TIMEOUT_SECONDS;
/**
* Unique key for this message.
*/
private String key;
/**
* Class name to handle this message
*/
private String taskClass;
/**
* Set to true if history should be maintained for each handling of the message
*/
private boolean isKeepHistory = false;
/**
* True if the key is expected to be unique
*/
private boolean hasUniqueKey = false;
/**
* Set to true if next trigger should be committed when the messages is
* popped as opposed to being sent when a messages is acked.
*/
private boolean isAutoCommitTrigger = false;
public Message() {
}
public Message(UUID token, UUID random) {
this.token = token;
this.random = random;
}
public UUID getToken() {
return token;
}
public Message setToken(UUID token) {
this.token = token;
return this;
}
/**
* Get the micros time encoded in the token
* @return
*/
@JsonIgnore
public long getTokenTime() {
return TimeUUIDUtils.getMicrosTimeFromUUID(token);
}
public UUID getRandom() {
return random;
}
public Message setRandom(UUID random) {
this.random = random;
return this;
}
public Trigger getTrigger() {
return trigger;
}
public Message setTrigger(Trigger trigger) {
this.trigger = trigger;
return this;
}
public boolean hasTrigger() {
return trigger != null;
}
public Map getParameters() {
return parameters;
}
public Message setParameters(Map parameters) {
this.parameters = parameters;
return this;
}
public Message addParameter(String key, Object value) {
if (this.parameters == null)
this.parameters = Maps.newHashMap();
this.parameters.put(key, value);
return this;
}
public byte getPriority() {
return priority;
}
public int getTimeout() {
return timeout;
}
public boolean hasTimeout() {
return timeout != 0;
}
/**
* Setting priority will NOT work correctly with a future trigger time due to
* internal data model implementations.
* @param priority
* @return
*/
public Message setPriority(byte priority) {
this.priority = priority;
return this;
}
public Message setTimeout(int timeout) {
this.timeout = timeout;
return this;
}
public Message setTimeout(long timeout, TimeUnit units) {
this.timeout = (int)TimeUnit.SECONDS.convert(timeout, units);
return this;
}
public String getKey() {
return key;
}
public Message setKey(String key) {
this.key = key;
return this;
}
public Message setUniqueKey(String key) {
this.key = key;
this.hasUniqueKey = true;
return this;
}
public boolean hasKey() {
return this.key != null;
}
public boolean hasUniqueKey() {
return this.key != null && this.hasUniqueKey;
}
public String getTaskClass() {
return taskClass;
}
public Message setTaskClass(String taskClass) {
this.taskClass = taskClass;
return this;
}
public boolean hasTaskClass() {
return this.taskClass != null;
}
public boolean isKeepHistory() {
return isKeepHistory;
}
public Message setKeepHistory(Boolean isKeepHistory) {
this.isKeepHistory = isKeepHistory;
return this;
}
public Message clone() {
Message message = new Message();
message.token = token;
message.trigger = trigger;
message.parameters = parameters;
message.priority = priority;
message.timeout = timeout;
message.key = key;
message.taskClass = taskClass;
message.isKeepHistory = isKeepHistory;
return message;
}
public boolean isAutoCommitTrigger() {
return isAutoCommitTrigger;
}
public Message setAutoCommitTrigger(boolean isAutoCommitTrigger) {
this.isAutoCommitTrigger = isAutoCommitTrigger;
return this;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("Message[");
if (token != null) {
sb.append("token=" + token + " (" + TimeUUIDUtils.getMicrosTimeFromUUID(token) + ")");
}
if (random != null)
sb.append(", random=" + random);
if (trigger != null)
sb.append(", trigger=" + trigger);
if (parameters != null)
sb.append(", parameters=" + parameters);
sb.append(", priority=" + priority);
sb.append(", timeout=" + timeout);
if (key != null)
sb.append(", key=" + key);
if (hasUniqueKey)
sb.append(", hasUniqueKey=" + hasUniqueKey);
if (taskClass != null)
sb.append(", taskClass=" + taskClass);
if (isKeepHistory)
sb.append(", isKeepHistory=" + isKeepHistory);
sb.append("]");
return sb.toString();
}
}