Package com.priint.pubserver.session

Interface SessionManagerRemote

All Known Subinterfaces:
SessionManagerLocal
@Deprecated(since="4.7", forRemoval=true) public interface SessionManagerRemote
Deprecated, for removal: This API element is subject to removal in a future version.
This interface is no longer valid. Instead, use the new Session SDK to handle sessions.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    REMOTE_ADDRESS_PROPERTY
    Deprecated, for removal: This API element is subject to removal in a future version.
    Session property name for remote IP address of client.
    static final String
    SESSION_CLIENT_TYPE_COMET_BRIDGE
    Deprecated, for removal: This API element is subject to removal in a future version.
    Session property value if the session was initialized via CometBridge SOAP service, i.e.
    static final String
    SESSION_CLIENT_TYPE_ISON
    Deprecated, for removal: This API element is subject to removal in a future version.
    Session property value if the session was initialized via Ison SOAP service.
    static final String
    SESSION_CLIENT_TYPE_JOB
    Deprecated, for removal: This API element is subject to removal in a future version.
    Session property value if the session was initialized internally via an Server Job (or Workflow Job).
    static final String
    SESSION_CLIENT_TYPE_PRIINT_SUITE
    Deprecated, for removal: This API element is subject to removal in a future version.
    Session property value if the session was initialized via publishing server Web UI (priint:suite).
    static final String
    SESSION_CLIENT_TYPE_PROPERTY
    Deprecated, for removal: This API element is subject to removal in a future version.
    Session property name for type of client application using this session.
    static final String
    SESSION_CLIENT_TYPE_REST_SERVICE
    Deprecated, for removal: This API element is subject to removal in a future version.
    Session property value if the session was initialized via REST client.
    static final String
    SESSION_CLIENT_TYPE_WHITEBOARD
    Deprecated, for removal: This API element is subject to removal in a future version.
    Session property value if the session was initialized via Whiteboard, i.e.
    static final String
    SESSION_LOGIN_PROPERTY
    Deprecated, for removal: This API element is subject to removal in a future version.
    Session property name for session login name.
    static final String
    SESSION_TENANT_PROPERTY
    Deprecated, for removal: This API element is subject to removal in a future version.
    Session property name for session client (tenant) name.
    static final String
    SESSION_TRACE_ACTIVE_PROPERTY
    Deprecated, for removal: This API element is subject to removal in a future version.
    Session property name for session tracing state.
    static final String
    USER_ADMIN_PATH
    Deprecated.
    static final String
    USER_INDEX_PATH
    Deprecated.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    checkAdminUser()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Check whether the default administrative user exists.
    Map<String,Object>
    getCometServerSessions()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get all comet server sessions.
    List<PubServerSimpleSession>
    getPubServerSessionList()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Retrieve the existing sessions.
    Object
    getSessionAttribute(String sessionId, String key)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get data from the session store.
    List<org.apache.shiro.session.mgt.SimpleSession>
    getSessionList()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Retrieve a list of active sessions.
    String
    getSessionUser(String sessionId)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get current user associated with the session.
    org.apache.shiro.session.mgt.SimpleSession
    getSimpleSession(String sessionId)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Get session object given a sessionId.
    void
    setSessionAttribute(String sessionId, String key, Object object)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Save data into session store.

  • Field Details

    • REMOTE_ADDRESS_PROPERTY

      static final String REMOTE_ADDRESS_PROPERTY
      Deprecated, for removal: This API element is subject to removal in a future version.
      Session property name for remote IP address of client.
      See Also:

    • SESSION_TRACE_ACTIVE_PROPERTY

      static final String SESSION_TRACE_ACTIVE_PROPERTY
      Deprecated, for removal: This API element is subject to removal in a future version.
      Session property name for session tracing state.
      See Also:

    • SESSION_LOGIN_PROPERTY

      static final String SESSION_LOGIN_PROPERTY
      Deprecated, for removal: This API element is subject to removal in a future version.
      Session property name for session login name.
      See Also:

    • SESSION_TENANT_PROPERTY

      static final String SESSION_TENANT_PROPERTY
      Deprecated, for removal: This API element is subject to removal in a future version.
      Session property name for session client (tenant) name.
      See Also:

    • SESSION_CLIENT_TYPE_PROPERTY

      static final String SESSION_CLIENT_TYPE_PROPERTY
      Deprecated, for removal: This API element is subject to removal in a future version.
      Session property name for type of client application using this session.
      See Also:

    • SESSION_CLIENT_TYPE_ISON

      static final String SESSION_CLIENT_TYPE_ISON
      Deprecated, for removal: This API element is subject to removal in a future version.
      Session property value if the session was initialized via Ison SOAP service.
      See Also:

    • SESSION_CLIENT_TYPE_REST_SERVICE

      static final String SESSION_CLIENT_TYPE_REST_SERVICE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Session property value if the session was initialized via REST client.
      See Also:

    • SESSION_CLIENT_TYPE_PRIINT_SUITE

      static final String SESSION_CLIENT_TYPE_PRIINT_SUITE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Session property value if the session was initialized via publishing server Web UI (priint:suite).
      See Also:

    • SESSION_CLIENT_TYPE_COMET_BRIDGE

      static final String SESSION_CLIENT_TYPE_COMET_BRIDGE
      Deprecated, for removal: This API element is subject to removal in a future version.
      Session property value if the session was initialized via CometBridge SOAP service, i.e. in most cases InDesign comet plug-in.
      See Also:

    • SESSION_CLIENT_TYPE_JOB

      static final String SESSION_CLIENT_TYPE_JOB
      Deprecated, for removal: This API element is subject to removal in a future version.
      Session property value if the session was initialized internally via an Server Job (or Workflow Job).
      See Also:

    • SESSION_CLIENT_TYPE_WHITEBOARD

      static final String SESSION_CLIENT_TYPE_WHITEBOARD
      Deprecated, for removal: This API element is subject to removal in a future version.
      Session property value if the session was initialized via Whiteboard, i.e. Flex.
      See Also:

    • USER_INDEX_PATH

      @Deprecated static final String USER_INDEX_PATH
      Deprecated.
      Repository location to store information on users.
      See Also:

    • USER_ADMIN_PATH

      @Deprecated static final String USER_ADMIN_PATH
      Deprecated.
      Repository location to store admin user information.
      See Also:

  • Method Details

    • getSessionUser

      String getSessionUser(String sessionId) throws SessionNotAuthenticated
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get current user associated with the session.
      Parameters:
      sessionId -
      Returns:
      login name of the current user
      Throws:
      SessionNotAuthenticated

    • setSessionAttribute

      void setSessionAttribute(String sessionId, String key, Object object) throws InvalidSessionException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Save data into session store.

      Parameters:
      sessionId -
      key -
      object -
      Throws:
      InvalidSessionException

    • getSessionAttribute

      Object getSessionAttribute(String sessionId, String key) throws InvalidSessionException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get data from the session store.
      Parameters:
      sessionId -
      key -
      Returns:
      value associated to the key
      Throws:
      InvalidSessionException

    • getSessionList

      List<org.apache.shiro.session.mgt.SimpleSession> getSessionList()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieve a list of active sessions.
      Returns:
      list of sessions

    • getSimpleSession

      org.apache.shiro.session.mgt.SimpleSession getSimpleSession(String sessionId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get session object given a sessionId.
      Parameters:
      sessionId -
      Returns:
      session object

    • checkAdminUser

      void checkAdminUser()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Check whether the default administrative user exists. Default administrative user has login name "admin".

    • getPubServerSessionList

      List<PubServerSimpleSession> getPubServerSessionList()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieve the existing sessions.
      Returns:
      list of sessions

    • getCometServerSessions

      Map<String,Object> getCometServerSessions()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Get all comet server sessions.

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

      Returns:
      the existing sessions or empty list