com.orbitz.consul

Class SessionClient

java.lang.Object

com.orbitz.consul.SessionClient

public class SessionClient
extends Object

HTTP Client for /v1/session/ endpoints.

See Also:

The Consul API Docs

Field Summary

Fields

Modifier and Type	Field and Description
protected Http	http

Method Summary

Modifier and Type	Method and Description
SessionCreatedResponse	createSession(Session value) Create Session.
SessionCreatedResponse	createSession(Session value, String dc) Create Session.
void	destroySession(String sessionId) Destroys a session.
void	destroySession(String sessionId, String dc) Destroys a session.
ClientConfig	getConfig()
ClientEventHandler	getEventHandler()
Optional<SessionInfo>	getSessionInfo(String sessionId) Retrieves session info.
Optional<SessionInfo>	getSessionInfo(String sessionId, String dc) Retrieves session info.
List<SessionInfo>	listSessions() Lists all sessions.
List<SessionInfo>	listSessions(String dc) Lists all sessions.
Optional<SessionInfo>	renewSession(String sessionId)
Optional<SessionInfo>	renewSession(String dc, String sessionId) Renews a session.

Methods inherited from class java.lang.Object

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

Field Detail

http

protected final Http http

Method Detail

createSession

public SessionCreatedResponse createSession(Session value)

Create Session. PUT /v1/session/create

Parameters:

value - The session to create.

Returns:

ID of the newly created session .

createSession

public SessionCreatedResponse createSession(Session value,
                                            String dc)

Create Session. PUT /v1/session/create

Parameters:

value - The session to create.

dc - The data center.

Returns:

Response containing the session ID.

renewSession

public Optional<SessionInfo> renewSession(String sessionId)

renewSession

public Optional<SessionInfo> renewSession(String dc,
                                          String sessionId)

Renews a session.

Parameters:

dc - The datacenter.

sessionId - The session ID to renew.

Returns:

The SessionInfo object for the renewed session.

destroySession

public void destroySession(String sessionId)

Destroys a session. PUT /v1/session/destroy/{sessionId}

Parameters:

sessionId - The session ID to destroy.

destroySession

public void destroySession(String sessionId,
                           String dc)

Destroys a session. PUT /v1/session/destroy/{sessionId}

Parameters:

sessionId - The session ID to destroy.

dc - The data center.

getSessionInfo

public Optional<SessionInfo> getSessionInfo(String sessionId)

Retrieves session info. GET /v1/session/info/{sessionId}

Parameters:

sessionId -

Returns:

SessionInfo.

getSessionInfo

public Optional<SessionInfo> getSessionInfo(String sessionId,
                                            String dc)

Retrieves session info. GET /v1/session/info/{sessionId}

Parameters:

sessionId -

dc - Data center

Returns:

SessionInfo.

listSessions

public List<SessionInfo> listSessions(String dc)

Lists all sessions. GET /v1/session/list

Parameters:

dc - The data center.

Returns:

A list of available sessions.

listSessions

public List<SessionInfo> listSessions()

Lists all sessions. GET /v1/session/list

Returns:

A list of available sessions.

getConfig

public ClientConfig getConfig()

getEventHandler

public ClientEventHandler getEventHandler()