Package io.undertow.server.session

Class PathParameterSessionConfig

  • All Implemented Interfaces:
    SessionConfig
    public class PathParameterSessionConfig
extends java.lang.Object
implements SessionConfig
    Session config that is based on a path parameter and URL rewriting
    Author:
    Stuart Douglas

    • Constructor Detail

      • PathParameterSessionConfig

        public PathParameterSessionConfig​(java.lang.String name)

      • PathParameterSessionConfig

        public PathParameterSessionConfig()

    • Method Detail

      • setSessionId

        public void setSessionId​(HttpServerExchange exchange,
                         java.lang.String sessionId)
        Description copied from interface: SessionConfig
        Attaches the session to the exchange. The method should attach the exchange under an attachment key, and should also modify the exchange to allow the session to be re-attached on the next request.

        Generally this will involve setting a cookie

        Once a session has been attached it must be possible to retrieve it via SessionConfig.findSessionId(io.undertow.server.HttpServerExchange)

        Specified by:
        setSessionId in interface SessionConfig
        Parameters:
        exchange - The exchange
        sessionId - The session

      • clearSession

        public void clearSession​(HttpServerExchange exchange,
                         java.lang.String sessionId)
        Description copied from interface: SessionConfig
        Clears this session from the exchange, removing the attachment and making any changes to the response necessary, such as clearing cookies.
        Specified by:
        clearSession in interface SessionConfig
        Parameters:
        exchange - The exchange
        sessionId - The session id

      • findSessionId

        public java.lang.String findSessionId​(HttpServerExchange exchange)
        Description copied from interface: SessionConfig
        Retrieves a session id of an existing session from an exchange.
        Specified by:
        findSessionId in interface SessionConfig
        Parameters:
        exchange - The exchange
        Returns:
        The session id, or null

      • rewriteUrl

        public java.lang.String rewriteUrl​(java.lang.String url,
                                   java.lang.String sessionId)
        Return the specified URL with the specified session identifier suitably encoded.
        Specified by:
        rewriteUrl in interface SessionConfig
        Parameters:
        url - URL to be encoded with the session id
        sessionId - Session id to be included in the encoded URL