Package nl.bimbase.bimworks.client

Class BimWorksClient

java.lang.Object

nl.bimbase.bimworks.client.BimWorksClient

All Implemented Interfaces:

AutoCloseable

public class BimWorksClient
extends Object
implements 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
final AdminApi	admin
final AuthApi	auth
final BcfApi	bcf
final BimApi	bim
final FileSystemApi	fs
final Geometry2d	geometry2d
final Geometry3d	geometry3d
final GisApi	gis
final IfcApi	ifc
final ModelChecksApi	modelChecks
static final com.fasterxml.jackson.databind.ObjectMapper	OBJECT_MAPPER
final RenderApi	render
final TokensApi	tokens
final UploadApi	upload

Method Summary

Modifier and Type	Method	Description
void	close()
nl.sascom.backplane.common.ClientTask	createAsyncTask(nl.sascom.backplane.common.Request request)
nl.sascom.backplane.common.Request	createRequest()
com.fasterxml.jackson.databind.JsonNode	executeAsyncTask(nl.sascom.backplane.common.Request request)
com.fasterxml.jackson.databind.node.ArrayNode	executeForArray(Task taskInput)
com.fasterxml.jackson.databind.node.ObjectNode	executeForObject(Task taskInput)
nl.sascom.backplane.common.Response	executeForResponse(Task taskInput)
com.fasterxml.jackson.databind.node.ObjectNode	generateDownloadToken(UUID newNodeUuid, Duration duration)
com.fasterxml.jackson.databind.node.ObjectNode	generateQueryToken(Set<UUID> versionUuids, BimQuery bimQuery, String[] paths, Duration duration)
com.fasterxml.jackson.databind.node.ObjectNode	generateUploadToken(UUID parentUuid, Duration duration, Path path)
nl.sascom.backplane.client.NodeClient	getApi()
String	getApplicationVersion()
BimWorksClientFactory	getFactory()
nl.bimbase.bimworks.common.HashManager	getHashManager()
String	getLastScreenshotNew(UUID lastVersionUuid)
nl.sascom.backplane.client.NodeClient	getNodeClient()
com.fasterxml.jackson.databind.node.ArrayNode	listModelsForGis()
String	registerStream(String filename, long filesize, String contentType, InputStream inputStream)
String	registerStream(String filename, String contentType, String url, long filesize)
String	registerStream(Path path)
void	setAuthToken(com.fasterxml.jackson.databind.node.ObjectNode auth)

Methods inherited from class java.lang.Object

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

Field Details

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 BimApi bim

bcf

public final BcfApi bcf

admin

public final AdminApi admin

modelChecks

public final ModelChecksApi modelChecks

geometry2d

public final Geometry2d geometry2d

geometry3d

public final Geometry3d geometry3d

render

public final RenderApi render

Method Details

close

public void close()
           throws InterruptedException

Specified by:

close in interface AutoCloseable

Throws:

InterruptedException

getNodeClient

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

generateUploadToken

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

Throws:

BimWorksException

generateDownloadToken

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

Throws:

BimWorksException

generateQueryToken

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

Throws:

BimWorksException

getApplicationVersion

public String getApplicationVersion()
                             throws IOException,
nl.sascom.backplane.common.ExecuteException

Throws:

IOException

nl.sascom.backplane.common.ExecuteException

listModelsForGis

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

Throws:

BimWorksException

getApi

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

getLastScreenshotNew

public String getLastScreenshotNew(UUID lastVersionUuid)
                            throws BimWorksException

Throws:

BimWorksException

executeAsyncTask

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

Throws:

BimWorksException

createRequest

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

createAsyncTask

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

registerStream

public String registerStream(Path path)
                      throws nl.sascom.backplane.common.StreamAlreadyRegisteredException

Throws:

nl.sascom.backplane.common.StreamAlreadyRegisteredException

registerStream

public String registerStream(String filename,
 String contentType,
 String url,
 long filesize)
                      throws MalformedURLException,
nl.sascom.backplane.common.StreamAlreadyRegisteredException

Throws:

MalformedURLException

nl.sascom.backplane.common.StreamAlreadyRegisteredException

registerStream

public String registerStream(String filename,
 long filesize,
 String contentType,
 InputStream inputStream)
                      throws nl.sascom.backplane.common.StreamAlreadyRegisteredException

Throws:

nl.sascom.backplane.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

executeForArray

public com.fasterxml.jackson.databind.node.ArrayNode executeForArray(Task taskInput)
                                                              throws BimWorksException

Throws:

BimWorksException

executeForResponse

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

Throws:

BimWorksException

getFactory

public BimWorksClientFactory getFactory()

getHashManager

public nl.bimbase.bimworks.common.HashManager getHashManager()