Package nl.bimbase.bimworks.client

Class BimWorksClient

java.lang.Object

nl.bimbase.bimworks.client.BimWorksClient

All Implemented Interfaces:

java.lang.AutoCloseable

public class BimWorksClient
extends java.lang.Object
implements java.lang.AutoCloseable

BimWorksClient object can be short-lived objects (but long-lived objects are fine too). BimWorksClient objects are usually authenticated by either a username/password combination, a BIM.works API Token, or some other type of auth. BimWorksClient objects cannot be constructed directly, but only through the BimWorksClientFactory.

Field Summary

Fields

Modifier and Type	Field	Description
AdminApi	admin
AuthApi	auth
Bim	bim
FileSystemApi	fs
GisApi	gis
IfcApi	ifc
ModelChecks	modelChecks
static com.fasterxml.jackson.databind.ObjectMapper	OBJECT_MAPPER
TokensApi	tokens
UploadApi	upload

Method Summary

Modifier and Type	Method	Description
void	close()
nl.sascom.backplanepublic.common.ClientTask	createAsyncTask(nl.sascom.backplanepublic.common.Request request)
nl.sascom.backplanepublic.common.Request	createRequest()
com.fasterxml.jackson.databind.JsonNode	executeAsyncTask(nl.sascom.backplanepublic.common.Request request)
com.fasterxml.jackson.databind.node.ObjectNode	executeForObject(Task taskInput)
nl.sascom.backplanepublic.common.Response	executeForResponse(Task taskInput)
com.fasterxml.jackson.databind.node.ObjectNode	generateDownloadToken(java.util.UUID newNodeUuid, java.time.Duration duration)
com.fasterxml.jackson.databind.node.ObjectNode	generateQueryToken(java.util.Set<java.util.UUID> versionUuids, BimQuery bimQuery, java.lang.String[] paths, java.time.Duration duration)
com.fasterxml.jackson.databind.node.ObjectNode	generateUploadToken(java.util.UUID parentUuid, java.time.Duration duration, java.nio.file.Path path)
nl.sascom.backplanepublic.client.NodeClient	getApi()
java.lang.String	getApplicationVersion()
java.lang.String	getLastScreenshotNew(java.util.UUID lastVersionUuid)
nl.sascom.backplanepublic.client.NodeClient	getNodeClient()
com.fasterxml.jackson.databind.node.ArrayNode	listModelsForGis()
java.lang.String	registerStream(java.lang.String filename, long filesize, java.lang.String contentType, java.io.InputStream inputStream)
java.lang.String	registerStream(java.lang.String filename, java.lang.String contentType, java.lang.String url, long filesize)
java.lang.String	registerStream(java.nio.file.Path path)
void	setAuthToken(com.fasterxml.jackson.databind.node.ObjectNode auth)
UploadModelResponse	uploadModelWithToken(java.nio.file.Path path, com.fasterxml.jackson.databind.node.ObjectNode payload)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OBJECT_MAPPER

public static final com.fasterxml.jackson.databind.ObjectMapper OBJECT_MAPPER

fs

public final FileSystemApi fs

gis

public final GisApi gis

auth

public final AuthApi auth

ifc

public final IfcApi ifc

upload

public final UploadApi upload

tokens

public final TokensApi tokens

bim

public final Bim bim

admin

public final AdminApi admin

modelChecks

public final ModelChecks modelChecks

Method Detail

close

public void close()
           throws java.lang.InterruptedException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.InterruptedException

getNodeClient

public nl.sascom.backplanepublic.client.NodeClient getNodeClient()

generateUploadToken

public com.fasterxml.jackson.databind.node.ObjectNode generateUploadToken(java.util.UUID parentUuid,
                                                                          java.time.Duration duration,
                                                                          java.nio.file.Path path)
                                                                   throws BimWorksException

Throws:

BimWorksException

uploadModelWithToken

public UploadModelResponse uploadModelWithToken(java.nio.file.Path path,
                                                com.fasterxml.jackson.databind.node.ObjectNode payload)
                                         throws java.io.IOException,
                                                nl.sascom.backplanepublic.common.StreamAlreadyRegisteredException,
                                                NodeAlreadyExistsException,
                                                java.lang.InterruptedException,
                                                BimWorksException

Throws:

java.io.IOException

nl.sascom.backplanepublic.common.StreamAlreadyRegisteredException

NodeAlreadyExistsException

java.lang.InterruptedException

BimWorksException

generateDownloadToken

public com.fasterxml.jackson.databind.node.ObjectNode generateDownloadToken(java.util.UUID newNodeUuid,
                                                                            java.time.Duration duration)
                                                                     throws BimWorksException

Throws:

BimWorksException

generateQueryToken

public com.fasterxml.jackson.databind.node.ObjectNode generateQueryToken(java.util.Set<java.util.UUID> versionUuids,
                                                                         BimQuery bimQuery,
                                                                         java.lang.String[] paths,
                                                                         java.time.Duration duration)
                                                                  throws BimWorksException

Throws:

BimWorksException

getApplicationVersion

public java.lang.String getApplicationVersion()
                                       throws java.io.IOException,
                                              nl.sascom.backplanepublic.common.ExecuteException

Throws:

java.io.IOException

nl.sascom.backplanepublic.common.ExecuteException

listModelsForGis

public com.fasterxml.jackson.databind.node.ArrayNode listModelsForGis()
                                                               throws BimWorksException

Throws:

BimWorksException

getApi

public nl.sascom.backplanepublic.client.NodeClient getApi()

getLastScreenshotNew

public java.lang.String getLastScreenshotNew(java.util.UUID lastVersionUuid)
                                      throws BimWorksException

Throws:

BimWorksException

executeAsyncTask

public com.fasterxml.jackson.databind.JsonNode executeAsyncTask(nl.sascom.backplanepublic.common.Request request)
                                                         throws BimWorksException

Throws:

BimWorksException

createRequest

public nl.sascom.backplanepublic.common.Request createRequest()

createAsyncTask

public nl.sascom.backplanepublic.common.ClientTask createAsyncTask(nl.sascom.backplanepublic.common.Request request)

registerStream

public java.lang.String registerStream(java.nio.file.Path path)
                                throws nl.sascom.backplanepublic.common.StreamAlreadyRegisteredException

Throws:

nl.sascom.backplanepublic.common.StreamAlreadyRegisteredException

registerStream

public java.lang.String registerStream(java.lang.String filename,
                                       java.lang.String contentType,
                                       java.lang.String url,
                                       long filesize)
                                throws java.net.MalformedURLException,
                                       nl.sascom.backplanepublic.common.StreamAlreadyRegisteredException

Throws:

java.net.MalformedURLException

nl.sascom.backplanepublic.common.StreamAlreadyRegisteredException

registerStream

public java.lang.String registerStream(java.lang.String filename,
                                       long filesize,
                                       java.lang.String contentType,
                                       java.io.InputStream inputStream)
                                throws nl.sascom.backplanepublic.common.StreamAlreadyRegisteredException

Throws:

nl.sascom.backplanepublic.common.StreamAlreadyRegisteredException

setAuthToken

public void setAuthToken(com.fasterxml.jackson.databind.node.ObjectNode auth)

executeForObject

public com.fasterxml.jackson.databind.node.ObjectNode executeForObject(Task taskInput)
                                                                throws BimWorksException

Throws:

BimWorksException

executeForResponse

public nl.sascom.backplanepublic.common.Response executeForResponse(Task taskInput)
                                                             throws BimWorksException

Throws:

BimWorksException