software.amazon.msk.auth.iam.internals

Class AuthenticationRequestParams

java.lang.Object

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

public class AuthenticationRequestParams
extends java.lang.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 and Description
static AuthenticationRequestParams	create(@NonNull java.lang.String host, com.amazonaws.auth.AWSCredentials credentials, @NonNull java.lang.String userAgent)
@NonNull com.amazonaws.auth.AWSCredentials	getAwsCredentials()
@NonNull java.lang.String	getHost()
@NonNull com.amazonaws.regions.Region	getRegion()
java.lang.String	getServiceScope()
@NonNull java.lang.String	getUserAgent()
@NonNull java.lang.String	getVersion()

Methods inherited from class java.lang.Object

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

Method Detail

getServiceScope

public java.lang.String getServiceScope()

create

public static AuthenticationRequestParams create(@NonNull
                                                 @NonNull java.lang.String host,
                                                 com.amazonaws.auth.AWSCredentials credentials,
                                                 @NonNull
                                                 @NonNull java.lang.String userAgent)
                                          throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

getVersion

@NonNull
public @NonNull java.lang.String getVersion()

getHost

@NonNull
public @NonNull java.lang.String getHost()

getAwsCredentials

@NonNull
public @NonNull com.amazonaws.auth.AWSCredentials getAwsCredentials()

getRegion

@NonNull
public @NonNull com.amazonaws.regions.Region getRegion()

getUserAgent

@NonNull
public @NonNull java.lang.String getUserAgent()