Class AuthApi

java.lang.Object

nl.bimbase.bimworks.client.apis.SubApi

nl.bimbase.bimworks.client.apis.AuthApi

public class AuthApi
extends SubApi

Authentication related API calls.

Constructor Summary

Constructors

Constructor	Description
AuthApi(BimWorksClient bimWorksClient)

Method Summary

Modifier and Type	Method	Description
void	loginAnonymous()	Login anonymously
void	loginWithApiToken(String apiToken)	Login with an API Token.
com.fasterxml.jackson.databind.node.ObjectNode	loginWithUsernamePassword(String username, String password)	Login with a username/password.
void	register(String username)	Register a new user

Methods inherited from class SubApi

getBimWorksClient

Methods inherited from class Object

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

Constructor Details

AuthApi

public AuthApi(BimWorksClient bimWorksClient)

Method Details

loginWithUsernamePassword

public com.fasterxml.jackson.databind.node.ObjectNode loginWithUsernamePassword(String username,
 String password)
                                                                         throws BimWorksException

Login with a username/password. Only use this for testing purposes, in most cases using an API Token is safer.

Parameters:

username -

password -

Returns:

Throws:

BimWorksException

loginWithApiToken

public void loginWithApiToken(String apiToken)
                       throws BimWorksException

Login with an API Token. Generally you should not call this method manually, it is called already when creating a new BimWorksClient using BimWorksClientFactory.createClientWithApiToken(String)

Parameters:

apiToken - The API Token

Throws:

BimWorksException

loginAnonymous

public void loginAnonymous()
                    throws BimWorksException

Login anonymously

Throws:

BimWorksException

register

public void register(String username)
              throws BimWorksException

Register a new user

Parameters:

username - The requested username, should always be in the form of a valid email address

Throws:

BimWorksException