GovernmentChannelValidation 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.GovernmentChannelValidation

public final class GovernmentChannelValidation

Government Channel auth validation.

Method Summary

Modifier and Type Method and Description
static java.util.concurrent.CompletableFuture<ClaimsIdentity> authenticateToken(String authHeader, CredentialProvider credentials, String serviceUrl, String channelId)

Validate the incoming Auth Header as a token sent from a Bot Framework Government Channel Service.
static java.util.concurrent.CompletableFuture<ClaimsIdentity> authenticateToken(String authHeader, CredentialProvider credentials, String serviceUrl, String channelId, AuthenticationConfiguration authConfig)

Validate the incoming Auth Header as a token sent from a Bot Framework Government Channel Service.
static java.lang.String getOpenIdMetaDataUrl()

Gets the OpenID metadata URL.
static TokenValidationParameters getTokenValidationParameters()

TO BOT FROM GOVERNMENT CHANNEL.
static void setOpenIdMetaDataUrl(String withOpenIdMetaDataUrl)

Sets the OpenID metadata URL.
static java.util.concurrent.CompletableFuture<ClaimsIdentity> validateIdentity(ClaimsIdentity identity, CredentialProvider credentials, String serviceUrl)

Validate the ClaimsIdentity as sent from a Bot Framework Government Channel Service.

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

Method Details

authenticateToken

public static CompletableFuture authenticateToken(String authHeader, CredentialProvider credentials, String serviceUrl, String channelId)

Validate the incoming Auth Header as a token sent from a Bot Framework Government Channel Service.

Parameters:

authHeader - The raw HTTP header in the format: "Bearer [longString]".
credentials - The user defined set of valid credentials, such as the AppId.
serviceUrl - The service url from the request.
channelId - The ID of the channel to validate.

Returns:

A CompletableFuture representing the asynchronous operation. 
     On join:

authenticateToken

public static CompletableFuture authenticateToken(String authHeader, CredentialProvider credentials, String serviceUrl, String channelId, AuthenticationConfiguration authConfig)

Validate the incoming Auth Header as a token sent from a Bot Framework Government Channel Service.

Parameters:

authHeader - The raw HTTP header in the format: "Bearer [longString]".
credentials - The user defined set of valid credentials, such as the AppId.
serviceUrl - The service url from the request.
channelId - The ID of the channel to validate.
authConfig - The authentication configuration.

Returns:

A CompletableFuture representing the asynchronous operation. 
     On join:

getOpenIdMetaDataUrl

public static String getOpenIdMetaDataUrl()

Gets the OpenID metadata URL.

Returns:

The url.

getTokenValidationParameters

public static TokenValidationParameters getTokenValidationParameters()

TO BOT FROM GOVERNMENT CHANNEL.

Returns:

Token validation parameters when connecting to a bot.

setOpenIdMetaDataUrl

public static void setOpenIdMetaDataUrl(String withOpenIdMetaDataUrl)

Sets the OpenID metadata URL.

Parameters:

withOpenIdMetaDataUrl - The metadata url.

validateIdentity

public static CompletableFuture validateIdentity(ClaimsIdentity identity, CredentialProvider credentials, String serviceUrl)

Validate the ClaimsIdentity as sent from a Bot Framework Government Channel Service.

Parameters:

identity - The claims identity to validate.
credentials - The user defined set of valid credentials, such as the AppId.
serviceUrl - The service url from the request.

Returns:

A CompletableFuture representing the asynchronous operation. 
     On join:

Applies to