/*
 * Copyright (c) 2016 The original author or authors
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 *      The Eclipse Public License is available at
 *      http://www.eclipse.org/legal/epl-v10.html
 *
 *      The Apache License v2.0 is available at
 *      http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */
package io.vertx.ext.consul;

import io.vertx.codegen.annotations.DataObject;
import io.vertx.core.json.JsonObject;

import java.util.List;

import static io.vertx.ext.consul.impl.Utils.listOf;

Options used to create session.
Author:Ruslan Sennov
/** * Options used to create session. * * @author <a href="mailto:ruslan.sennov@gmail.com">Ruslan Sennov</a> */
@DataObject public class SessionOptions { private static final String LOCK_KEY = "LockDelay"; private static final String NAME_KEY = "Name"; private static final String NODE_KEY = "Node"; private static final String CHECKS_KEY = "Checks"; private static final String BEHAVIOR_KEY = "Behavior"; private static final String TTL_KEY = "TTL"; private Long lockDelay; private String name; private String node; private List<String> checks; private SessionBehavior behavior; private Long ttl;
Default constructor
/** * Default constructor */
public SessionOptions() { }
Copy constructor
Params:
  • options – the one to copy
/** * Copy constructor * * @param options the one to copy */
public SessionOptions(SessionOptions options) { this.lockDelay = options.lockDelay; this.name = options.name; this.node = options.node; this.checks = listOf(options.checks); this.behavior = options.behavior; this.ttl = options.ttl; }
Constructor from JSON
Params:
  • options – the JSON
/** * Constructor from JSON * * @param options the JSON */
public SessionOptions(JsonObject options) { this.lockDelay = cutSeconds(options.getString(LOCK_KEY)); this.name = options.getString(NAME_KEY); this.node = options.getString(NODE_KEY); this.checks = listOf(options.getJsonArray(CHECKS_KEY)); this.behavior = SessionBehavior.of(options.getString(BEHAVIOR_KEY)); this.ttl = cutSeconds(options.getString(TTL_KEY)); }
Convert to JSON
Returns:the JSON
/** * Convert to JSON * * @return the JSON */
public JsonObject toJson() { JsonObject jsonObject = new JsonObject(); if (lockDelay != null) { jsonObject.put(LOCK_KEY, lockDelay + "s"); } if (name != null) { jsonObject.put(NAME_KEY, name); } if (node != null) { jsonObject.put(NODE_KEY, node); } if (checks != null) { jsonObject.put(CHECKS_KEY, checks); } if (behavior != null) { jsonObject.put(BEHAVIOR_KEY, behavior.key); } if (ttl != null) { jsonObject.put(TTL_KEY, ttl + "s"); } return jsonObject; }
Get the lock-delay period.
See Also:
Returns:the lock-delay period
/** * Get the lock-delay period. * * @return the lock-delay period * @see Session#getLockDelay() */
public long getLockDelay() { return lockDelay; }
Set the lock-delay period.
Params:
  • lockDelay – the lock-delay period in seconds
See Also:
Returns:reference to this, for fluency
/** * Set the lock-delay period. * * @param lockDelay the lock-delay period in seconds * @return reference to this, for fluency * @see Session#getLockDelay() */
public SessionOptions setLockDelay(long lockDelay) { this.lockDelay = lockDelay; return this; }
Get the human-readable name for the Session
Returns:the name of session
/** * Get the human-readable name for the Session * * @return the name of session */
public String getName() { return name; }
Set the human-readable name for the Session
Params:
  • name – the name of session
Returns:reference to this, for fluency
/** * Set the human-readable name for the Session * * @param name the name of session * @return reference to this, for fluency */
public SessionOptions setName(String name) { this.name = name; return this; }
Get the node to which the session will be assigned
Returns:the ID of node
/** * Get the node to which the session will be assigned * * @return the ID of node */
public String getNode() { return node; }
Set the node to which the session will be assigned
Params:
  • node – the ID of node
Returns:reference to this, for fluency
/** * Set the node to which the session will be assigned * * @param node the ID of node * @return reference to this, for fluency */
public SessionOptions setNode(String node) { this.node = node; return this; }
Get a list of associated health checks.
See Also:
Returns:list of associated health checks
/** * Get a list of associated health checks. * * @return list of associated health checks * @see #setChecks(List) */
public List<String> getChecks() { return checks; }
Set a list of associated health checks. It is highly recommended that, if you override this list, you include the default "serfHealth"
Params:
  • checks – list of associated health checks
Returns:reference to this, for fluency
/** * Set a list of associated health checks. It is highly recommended that, * if you override this list, you include the default "serfHealth" * * @param checks list of associated health checks * @return reference to this, for fluency */
public SessionOptions setChecks(List<String> checks) { this.checks = checks; return this; }
Get the behavior when a session is invalidated.
See Also:
Returns:the session behavior
/** * Get the behavior when a session is invalidated. * * @return the session behavior * @see #setBehavior(SessionBehavior) */
public SessionBehavior getBehavior() { return behavior; }
Set the behavior when a session is invalidated. The release behavior is the default if none is specified.
Params:
  • behavior – the session behavior
Returns:reference to this, for fluency
/** * Set the behavior when a session is invalidated. The release behavior is the default if none is specified. * * @param behavior the session behavior * @return reference to this, for fluency */
public SessionOptions setBehavior(SessionBehavior behavior) { this.behavior = behavior; return this; }
Get the TTL interval.
See Also:
Returns:the TTL interval in seconds
/** * Get the TTL interval. * * @return the TTL interval in seconds * @see #setTtl(long) */
public long getTtl() { return ttl; }
Set the TTL interval. When TTL interval expires without being renewed, the session has expired and an invalidation is triggered. If specified, it must be between 10s and 86400s currently. The contract of a TTL is that it represents a lower bound for invalidation; that is, Consul will not expire the session before the TTL is reached, but it is allowed to delay the expiration past the TTL. The lowest practical TTL should be used to keep the number of managed sessions low. When locks are forcibly expired, such as during a leader election, sessions may not be reaped for up to double this TTL, so long TTL values (> 1 hour) should be avoided.
Params:
  • ttl – the TTL interval in seconds
Returns:reference to this, for fluency
/** * Set the TTL interval. When TTL interval expires without being renewed, the session has expired * and an invalidation is triggered. If specified, it must be between {@code 10s} and {@code 86400s} currently. * * The contract of a TTL is that it represents a lower bound for invalidation; that is, * Consul will not expire the session before the TTL is reached, but it is allowed to delay * the expiration past the TTL. * * The lowest practical TTL should be used to keep the number of managed sessions low. * When locks are forcibly expired, such as during a leader election, sessions may not be reaped for * up to double this TTL, so long TTL values (&gt; 1 hour) should be avoided. * * @param ttl the TTL interval in seconds * @return reference to this, for fluency */
public SessionOptions setTtl(long ttl) { this.ttl = ttl; return this; } private static Long cutSeconds(String value) { if (value != null && value.endsWith("s")) { return Long.parseLong(value.substring(0, value.length() - 1)); } else { return null; } } }