Package com.logicaldoc.webservice.soap

Interface AuthService

All Known Implementing Classes:
RestAuthService, RestAuthSwagger, SoapAuthClient, SoapAuthService
public interface AuthService
Auth Web Service definition interface
Since:
5.2
Author:
Matteo Caruso - LogicalDOC

  • Method Details

    • login

      String login(String username, String password) throws AuthenticationException
      Starts a new session.
      Parameters:
      username - The username
      password - The password
      Returns:
      The newly created session identifier(sid)
      Throws:
      AuthenticationException - the user was not authenticated

    • loginApiKey

      String loginApiKey(String apiKey) throws AuthenticationException
      Starts a new session.
      Parameters:
      apiKey - The API Key
      Returns:
      The newly created session identifier(sid)
      Throws:
      AuthenticationException - the user was not authenticated

    • logout

      void logout(String sid)
      Closes a session.
      Parameters:
      sid - identifier of the session or an API Key

    • valid

      boolean valid(String sid)
      Checks if a SID is valid
      Parameters:
      sid - identifier of the session or an API Key
      Returns:
      if the session is valid

    • renew

      void renew(String sid)
      Renews a session
      Parameters:
      sid - identifier of the session or an API Key