Package org.apache.wiki

Class WikiSession

  • All Implemented Interfaces:
    java.util.EventListener, Session, WikiEventListener
    public class WikiSession
extends java.lang.Object
implements 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 Detail

      • 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

      • addMessage

        public void addMessage​(java.lang.String topic,
                       java.lang.String message)
        Specified by:
        addMessage in interface 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.

      • removeWikiSession

        public static void removeWikiSession​(Engine engine,
                                     javax.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 Session getWikiSession​(Engine engine,
                                     javax.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 Session guestSession​(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