Package com.priint.pubserver.session

Interface SessionManagerRemote

  • All Known Subinterfaces:
    SessionManagerLocal
    public interface SessionManagerRemote
    Remote interface for a session manager class defining method signatures for necessary session handling functions.

    • Field Detail

      • REMOTE_ADDRESS_PROPERTY

        static final java.lang.String REMOTE_ADDRESS_PROPERTY
        Session property name for remote IP address of client.
        See Also:
        Constant Field Values

      • SESSION_TRACE_ACTIVE_PROPERTY

        static final java.lang.String SESSION_TRACE_ACTIVE_PROPERTY
        Session property name for session tracing state.
        See Also:
        Constant Field Values

      • SESSION_LOGIN_PROPERTY

        static final java.lang.String SESSION_LOGIN_PROPERTY
        Session property name for session login name.
        See Also:
        Constant Field Values

      • SESSION_TENANT_PROPERTY

        static final java.lang.String SESSION_TENANT_PROPERTY
        Session property name for session client (tenant) name.
        See Also:
        Constant Field Values

      • SESSION_CLIENT_TYPE_PROPERTY

        static final java.lang.String SESSION_CLIENT_TYPE_PROPERTY
        Session property name for type of client application using this session.
        See Also:
        Constant Field Values

      • SESSION_CLIENT_TYPE_ISON

        static final java.lang.String SESSION_CLIENT_TYPE_ISON
        Session property value if the session was initialized via Ison SOAP service.
        See Also:
        Constant Field Values

      • SESSION_CLIENT_TYPE_REST_SERVICE

        static final java.lang.String SESSION_CLIENT_TYPE_REST_SERVICE
        Session property value if the session was initialized via REST client.
        See Also:
        Constant Field Values

      • SESSION_CLIENT_TYPE_PRIINT_SUITE

        static final java.lang.String SESSION_CLIENT_TYPE_PRIINT_SUITE
        Session property value if the session was initialized via publishing server Web UI (priint:suite).
        See Also:
        Constant Field Values

      • SESSION_CLIENT_TYPE_COMET_BRIDGE

        static final java.lang.String SESSION_CLIENT_TYPE_COMET_BRIDGE
        Session property value if the session was initialized via CometBridge SOAP service, i.e. in most cases InDesign comet plug-in.
        See Also:
        Constant Field Values

      • SESSION_CLIENT_TYPE_JOB

        static final java.lang.String SESSION_CLIENT_TYPE_JOB
        Session property value if the session was initialized internally via an Server Job (or Workflow Job).
        See Also:
        Constant Field Values

      • SESSION_CLIENT_TYPE_WHITEBOARD

        static final java.lang.String SESSION_CLIENT_TYPE_WHITEBOARD
        Session property value if the session was initialized via Whiteboard, i.e. Flex.
        See Also:
        Constant Field Values

      • USER_INDEX_PATH

        @Deprecated
static final java.lang.String USER_INDEX_PATH
        Deprecated.
        Repository location to store information on users.
        See Also:
        Constant Field Values

      • USER_ADMIN_PATH

        @Deprecated
static final java.lang.String USER_ADMIN_PATH
        Deprecated.
        Repository location to store admin user information.
        See Also:
        Constant Field Values

    • Method Detail

      • getSessionUser

        java.lang.String getSessionUser​(java.lang.String sessionId)
                         throws SessionNotAuthenticated
        Get current user associated with the session.
        Parameters:
        sessionId -
        Returns:
        login name of the current user
        Throws:
        SessionNotAuthenticated

      • setSessionAttribute

        void setSessionAttribute​(java.lang.String sessionId,
                         java.lang.String key,
                         java.lang.Object object)
                  throws InvalidSessionException
        Save data into session store.

        Parameters:
        sessionId -
        key -
        object -
        Throws:
        InvalidSessionException

      • getSessionAttribute

        java.lang.Object getSessionAttribute​(java.lang.String sessionId,
                                     java.lang.String key)
                              throws InvalidSessionException
        Get data from the session store.
        Parameters:
        sessionId -
        key -
        Returns:
        value associated to the key
        Throws:
        InvalidSessionException

      • getSessionList

        java.util.List<org.apache.shiro.session.mgt.SimpleSession> getSessionList()
        Retrieve a list of active sessions.
        Returns:
        list of sessions

      • getSimpleSession

        org.apache.shiro.session.mgt.SimpleSession getSimpleSession​(java.lang.String sessionId)
        Get session object given a sessionId.
        Parameters:
        sessionId -
        Returns:
        session object

      • checkAdminUser

        void checkAdminUser()
        Check whether the default administrative user exists. Default administrative user has login name "admin".

      • getPubServerSessionList

        java.util.List<PubServerSimpleSession> getPubServerSessionList()
        Retrieve the existing sessions.
        Returns:
        list of sessions

      • getCometServerSessions

        java.util.Map<java.lang.String,​java.lang.Object> getCometServerSessions()
        Get all comet server sessions.

        A hash map with [sessionId => session info object] will be returned,

        Returns:
        the existing sessions or empty list