com.orbitz.consul
Class SessionClient

java.lang.Object
  com.orbitz.consul.SessionClient

public class SessionClient
extends java.lang.Object

Method Summary

com.google.common.base.Optional<java.lang.String>	createSession(java.lang.String value) Create Session.
com.google.common.base.Optional<java.lang.String>	createSession(java.lang.String value, java.lang.String dc) Create Session.
boolean	destroySession(java.lang.String sessionId) Destroy session.
boolean	destroySession(java.lang.String sessionId, java.lang.String dc) Destroy session.
java.lang.String	getLeader() Retrieves the host/port of the Consul leader.
com.google.common.base.Optional<SessionInfo>	getSessionInfo(java.lang.String sessionId) Retrieves session info.
com.google.common.base.Optional<SessionInfo>	getSessionInfo(java.lang.String sessionId, java.lang.String dc) Retrieves session info.
boolean	renewSession(java.lang.String sessionId)
boolean	renewSession(java.lang.String dc, java.lang.String sessionId) Renew a session

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getLeader

public java.lang.String getLeader()

Retrieves the host/port of the Consul leader. GET /v1/status/leader

Returns:

The host/port of the leader.

createSession

public com.google.common.base.Optional<java.lang.String> createSession(java.lang.String value)

Create Session. PUT /v1/session/create

Parameters:

value - empty string or JSON containing one or more SessionInfo parameters (see SessionInfo)

Returns:

ID of the newly created session .

createSession

public com.google.common.base.Optional<java.lang.String> createSession(java.lang.String value,
                                                                       java.lang.String dc)

Create Session. PUT /v1/session/create

Parameters:

value - empty string or JSON containing one or more SessionInfo parameters (see SessionInfo)

dc - Data center

Returns:

ID of the newly created session .

renewSession

public boolean renewSession(java.lang.String sessionId)

renewSession

public boolean renewSession(java.lang.String dc,
                            java.lang.String sessionId)

Renew a session

Parameters:

dc -

sessionId -

Returns:

if the session was renewed

destroySession

public boolean destroySession(java.lang.String sessionId)

Destroy session. PUT /v1/session/destroy/

Parameters:

sessionId -

Returns:

ID of the newly created session .

destroySession

public boolean destroySession(java.lang.String sessionId,
                              java.lang.String dc)

Destroy session. PUT /v1/session/destroy/

Parameters:

sessionId -

dc - Data center

Returns:

ID of the newly created session .

getSessionInfo

public com.google.common.base.Optional<SessionInfo> getSessionInfo(java.lang.String sessionId)

Retrieves session info. GET /v1/session/info/

Parameters:

sessionId -

Returns:

SessionInfo.

getSessionInfo

public com.google.common.base.Optional<SessionInfo> getSessionInfo(java.lang.String sessionId,
                                                                   java.lang.String dc)

Retrieves session info. GET /v1/session/info/

Parameters:

sessionId -

dc - Data center

Returns:

SessionInfo.