Class SoapAuthClient

java.lang.Object
com.logicaldoc.webservice.soap.client.SoapClient<AuthService>
com.logicaldoc.webservice.soap.client.SoapAuthClient
All Implemented Interfaces:
AuthService

public class SoapAuthClient extends SoapClient<AuthService> implements AuthService
Auth Web Service client (SOAP).
Since:
7.5
Author:
Marco Meschieri - LogicalDOC
  • Constructor Details

    • SoapAuthClient

      public SoapAuthClient(String endpoint)
  • Method Details

    • login

      public String login(String username, String password) throws AuthenticationException
      Description copied from interface: AuthService
      Starts a new session.
      Specified by:
      login in interface AuthService
      Parameters:
      username - The username
      password - The password
      Returns:
      The newly created session identifier(sid)
      Throws:
      AuthenticationException - the user was not authenticated
    • loginApiKey

      public String loginApiKey(String apiKey) throws AuthenticationException
      Description copied from interface: AuthService
      Starts a new session.
      Specified by:
      loginApiKey in interface AuthService
      Parameters:
      apiKey - The API Key
      Returns:
      The newly created session identifier(sid)
      Throws:
      AuthenticationException - the user was not authenticated
    • logout

      public void logout(String sid)
      Description copied from interface: AuthService
      Closes a session.
      Specified by:
      logout in interface AuthService
      Parameters:
      sid - identifier of the session or an API Key
    • valid

      public boolean valid(String sid)
      Description copied from interface: AuthService
      Checks if a SID is valid
      Specified by:
      valid in interface AuthService
      Parameters:
      sid - identifier of the session or an API Key
      Returns:
      if the session is valid
    • renew

      public void renew(String sid)
      Description copied from interface: AuthService
      Renews a session
      Specified by:
      renew in interface AuthService
      Parameters:
      sid - identifier of the session or an API Key