Class BimWorksClient

java.lang.Object

nl.bimbase.bimworks.client.BimWorksClient

All Implemented Interfaces:

AutoCloseable

public class BimWorksClient
extends Object
implements AutoCloseable

Field Summary

Fields

Modifier and Type	Field	Description
final ActionsApi	actions
final AdminApi	admin
final AiApi	ai
final AuthApi	auth
final BcfApi	bcf
final BimApi	bim
final FileSystemApi	fs
final Geometry2dApi	geometry2d
final Geometry3dApi	geometry3d
final GisApi	gis
final IfcApi	ifc
final ModelChecksApi	modelChecks
static final com.fasterxml.jackson.databind.ObjectMapper	OBJECT_MAPPER
static final com.fasterxml.jackson.databind.ObjectMapper	OBJECT_MAPPER_LENIENT
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()
nl.sascom.backplane.common.Request	createRequest(String project, String taskName)
com.fasterxml.jackson.databind.JsonNode	executeAsyncTask(nl.sascom.backplane.common.Request request)	Low-level way of executing API calls, generally not needed as most API calls have a typed implementation.
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)
nl.sascom.backplane.client.NodeClient	getApi()
com.fasterxml.jackson.databind.node.ObjectNode	getApplicationVersion()	Retrieve version from the BIM.works Repository
BimWorksClientFactory	getFactory()
nl.bimbase.bimworks.common.HashManager	getHashManager()
nl.sascom.backplane.client.NodeClient	getNodeClient()
UUID	registerStream(String filename, long filesize, String contentType, InputStream inputStream)
UUID	registerStream(String filename, String contentType, String url, long filesize)
UUID	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

OBJECT_MAPPER_LENIENT

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

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 Geometry2dApi geometry2d

geometry3d

public final Geometry3dApi geometry3d

render

public final RenderApi render

actions

public final ActionsApi actions

ai

public final AiApi ai

Method Details

close

public void close()
           throws InterruptedException,
BimWorksClientClosedException

Specified by:

close in interface AutoCloseable

Throws:

InterruptedException

BimWorksClientClosedException

getNodeClient

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

getApplicationVersion

public com.fasterxml.jackson.databind.node.ObjectNode getApplicationVersion()
                                                                     throws BimWorksException

Retrieve version from the BIM.works Repository

Returns:

Version of the application, formatted as standard Maven version string

Throws:

BimWorksException

getApi

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

Returns:

A NodeClient, this is a more low-level client that you generally do not need to use

executeAsyncTask

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

Low-level way of executing API calls, generally not needed as most API calls have a typed implementation.

Parameters:

request -

Returns:

Throws:

BimWorksException

createRequest

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

Throws:

BimWorksException

createAsyncTask

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

registerStream

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

Throws:

nl.sascom.backplane.StreamAlreadyRegisteredException

registerStream

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

Throws:

MalformedURLException

nl.sascom.backplane.StreamAlreadyRegisteredException

registerStream

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

Throws:

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

createRequest

public nl.sascom.backplane.common.Request createRequest(String project,
 String taskName)
                                                 throws BimWorksException

Throws:

BimWorksException