Package com.orbitz.consul

Class SessionClient

  • public class SessionClient
extends java.lang.Object
    HTTP Client for /v1/session/ endpoints.
    See Also:
    The Consul API Docs

    • 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,
                                            java.lang.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 java.util.Optional<SessionInfo> renewSession​(java.lang.String sessionId)

      • renewSession

        public java.util.Optional<SessionInfo> renewSession​(java.lang.String dc,
                                                    java.lang.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​(java.lang.String sessionId)
        Destroys a session. PUT /v1/session/destroy/{sessionId}
        Parameters:
        sessionId - The session ID to destroy.

      • destroySession

        public void destroySession​(java.lang.String sessionId,
                           java.lang.String dc)
        Destroys a session. PUT /v1/session/destroy/{sessionId}
        Parameters:
        sessionId - The session ID to destroy.
        dc - The data center.

      • getSessionInfo

        public java.util.Optional<SessionInfo> getSessionInfo​(java.lang.String sessionId)
        Retrieves session info. GET /v1/session/info/{sessionId}
        Parameters:
        sessionId -
        Returns:
        SessionInfo.

      • getSessionInfo

        public java.util.Optional<SessionInfo> getSessionInfo​(java.lang.String sessionId,
                                                      java.lang.String dc)
        Retrieves session info. GET /v1/session/info/{sessionId}
        Parameters:
        sessionId -
        dc - Data center
        Returns:
        SessionInfo.

      • listSessions

        public java.util.List<SessionInfo> listSessions​(java.lang.String dc)
        Lists all sessions. GET /v1/session/list
        Parameters:
        dc - The data center.
        Returns:
        A list of available sessions.

      • listSessions

        public java.util.List<SessionInfo> listSessions()
        Lists all sessions. GET /v1/session/list
        Returns:
        A list of available sessions.