CertificateAppCredentialsOptions Class

Package:
com.microsoft.bot.connector.authentication
Maven Artifact:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.connector.authentication.CertificateAppCredentialsOptions

public class CertificateAppCredentialsOptions

CertificateAppCredentials Options.

Constructor Summary

Constructor Description
CertificateAppCredentialsOptions(String withAppId, InputStream withPkcs12Certificate, String withPkcs12Password)

Initializes the CertificateAppCredentialsOptions with the required arguments.
CertificateAppCredentialsOptions(String withAppId, InputStream withPkcs12Certificate, String withPkcs12Password, String withChannelAuthTenant, String withOAuthScope, boolean withSendX5c)

Initializes the CertificateAppCredentialsOptions.

Method Summary

Modifier and Type Method and Description
java.lang.String getAppId()

Gets the Microsfot AppId.
java.lang.String getChannelAuthTenant()

Gets the Channel Auth Tenant.
java.io.InputStream getPkcs12Certificate()

Gets the InputStream to the PKCS12 certificate.
java.lang.String getPkcs12Password()

Gets the pkcs12 certiciate password.
boolean getSendX5c()

Gets if the x5c claim (public key of the certificate) should be sent to the STS.
java.lang.String getoAuthScope()

Gets the OAuth scope.
void setAppId(String withAppId)

Sets the Microsfot AppId.
void setChannelAuthTenant(String withChannelAuthTenant)

Sets the Channel Auth Tenant.
void setPkcs12Certificate(InputStream withPkcs12Certificate)

Sets the InputStream to the PKCS12 certificate.
void setPkcs12Password(String withPkcs12Password)

Sets the pkcs12 certiciate password.
void setSendX5c(boolean withSendX5c)

Sets if the x5c claim (public key of the certificate) should be sent to the STS.
void setoAuthScope(String withOAuthScope)

Sets the OAuth scope.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

CertificateAppCredentialsOptions

public CertificateAppCredentialsOptions(String withAppId, InputStream withPkcs12Certificate, String withPkcs12Password)

Initializes the CertificateAppCredentialsOptions with the required arguments.

Parameters:

withAppId - The Microsoft app ID.
withPkcs12Certificate - The InputStream to the pkcs certificate.
withPkcs12Password - The pkcs certificate password.

CertificateAppCredentialsOptions

public CertificateAppCredentialsOptions(String withAppId, InputStream withPkcs12Certificate, String withPkcs12Password, String withChannelAuthTenant, String withOAuthScope, boolean withSendX5c)

Initializes the CertificateAppCredentialsOptions.

Parameters:

withAppId - The Microsoft app ID.
withPkcs12Certificate - The InputStream to the pkcs certificate.
withPkcs12Password - The pkcs certificate password.
withChannelAuthTenant - Optional. The oauth token tenant.
withOAuthScope - Optional. The scope for the token.
withSendX5c - Specifies if the x5c claim (public key of the certificate) should be sent to the STS.

Method Details

getAppId

public String getAppId()

Gets the Microsfot AppId.

Returns:

The app id.

getChannelAuthTenant

public String getChannelAuthTenant()

Gets the Channel Auth Tenant.

Returns:

The OAuth Channel Auth Tenant.

getPkcs12Certificate

public InputStream getPkcs12Certificate()

Gets the InputStream to the PKCS12 certificate.

Returns:

The InputStream to the certificate.

getPkcs12Password

public String getPkcs12Password()

Gets the pkcs12 certiciate password.

Returns:

The password for the certificate.

getSendX5c

public boolean getSendX5c()

Gets if the x5c claim (public key of the certificate) should be sent to the STS.

Returns:

true to send x5c.

getoAuthScope

public String getoAuthScope()

Gets the OAuth scope.

Returns:

The OAuthScope.

setAppId

public void setAppId(String withAppId)

Sets the Microsfot AppId.

Parameters:

withAppId - The app id.

setChannelAuthTenant

public void setChannelAuthTenant(String withChannelAuthTenant)

Sets the Channel Auth Tenant.

Parameters:

withChannelAuthTenant - The OAuth Channel Auth Tenant.

setPkcs12Certificate

public void setPkcs12Certificate(InputStream withPkcs12Certificate)

Sets the InputStream to the PKCS12 certificate.

Parameters:

withPkcs12Certificate - The InputStream to the certificate.

setPkcs12Password

public void setPkcs12Password(String withPkcs12Password)

Sets the pkcs12 certiciate password.

Parameters:

withPkcs12Password - The password for the certificate.

setSendX5c

public void setSendX5c(boolean withSendX5c)

Sets if the x5c claim (public key of the certificate) should be sent to the STS.

Parameters:

withSendX5c - true to send x5c.

setoAuthScope

public void setoAuthScope(String withOAuthScope)

Sets the OAuth scope.

Parameters:

withOAuthScope - The OAuthScope.

Applies to