Package software.amazon.msk.auth.iam.internals

Class AuthenticationRequestParams

java.lang.Object

software.amazon.msk.auth.iam.internals.AuthenticationRequestParams

public class AuthenticationRequestParams
extends Object

This class represents the parameters that will be used to generate the Sigv4 signature as well as the final Authentication Payload sent to the kafka broker. The class is versioned so that it can be extended if necessary in the future.

Method Summary

Modifier and Type	Method	Description
static AuthenticationRequestParams	create(@NonNull String host, software.amazon.awssdk.auth.credentials.AwsCredentials credentials, @NonNull String userAgent)
static AuthenticationRequestParams	create(@NonNull String host, software.amazon.awssdk.auth.credentials.AwsCredentials credentials, @NonNull String userAgent, ConfigurableRegionProvider regionProvider)
@NonNull software.amazon.awssdk.auth.credentials.AwsCredentials	getAwsCredentials()
@NonNull String	getHost()
@NonNull software.amazon.awssdk.regions.Region	getRegion()
String	getServiceScope()
@NonNull String	getUserAgent()
@NonNull String	getVersion()

Methods inherited from class java.lang.Object

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

Method Details

getServiceScope

public String getServiceScope()

create

public static AuthenticationRequestParams create(@NonNull
 @NonNull String host,
 software.amazon.awssdk.auth.credentials.AwsCredentials credentials,
 @NonNull
 @NonNull String userAgent)
                                          throws IllegalArgumentException

Throws:

IllegalArgumentException

create

public static AuthenticationRequestParams create(@NonNull
 @NonNull String host,
 software.amazon.awssdk.auth.credentials.AwsCredentials credentials,
 @NonNull
 @NonNull String userAgent,
 ConfigurableRegionProvider regionProvider)
                                          throws IllegalArgumentException

Throws:

IllegalArgumentException

getVersion

@NonNull
public @NonNull String getVersion()

getHost

@NonNull
public @NonNull String getHost()

getAwsCredentials

@NonNull
public @NonNull software.amazon.awssdk.auth.credentials.AwsCredentials getAwsCredentials()

getRegion

@NonNull
public @NonNull software.amazon.awssdk.regions.Region getRegion()

getUserAgent

@NonNull
public @NonNull String getUserAgent()