Package io.vertx.mutiny.ext.web

Class Session

java.lang.Object
io.vertx.mutiny.ext.web.Session
All Implemented Interfaces:
MutinyDelegate
public class Session extends Object implements MutinyDelegate
Represents a browser session.

Sessions persist between HTTP requests for a single browser session. They are deleted when the browser is closed, or they time-out. Session cookies are used to maintain sessions using a secure UUID.

Sessions can be used to maintain data for a browser session, e.g. a shopping basket.

The context must have first been routed to a SessionHandler for sessions to be available.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface.

Author:
Tim Fox
See Also:
  • Session

  • Field Details

  • Constructor Details

    • Session

      public Session(io.vertx.ext.web.Session delegate)
      Create a new instance of Session delegating to the given (non-null) instance of Session.

    • Session

      public Session(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.web.Session getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate instance

    • regenerateId

      public Session regenerateId()
      Returns:
      The new unique ID of the session.

    • id

      public String id()
      Returns:
      The unique ID of the session. This is generated using a random secure UUID.

    • put

      public Session put(String key, Object obj)
      Put some data in a session
      Parameters:
      key - the key for the data
      obj - the data
      Returns:
      a reference to this, so the API can be used fluently

    • putIfAbsent

      public Session putIfAbsent(String key, Object obj)
      Put some data in a session if absent
      Parameters:
      key - the key for the data
      obj - the data
      Returns:
      a reference to this, so the API can be used fluently

    • computeIfAbsent

      public Session computeIfAbsent(String key, Function<String,Object> mappingFunction)
      Put some data in a session if absent. If the specified key is not already associated with a value (or is mapped to null), attempts to compute its value using the given mapping function and enters it into this map unless null.
      Parameters:
      key - the key for the data
      mappingFunction - a mapping function
      Returns:
      a reference to this, so the API can be used fluently

    • get

      public <T> T get(String key)
      Get some data from the session
      Parameters:
      key - the key of the data
      Returns:
      the data

    • remove

      public <T> T remove(String key)
      Remove some data from the session
      Parameters:
      key - the key of the data
      Returns:
      the data that was there or null if none there

    • data

      public Map<String,Object> data()
      Returns:
      the session data as a map

    • isEmpty

      public boolean isEmpty()
      Returns:
      true if the session has data

    • lastAccessed

      public long lastAccessed()
      Returns:
      the time the session was last accessed

    • destroy

      public void destroy()
      Destroy the session

    • isDestroyed

      public boolean isDestroyed()
      Returns:
      has the session been destroyed?

    • isRegenerated

      public boolean isRegenerated()
      Returns:
      has the session been renewed?

    • oldId

      public String oldId()
      Returns:
      old ID if renewed

    • timeout

      public long timeout()
      Returns:
      the amount of time in ms, after which the session will expire, if not accessed.

    • setAccessed

      public void setAccessed()
      Mark the session as being accessed.

    • value

      public String value()
      The short representation of the session to be added to the session cookie. By default is the session id.
      Returns:
      short representation string.

    • newInstance

      public static Session newInstance(io.vertx.ext.web.Session delegate)
      Creates a new instance of the Session.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object