com.hcl.domino

Class DominoClientBuilder

java.lang.Object

com.hcl.domino.DominoClientBuilder

public abstract class DominoClientBuilder
extends Object

Builder for creating and configuring a DominoClient

Since:

0.5.0

Author:

Karsten Lehmann, Paul Withers

Constructor Summary

Constructors

Constructor and Description
DominoClientBuilder()

Method Summary

Modifier and Type	Method and Description
DominoClientBuilder	asIDUser() Accesses NSFs as the owner of the active user ID file
DominoClientBuilder	asUser(List<String> userNamesList) Accesses NSFs as a specific user
DominoClientBuilder	asUser(String userName) Accesses NSFs as a specific user
DominoClientBuilder	authenticateUser(String serverName, String userName, String password) Accesses NSFs as a specific user, validating the password when the client is constructed.
DominoClientBuilder	authenticateUserWithToken(String serverName, Object token) Accesses NSFs as a specific user, validating the provided credentials token with any registered providers.
abstract DominoClient	build() Builds a DominoClient
protected String	getCredPassword()
protected String	getCredServer()
protected Object	getCredToken()
protected String	getCredUser()
protected Path	getIDFilePath()
protected String	getIDPassword()
protected String	getUserName()
protected List<String>	getUserNamesList()
protected boolean	isAsIDUser()
protected boolean	isFullAccess()
protected boolean	isMaxInternetAccess()
static DominoClientBuilder	newDominoClient() Constructor for generating a DominoClient
DominoClientBuilder	withFullAccess() Accesses the NSFs and server with full access
DominoClientBuilder	withMaxInternetAccess() Applies maximum internet access settings from the NSF to the requests

Methods inherited from class java.lang.Object

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

Constructor Detail

DominoClientBuilder

public DominoClientBuilder()

Method Detail

newDominoClient

public static DominoClientBuilder newDominoClient()

Constructor for generating a DominoClient

Returns:

new DominoClientBuilder

Throws:

IllegalStateException - if there is no implementation of DominoClientBuilder available

asIDUser

public DominoClientBuilder asIDUser()

Accesses NSFs as the owner of the active user ID file

Returns:

DominoClientBuilder this builder

asUser

public DominoClientBuilder asUser(String userName)

Accesses NSFs as a specific user

Parameters:

userName - Domino username to access as

Returns:

DominoClientBuilder this builder

asUser

public DominoClientBuilder asUser(List<String> userNamesList)

Accesses NSFs as a specific user

Parameters:

userNamesList - Domino username to access as

Returns:

DominoClientBuilder this builder

authenticateUser

public DominoClientBuilder authenticateUser(String serverName,
                                            String userName,
                                            String password)

Accesses NSFs as a specific user, validating the password when the client is constructed.

This is distinct from the password assigned to a Notes ID file, but instead refers to credentials according to an active local runtime or remote server.

Parameters:

serverName - remote Domino server to authenticate against. May be null to use the local runtime

userName - Domino username to access as

password - the user's password

Returns:

this builder

Throws:

IllegalArgumentException - if userName is null or empty

authenticateUserWithToken

public DominoClientBuilder authenticateUserWithToken(String serverName,
                                                     Object token)

Accesses NSFs as a specific user, validating the provided credentials token with any registered providers.

This is distinct from the password assigned to a Notes ID file, but instead refers to credentials according to an active local runtime or remote server.

Parameters:

serverName - the name of the server to contact

token - the token to use to authenticate. The class of the token depends on the available provider implementations

Returns:

this builder

Throws:

NullPointerException - if token is null

Since:

1.0.19

withFullAccess

public DominoClientBuilder withFullAccess()

Accesses the NSFs and server with full access

Returns:

DominoClientBuilder this builder

withMaxInternetAccess

public DominoClientBuilder withMaxInternetAccess()

Applies maximum internet access settings from the NSF to the requests

Returns:

DominoClientBuilder this builder

build

public abstract DominoClient build()

Builds a DominoClient

Returns:

DominoClient for settings requested

isFullAccess

protected boolean isFullAccess()

getIDFilePath

protected Path getIDFilePath()

getIDPassword

protected String getIDPassword()

isMaxInternetAccess

protected boolean isMaxInternetAccess()

isAsIDUser

protected boolean isAsIDUser()

getUserName

protected String getUserName()

getUserNamesList

protected List<String> getUserNamesList()

getCredServer

protected String getCredServer()

getCredUser

protected String getCredUser()

getCredPassword

protected String getCredPassword()

getCredToken

protected Object getCredToken()