Package com.solibri.smc.api.bcflive

Interface BcfApi

public interface BcfApi
Interface BCF provides access to the supported BCF-API servers and services.
Since:
9.12.0

  • Method Details

    • getBCFServerList

      List<BCFServer> getBCFServerList()
      Returns a list of BCFServers from the Solibri backend.
      Returns:
      list of BCFServer types
      Since:
      9.12.0

    • authenticate

      String authenticate(BCFServer server) throws Exception
      Connects and Authenticates the given BCFServer. It opens browser where user has to enter username and password to authenticate. This method returns only after the login is successful, or unsuccessful.
      Parameters:
      server - the server
      Returns:
      authentication token if successful otherwise null
      Throws:
      Exception - if an exception happens
      Since:
      9.12.0

    • signoff

      void signoff(BCFServer server)
      Disconnects the given server. Removes stored tokens and resets the connection.
      Parameters:
      server - the server
      Since:
      9.12.0

    • getExportedSlides

      Map<UUID,Slide> getExportedSlides(Set<UUID> exportedIds)
      Gets from current Solibri model Slide instances that have already been exported with one of the given IDs.
      Parameters:
      exportedIds - the server ids
      Returns:
      mapping between ids and exported slides
      Since:
      9.12.0

    • getSlides

      Map<UUID,Slide> getSlides(Set<UUID> uuids)
      Gets slides from current Solibri model Slide instances with the given IDs.
      Parameters:
      uuids - the slide unique ids
      Returns:
      mapping between ids and slides
      Since:
      9.12.0

    • setCoordinationValues

      void setCoordinationValues(BCFCoordinationValues coordinationValues)
      Sets the BCF coordination values that are available in the Slide's coordination editor.
      Parameters:
      coordinationValues - the coordination values.
      Since:
      9.12.0