io.cloudsoft.winrm4j.client

Class WinRmClient.Builder

java.lang.Object

io.cloudsoft.winrm4j.client.WinRmClient.Builder

Enclosing class:

WinRmClient

public static class WinRmClient.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static Long	DEFAULT_OPERATION_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
WinRmClient.Builder(String endpoint, String authenticationScheme)
WinRmClient.Builder(URL endpoint, String authenticationScheme)

Method Summary

Methods

Modifier and Type	Method and Description
WinRmClient	build() Create a WinRmClient
WinRmClient.Builder	context(WinRmClientContext context)
WinRmClient.Builder	credentials(String username, String password)
WinRmClient.Builder	credentials(String domain, String username, String password) Credentials to use for authentication
WinRmClient.Builder	disableCertificateChecks(boolean disableCertificateChecks)
WinRmClient.Builder	environment(Map<String,String> environment)
WinRmClient.Builder	hostnameVerifier(HostnameVerifier hostnameVerifier)
WinRmClient.Builder	locale(Locale locale)
WinRmClient.Builder	operationTimeout(long operationTimeout) If operations cannot be completed in a specified time, the service returns a fault so that a client can comply with its obligations.
WinRmClient.Builder	retriesForConnectionFailures(Integer retriesConnectionFailures)
WinRmClient.Builder	workingDirectory(String workingDirectory)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OPERATION_TIMEOUT

public static final Long DEFAULT_OPERATION_TIMEOUT

Constructor Detail

WinRmClient.Builder

public WinRmClient.Builder(URL endpoint,
                   String authenticationScheme)

WinRmClient.Builder

public WinRmClient.Builder(String endpoint,
                   String authenticationScheme)

Method Detail

credentials

public WinRmClient.Builder credentials(String username,
                              String password)

credentials

public WinRmClient.Builder credentials(String domain,
                              String username,
                              String password)

Credentials to use for authentication

locale

public WinRmClient.Builder locale(Locale locale)

Parameters:

locale - The locale to run the process in

operationTimeout

public WinRmClient.Builder operationTimeout(long operationTimeout)

If operations cannot be completed in a specified time, the service returns a fault so that a client can comply with its obligations. http://www.dmtf.org/sites/default/files/standards/documents/DSP0226_1.2.0.pdf

Parameters:

operationTimeout - in milliseconds default value DEFAULT_OPERATION_TIMEOUT

retriesForConnectionFailures

public WinRmClient.Builder retriesForConnectionFailures(Integer retriesConnectionFailures)

Parameters:

retriesConnectionFailures - How many times to retry the command before giving up in case of failure (exception). Default is 16.

disableCertificateChecks

public WinRmClient.Builder disableCertificateChecks(boolean disableCertificateChecks)

Parameters:

disableCertificateChecks - Skip trusted certificate and domain (CN) checks. Used when working with self-signed certificates. Use hostnameVerifier(HostnameVerifier) for a more precise white-listing of server certificates.

workingDirectory

public WinRmClient.Builder workingDirectory(String workingDirectory)

Parameters:

workingDirectory - the working directory of the process

environment

public WinRmClient.Builder environment(Map<String,String> environment)

Parameters:

environment - variables to pass to the command

hostnameVerifier

public WinRmClient.Builder hostnameVerifier(HostnameVerifier hostnameVerifier)

Parameters:

hostnameVerifier - override the default HostnameVerifier allowing users to add custom validation logic. Used when the default rules for URL hostname verification fail. Use disableCertificateChecks(boolean) to disable certificate checks for all host names.

context

public WinRmClient.Builder context(WinRmClientContext context)

Parameters:

context - is a shared WinRmClientContext object which allows connection reuse across WinRmClient invocations. If not set one will be created for each WinRmClient instance.

build

public WinRmClient build()

Create a WinRmClient