Package org.bonitasoft.web.client

Interface BonitaClient

All Superinterfaces:
ApiProvider
public interface BonitaClient extends ApiProvider
A Bonita client that communicate via http request with a Bonita running instance.

  • Field Details

  • Method Details

    • builder

      static <T extends BonitaClientBuilder<T>> BonitaClientBuilder<T> builder(String url)
      Create a client builder for the given bonita URL
      Parameters:
      url - the bonita instance url
      Returns:
      a builder instance

    • login

      Session login(String username, String password)
      Perform client authentication. Authentication will be stored internally to be used for the future requests
      Parameters:
      username - Account username
      password - Account password
      Returns:
      A session with the authenticated user info
      Throws:
      UnauthorizedException - if authentication failed

    • setBearerToken

      void setBearerToken(String token)
      Set Bearer authorization header token Can be used to pass an Oauth2 access token when Bonita is configured for SSO with OpenID Connect
      Parameters:
      token - the bearer token (Oauth2 access token)

    • logout

      void logout()
      Logout the current user

    • logoutSilent

      void logoutSilent()
      Logout the current user (with no exceptions)

    • isPlatformUpAndRunning

      boolean isPlatformUpAndRunning()
      Return true if platform is up
      Returns:

    • getUrl

      String getUrl()
      The Bonita target url (ie. http://localhost:8080/bonita/)
      Returns:

    • getVersion

      String getVersion()
      The targeted Bonita version
      Returns:

    • applications

      ApplicationService applications()
      Return the application API
      Returns:

    • bdm

      BdmService bdm()
      Return the BDM API
      Returns:

    • users

      UserService users()
      Return the user API
      Returns:

    • processes

      ProcessService processes()
      Return the process API
      Returns:

    • system

      SystemService system()
      Return the system service
      Returns: