Package nl.bimbase.bimworks.client.apis

Class TokensApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.TokensApi

public class TokensApi
extends SubApi

This API provides token related calls. Most calls allow you to create Auth Tokens, which can then be used to for delegation of authentication and authorization. Auth Token are generally used from differents (parts of) applications. The Java SDK allows you to create new BimWorksClient with Auth Tokens using BimWorksClientFactory.createClientWithAuth(ObjectNode)

Constructor Summary

Constructors

Constructor	Description
TokensApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	createNodesToken(Set<UUID> nodeUuids, Duration duration, Set<String> allowedTasks, Set<String> allowedIpAdresses)
com.fasterxml.jackson.databind.node.ObjectNode	createRecursiveNodeToken(UUID nodeUuid, Duration duration, Set<String> allowedTasks, Set<String> allowedIpAdresses)
com.fasterxml.jackson.databind.node.ObjectNode	createVersionsToken(Set<UUID> versionUuids, Duration duration, Set<String> allowedTasks, Set<String> allowedIpAdresses)	Create a new "VersionsToken".

Methods inherited from class nl.bimbase.bimworks.client.apis.SubApi

getBimWorksClient

Methods inherited from class java.lang.Object

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

Constructor Details

TokensApi

public TokensApi(BimWorksClient bimWorksClient)

Method Details

createVersionsToken

public com.fasterxml.jackson.databind.node.ObjectNode createVersionsToken(Set<UUID> versionUuids,
 Duration duration,
 Set<String> allowedTasks,
 Set<String> allowedIpAdresses)
                                                                   throws BimWorksException

Create a new "VersionsToken".

Parameters:

versionUuids - A Set of UUID representing the Versions you want to give access to

duration - How long this token should be valid

allowedTasks - The allowed set of API calls. When empty there is no restriction on the allowed API calls. It is important to note that including API calls in this list merely allows them to be called, the calls themselves will still check the relevant authorization.

allowedIpAdresses - IP addresses that are allowed to use the token. When empty there is no restriction on IP addresses

Returns:

Throws:

BimWorksException

createNodesToken

public com.fasterxml.jackson.databind.node.ObjectNode createNodesToken(Set<UUID> nodeUuids,
 Duration duration,
 Set<String> allowedTasks,
 Set<String> allowedIpAdresses)
                                                                throws BimWorksException

Throws:

BimWorksException

createRecursiveNodeToken

public com.fasterxml.jackson.databind.node.ObjectNode createRecursiveNodeToken(UUID nodeUuid,
 Duration duration,
 Set<String> allowedTasks,
 Set<String> allowedIpAdresses)
                                                                        throws BimWorksException

Throws:

BimWorksException