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

public final class ChannelValidation

Channel auth validator.

Method Summary

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

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

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

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

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

Gets the OpenID metadata URL.
static TokenValidationParameters getTokenValidationParameters()

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

Sets the OpenID metadata URL.

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 channelId)

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

Parameters:

authHeader - The raw HTTP header in the format: "Bearer [longString]".
credentials - The user defined set of valid credentials, such as the AppId.
channelId - ChannelId for endorsements validation.

Returns:

A valid ClaimsIdentity. 
     On join:

authenticateToken

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

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

Parameters:

authHeader - The raw HTTP header in the format: "Bearer [longString]".
credentials - The user defined set of valid credentials, such as the AppId.
channelId - ChannelId for endorsements validation.
authConfig - The AuthenticationConfiguration.

Returns:

A valid ClaimsIdentity. 
     On join:

authenticateToken

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

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

Parameters:

authHeader - The raw HTTP header in the format: "Bearer [longString]"
credentials - The user defined set of valid credentials, such as the AppId.
channelId - ChannelId for endorsements validation.
serviceUrl - Service url.

Returns:

A valid ClaimsIdentity. 
     On join:

authenticateToken

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

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

Parameters:

authHeader - The raw HTTP header in the format: "Bearer [longString]"
credentials - The user defined set of valid credentials, such as the AppId.
channelId - ChannelId for endorsements validation.
serviceUrl - Service url.
authConfig - The authentication configuration.

Returns:

A valid ClaimsIdentity. 
     On join:

getOpenIdMetaDataUrl

public static String getOpenIdMetaDataUrl()

Gets the OpenID metadata URL.

Returns:

The url.

getTokenValidationParameters

public static TokenValidationParameters getTokenValidationParameters()

TO BOT FROM 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.

Applies to