Interface IAnySession

All Known Implementing Classes:
AnySession

public interface IAnySession
The Interface IAnySession for user session.

A user session is needed to execute any action.

  • Field Details

  • Method Details

    • setLocale

      IAnySession setLocale(Locale locale)
      Sets the user session locale to use.
      Parameters:
      locale - the locale
      Returns:
      the Any user session
    • setAssumeUser

      IAnySession setAssumeUser(String assumeUser)
      Sets the assume user.

      To assume a user you must have a role of "REST APIs user". It allows you to execute actions as another user. In this case permissions and roles are verified on assumed user. If you do not have the role "REST APIs user" any action will trigger an exception.

      Parameters:
      assumeUser - the assumed user
      Returns:
      the Any session
    • setApplication

      IAnySession setApplication(String application)
      Sets the application used for this session to determine the context of the action.

      If you do not set the application you will have by default the "Default" application.

      Parameters:
      application - the application available in Any
      Returns:
      the Any session
    • getApplication

      String getApplication()
      Gets the application used by the session.
      Returns:
      the application
    • getLocale

      Locale getLocale()
      Gets the locale used by the session.
      Returns:
      the locale
    • getAuthManager

      AnyAuthManager getAuthManager()
    • getUsersManager

      AnyUsersManager getUsersManager()
      Gets the users manager instantiated from this user session.
      Returns:
      the users manager
    • getTasksManager

      AnyTasksManager getTasksManager()
      Gets the tasks manager instantiated from this user session.
      Returns:
      the tasks manager
    • getUsersDataManager

      AnyUsersDataManager getUsersDataManager()
      Gets the users data manager instantiated from this user session.
      Returns:
      the users data manager
    • getReportingManager

      AnyReportingManager getReportingManager()
      Gets the any reporting manager instantiated from this user session.
      Returns:
      the any reporting manager
    • getGroupsManager

      AnyGroupsManager getGroupsManager()
      Gets the groups manager instantiated from this user session.
      Returns:
      the groups manager
    • getRoomsManager

      AnyRoomsManager getRoomsManager()
      Gets the rooms manager instantiated from this user session.
      Returns:
      the rooms manager
    • getFoldersManager

      AnyFoldersManager getFoldersManager()
    • getMethodEventManager

      AnyMethodEventManager getMethodEventManager()
      Gets the any method event manager instantiated from this user session.
      Returns:
      the any method event manager
    • getJobManager

      AnyJobManager getJobManager()
    • getDataListManager

      AnyDataListManager getDataListManager()
    • getContentsManager

      AnyContentsManager getContentsManager()
    • getPackagesManager

      AnyPackagesManager getPackagesManager()
    • getCasesManager

      AnyCasesManager getCasesManager()
    • getConfigArchiveManager

      AnyConfigArchiveManager getConfigArchiveManager()
    • setSessionCookieName

      void setSessionCookieName(String cookieName)
      Set Any's session cookie name if different from default value.
      Parameters:
      cookieName - the session cookie name