com.microsoft.azure.kusto.data.auth

Class ConnectionStringBuilder

java.lang.Object

com.microsoft.azure.kusto.data.auth.ConnectionStringBuilder

public class ConnectionStringBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
ConnectionStringBuilder(ConnectionStringBuilder other)
ConnectionStringBuilder(String connectionString) Creates a ConnectionStringBuilder from a connection string.

Method Summary

Modifier and Type	Method and Description
static ConnectionStringBuilder	createWithAadAccessTokenAuthentication(String clusterUrl, String token)
static ConnectionStringBuilder	createWithAadApplicationCertificate(String clusterUrl, String applicationClientId, X509Certificate x509Certificate, PrivateKey privateKey)
static ConnectionStringBuilder	createWithAadApplicationCertificate(String clusterUrl, String applicationClientId, X509Certificate x509Certificate, PrivateKey privateKey, String authorityId)
static ConnectionStringBuilder	createWithAadApplicationCertificateSubjectNameIssuer(String clusterUrl, String applicationClientId, List<X509Certificate> x509CertificateChain, PrivateKey privateKey)
static ConnectionStringBuilder	createWithAadApplicationCertificateSubjectNameIssuer(String clusterUrl, String applicationClientId, List<X509Certificate> x509CertificateChain, PrivateKey privateKey, String authorityId)
static ConnectionStringBuilder	createWithAadApplicationCredentials(String clusterUrl, String applicationClientId, String applicationKey)
static ConnectionStringBuilder	createWithAadApplicationCredentials(String clusterUrl, String applicationClientId, String applicationKey, String authorityId)
static ConnectionStringBuilder	createWithAadManagedIdentity(String clusterUrl)
static ConnectionStringBuilder	createWithAadManagedIdentity(String clusterUrl, String managedIdentityClientId)
static ConnectionStringBuilder	createWithAadTokenProviderAuthentication(String clusterUrl, Callable<String> tokenProviderCallable)
static ConnectionStringBuilder	createWithAzureCli(String clusterUrl)
static ConnectionStringBuilder	createWithDeviceCode(String clusterUrl)
static ConnectionStringBuilder	createWithDeviceCode(String clusterUrl, String authorityId)
static ConnectionStringBuilder	createWithUserPrompt(String clusterUrl)
static ConnectionStringBuilder	createWithUserPrompt(String clusterUrl, String usernameHint)
static ConnectionStringBuilder	createWithUserPrompt(String clusterUrl, String authorityId, String usernameHint)
String	getApplicationNameForTracing() Gets the application name for tracing purposes.
String	getClientVersionForTracing() Gets the client version for tracing.
String	getClusterUrl()
String	getManagedIdentityClientId()
Callable<String>	getTokenProvider()
String	getUserNameForTracing() Gets the username for tracing.
void	setApplicationNameForTracing(String applicationNameForTracing) Sets the application name for tracing purposes.
void	setClientVersionForTracing(String clientVersionForTracing) Deprecated. This field will be reserved to only the version of the Kusto Java SDK in the future. Use setApplicationNameForTracing(String) instead. Sets the client version for tracing. This appends the given version to the Kusto Java SDK version.
void	setClusterUrl(String clusterUrl)
void	setConnectorDetails(String name, String version, String appName, String appVersion, boolean sendUser, String overrideUser, org.apache.commons.lang3.tuple.Pair<String,String>... additionalFields) Sets the application name and username for Kusto connectors.
void	setUserNameForTracing(String userNameForTracing) Sets the username for tracing.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionStringBuilder

public ConnectionStringBuilder(ConnectionStringBuilder other)

ConnectionStringBuilder

public ConnectionStringBuilder(String connectionString)

Creates a ConnectionStringBuilder from a connection string. For more information please look at: https://docs.microsoft.com/azure/data-explorer/kusto/api/connection-strings/kusto

Parameters:

connectionString - The connection string should be of the format: https://clusterName.location.kusto.windows.net;AAD User ID="user@microsoft.com";Password=P@ssWord

Throws:

IllegalArgumentException - If the connection string is invalid.

Method Detail

getClusterUrl

public String getClusterUrl()

setClusterUrl

public void setClusterUrl(String clusterUrl)

getTokenProvider

public Callable<String> getTokenProvider()

getManagedIdentityClientId

public String getManagedIdentityClientId()

getUserNameForTracing

public String getUserNameForTracing()

Gets the username for tracing. By default, it is the username of the current process as returned by the system property "user.name".

Returns:

The username for tracing.

setUserNameForTracing

public void setUserNameForTracing(String userNameForTracing)

Sets the username for tracing.

Parameters:

userNameForTracing - The username for tracing.

getClientVersionForTracing

public String getClientVersionForTracing()

Gets the client version for tracing. By default it is the version of the Kusto Java SDK.

Returns:

The client version for tracing.

setClientVersionForTracing

public void setClientVersionForTracing(String clientVersionForTracing)

Deprecated. This field will be reserved to only the version of the Kusto Java SDK in the future. Use setApplicationNameForTracing(String) instead. Sets the client version for tracing. This appends the given version to the Kusto Java SDK version.

Parameters:

clientVersionForTracing - The client version for tracing.

getApplicationNameForTracing

public String getApplicationNameForTracing()

Gets the application name for tracing purposes. By default, it is the name of the current process as returned by the system property "sun.java.command".

Returns:

The application name for tracing purposes.

setApplicationNameForTracing

public void setApplicationNameForTracing(String applicationNameForTracing)

Sets the application name for tracing purposes.

Parameters:

applicationNameForTracing - The application name for tracing purposes.

createWithAadApplicationCredentials

public static ConnectionStringBuilder createWithAadApplicationCredentials(String clusterUrl,
                                                                          String applicationClientId,
                                                                          String applicationKey)

createWithAadApplicationCredentials

public static ConnectionStringBuilder createWithAadApplicationCredentials(String clusterUrl,
                                                                          String applicationClientId,
                                                                          String applicationKey,
                                                                          String authorityId)

createWithUserPrompt

public static ConnectionStringBuilder createWithUserPrompt(String clusterUrl)

createWithUserPrompt

public static ConnectionStringBuilder createWithUserPrompt(String clusterUrl,
                                                           String usernameHint)

createWithUserPrompt

public static ConnectionStringBuilder createWithUserPrompt(String clusterUrl,
                                                           String authorityId,
                                                           String usernameHint)

createWithDeviceCode

public static ConnectionStringBuilder createWithDeviceCode(String clusterUrl)

createWithDeviceCode

public static ConnectionStringBuilder createWithDeviceCode(String clusterUrl,
                                                           String authorityId)

createWithAadApplicationCertificate

public static ConnectionStringBuilder createWithAadApplicationCertificate(String clusterUrl,
                                                                          String applicationClientId,
                                                                          X509Certificate x509Certificate,
                                                                          PrivateKey privateKey)

createWithAadApplicationCertificate

public static ConnectionStringBuilder createWithAadApplicationCertificate(String clusterUrl,
                                                                          String applicationClientId,
                                                                          X509Certificate x509Certificate,
                                                                          PrivateKey privateKey,
                                                                          String authorityId)

createWithAadApplicationCertificateSubjectNameIssuer

public static ConnectionStringBuilder createWithAadApplicationCertificateSubjectNameIssuer(String clusterUrl,
                                                                                           String applicationClientId,
                                                                                           List<X509Certificate> x509CertificateChain,
                                                                                           PrivateKey privateKey)

createWithAadApplicationCertificateSubjectNameIssuer

public static ConnectionStringBuilder createWithAadApplicationCertificateSubjectNameIssuer(String clusterUrl,
                                                                                           String applicationClientId,
                                                                                           List<X509Certificate> x509CertificateChain,
                                                                                           PrivateKey privateKey,
                                                                                           String authorityId)

createWithAadAccessTokenAuthentication

public static ConnectionStringBuilder createWithAadAccessTokenAuthentication(String clusterUrl,
                                                                             String token)

createWithAadTokenProviderAuthentication

public static ConnectionStringBuilder createWithAadTokenProviderAuthentication(String clusterUrl,
                                                                               Callable<String> tokenProviderCallable)

createWithAadManagedIdentity

public static ConnectionStringBuilder createWithAadManagedIdentity(String clusterUrl)

createWithAadManagedIdentity

public static ConnectionStringBuilder createWithAadManagedIdentity(String clusterUrl,
                                                                   String managedIdentityClientId)

createWithAzureCli

public static ConnectionStringBuilder createWithAzureCli(String clusterUrl)

setConnectorDetails

public void setConnectorDetails(String name,
                                String version,
                                @Nullable
                                String appName,
                                @Nullable
                                String appVersion,
                                boolean sendUser,
                                @Nullable
                                String overrideUser,
                                org.apache.commons.lang3.tuple.Pair<String,String>... additionalFields)

Sets the application name and username for Kusto connectors.

Parameters:

name - The name of the connector/application.

version - The version of the connector/application.

appName - The app hosting the connector, or null to use the current process name.

appVersion - The version of the app hosting the connector, or null to use "[none]".

sendUser - True if the user should be sent to Kusto, otherwise "[none]" will be sent.

overrideUser - The user to send to Kusto, or null zvto use the current user.

additionalFields - Additional fields to trace. Example: "Kusto.MyConnector:{1.0.0}|App.{connector}:{0.5.3}|Kusto.MyField:{MyValue}"