Package org.apache.wiki

Class WikiSession

java.lang.Object
org.apache.wiki.WikiSession
All Implemented Interfaces:
EventListener, org.apache.wiki.api.core.Session, org.apache.wiki.event.WikiEventListener
public class WikiSession extends Object implements org.apache.wiki.api.core.Session

Default implementation for Session.

In addition to methods for examining individual WikiSession objects, this class also contains a number of static methods for managing WikiSessions for an entire wiki. These methods allow callers to find, query and remove WikiSession objects, and to obtain a list of the current wiki session users.

  • Method Details

    • isInGroup

      protected boolean isInGroup(Group group)
      Returns true if one of this WikiSession's user Principals can be shown to belong to a particular wiki group. If the user is not authenticated, this method will always return false.
      Parameters:
      group - the group to test
      Returns:
      the result

    • isAsserted

      public boolean isAsserted()
      Specified by:
      isAsserted in interface org.apache.wiki.api.core.Session

    • isAuthenticated

      public boolean isAuthenticated()
      Specified by:
      isAuthenticated in interface org.apache.wiki.api.core.Session

    • isAnonymous

      public boolean isAnonymous()
      Specified by:
      isAnonymous in interface org.apache.wiki.api.core.Session

    • getLoginPrincipal

      public Principal getLoginPrincipal()
      Specified by:
      getLoginPrincipal in interface org.apache.wiki.api.core.Session

    • getUserPrincipal

      public Principal getUserPrincipal()
      Specified by:
      getUserPrincipal in interface org.apache.wiki.api.core.Session

    • antiCsrfToken

      public String antiCsrfToken()
      Specified by:
      antiCsrfToken in interface org.apache.wiki.api.core.Session

    • getLocale

      public Locale getLocale()
      Specified by:
      getLocale in interface org.apache.wiki.api.core.Session

    • addMessage

      public void addMessage(String message)
      Specified by:
      addMessage in interface org.apache.wiki.api.core.Session

    • addMessage

      public void addMessage(String topic, String message)
      Specified by:
      addMessage in interface org.apache.wiki.api.core.Session

    • clearMessages

      public void clearMessages()
      Specified by:
      clearMessages in interface org.apache.wiki.api.core.Session

    • clearMessages

      public void clearMessages(String topic)
      Specified by:
      clearMessages in interface org.apache.wiki.api.core.Session

    • getMessages

      public String[] getMessages()
      Specified by:
      getMessages in interface org.apache.wiki.api.core.Session

    • getMessages

      public String[] getMessages(String topic)
      Specified by:
      getMessages in interface org.apache.wiki.api.core.Session

    • getPrincipals

      public Principal[] getPrincipals()
      Specified by:
      getPrincipals in interface org.apache.wiki.api.core.Session

    • getRoles

      public Principal[] getRoles()
      Specified by:
      getRoles in interface org.apache.wiki.api.core.Session

    • hasPrincipal

      public boolean hasPrincipal(Principal principal)
      Specified by:
      hasPrincipal in interface org.apache.wiki.api.core.Session

    • actionPerformed

      public void actionPerformed(org.apache.wiki.event.WikiEvent event)
      Listens for WikiEvents generated by source objects such as the GroupManager, UserManager or AuthenticationManager. This method adds Principals to the private Subject managed by the WikiSession.
      Specified by:
      actionPerformed in interface org.apache.wiki.event.WikiEventListener
      See Also:
      • WikiEventListener.actionPerformed(WikiEvent)

    • invalidate

      public void invalidate()
      Specified by:
      invalidate in interface org.apache.wiki.api.core.Session

    • injectGroupPrincipals

      protected void injectGroupPrincipals()
      Injects GroupPrincipal objects into the user's Principal set based on the groups the user belongs to. For Groups, the algorithm first calls the Authorizer.getRoles() to obtain the array of GroupPrincipals the authorizer knows about. Then, the method Authorizer.isUserInRole(Session, Principal) is called for each Principal. If the user is a member of the group, an equivalent GroupPrincipal is injected into the user's principal set. Existing GroupPrincipals are flushed and replaced. This method should generally be called after a user's UserProfile is saved. If the wiki session is null, or there is no matching user profile, the method returns silently.

    • injectUserProfilePrincipals

      protected void injectUserProfilePrincipals()
      Adds Principal objects to the Subject that correspond to the logged-in user's profile attributes for the wiki name, full name and login name. These Principals will be WikiPrincipals, and they will replace all other WikiPrincipals in the Subject. Note: this method is never called during anonymous or asserted sessions.

    • getStatus

      public String getStatus()
      Specified by:
      getStatus in interface org.apache.wiki.api.core.Session

    • getSubject

      public Subject getSubject()
      Specified by:
      getSubject in interface org.apache.wiki.api.core.Session

    • removeWikiSession

      public static void removeWikiSession(org.apache.wiki.api.core.Engine engine, jakarta.servlet.http.HttpServletRequest request)
      Removes the wiki session associated with the user's HTTP request from the cache of wiki sessions, typically as part of a logout process.
      Parameters:
      engine - the wiki engine
      request - the user's HTTP request

    • getWikiSession

      public static org.apache.wiki.api.core.Session getWikiSession(org.apache.wiki.api.core.Engine engine, jakarta.servlet.http.HttpServletRequest request)

      Static factory method that returns the Session object associated with the current HTTP request. This method looks up the associated HttpSession in an internal WeakHashMap and attempts to retrieve the WikiSession. If not found, one is created. This method is guaranteed to always return a Session, although the authentication status is unpredictable until the user attempts to log in. If the servlet request parameter is null, a synthetic guestSession(Engine) is returned.

      When a session is created, this method attaches a WikiEventListener to the GroupManager, UserManager and AuthenticationManager, so that changes to users, groups, logins, etc. are detected automatically.

      Parameters:
      engine - the engine
      request - the servlet request object
      Returns:
      the existing (or newly created) session

    • guestSession

      public static org.apache.wiki.api.core.Session guestSession(org.apache.wiki.api.core.Engine engine)
      Static factory method that creates a new "guest" session containing a single user Principal WikiPrincipal.GUEST, plus the role principals Role.ALL and Role.ANONYMOUS. This method also adds the session as a listener for GroupManager, AuthenticationManager and UserManager events.
      Parameters:
      engine - the wiki engine
      Returns:
      the guest wiki session

    • sessions

      @Deprecated public static int sessions(org.apache.wiki.api.core.Engine engine)
      Deprecated.
      use SessionMonitor.sessions() instead
      Returns the total number of active wiki sessions for a particular wiki. This method delegates to the wiki's SessionMonitor.sessions() method.
      Parameters:
      engine - the wiki session
      Returns:
      the number of sessions
      See Also:

    • userPrincipals

      @Deprecated public static Principal[] userPrincipals(org.apache.wiki.api.core.Engine engine)
      Deprecated.
      use SessionMonitor.userPrincipals() instead
      Returns Principals representing the current users known to a particular wiki. Each Principal will correspond to the value returned by each WikiSession's getUserPrincipal() method. This method delegates to SessionMonitor.userPrincipals().
      Parameters:
      engine - the wiki engine
      Returns:
      an array of Principal objects, sorted by name
      See Also:

    • getRemoteAddress

      public String getRemoteAddress()
      Specified by:
      getRemoteAddress in interface org.apache.wiki.api.core.Session