Package com.commercetools.api.models.extension

Interface AuthorizationHeaderAuthentication

All Superinterfaces:

HttpDestinationAuthentication

All Known Subinterfaces:

ExtensionAuthorizationHeaderAuthentication

public interface AuthorizationHeaderAuthentication
extends HttpDestinationAuthentication

The Authorization header will be set to the content of headerValue. The authentication scheme (such as Basic or Bearer) should be included in the headerValue.

For example, the headerValue for Basic Authentication should be set to Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==.

Example to create an instance using the builder pattern

     AuthorizationHeaderAuthentication authorizationHeaderAuthentication = AuthorizationHeaderAuthentication.builder()
             .headerValue("{headerValue}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHORIZATION_HEADER	discriminator value for AuthorizationHeaderAuthentication

Method Summary

Modifier and Type	Method	Description
static AuthorizationHeaderAuthenticationBuilder	builder()	builder factory method for AuthorizationHeaderAuthentication
static AuthorizationHeaderAuthenticationBuilder	builder(AuthorizationHeaderAuthentication template)	create builder for AuthorizationHeaderAuthentication instance
AuthorizationHeaderAuthentication	copyDeep()
static AuthorizationHeaderAuthentication	deepCopy(AuthorizationHeaderAuthentication template)	factory method to create a deep copy of AuthorizationHeaderAuthentication
@NotNull String	getHeaderValue()	Partially hidden on retrieval for security reasons.
static AuthorizationHeaderAuthentication	of()	factory method
static AuthorizationHeaderAuthentication	of(AuthorizationHeaderAuthentication template)	factory method to create a shallow copy AuthorizationHeaderAuthentication
void	setHeaderValue(String headerValue)	Partially hidden on retrieval for security reasons.
static com.fasterxml.jackson.core.type.TypeReference<AuthorizationHeaderAuthentication>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAuthorizationHeaderAuthentication(Function<AuthorizationHeaderAuthentication,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.extension.HttpDestinationAuthentication

getType, withHttpDestinationAuthentication

Field Details

AUTHORIZATION_HEADER

static final String AUTHORIZATION_HEADER

discriminator value for AuthorizationHeaderAuthentication

See Also:

• Constant Field Values

Method Details

getHeaderValue

@NotNull
@NotNull String getHeaderValue()

Partially hidden on retrieval for security reasons.

Returns:

headerValue

setHeaderValue

void setHeaderValue(String headerValue)

Partially hidden on retrieval for security reasons.

Parameters:

headerValue - value to be set

of

static AuthorizationHeaderAuthentication of()

factory method

Returns:

instance of AuthorizationHeaderAuthentication

of

static AuthorizationHeaderAuthentication of(AuthorizationHeaderAuthentication template)

factory method to create a shallow copy AuthorizationHeaderAuthentication

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

AuthorizationHeaderAuthentication copyDeep()

Specified by:

copyDeep in interface HttpDestinationAuthentication

deepCopy

@Nullable
static AuthorizationHeaderAuthentication deepCopy(@Nullable
 AuthorizationHeaderAuthentication template)

factory method to create a deep copy of AuthorizationHeaderAuthentication

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AuthorizationHeaderAuthenticationBuilder builder()

builder factory method for AuthorizationHeaderAuthentication

Returns:

builder

builder

static AuthorizationHeaderAuthenticationBuilder builder(AuthorizationHeaderAuthentication template)

create builder for AuthorizationHeaderAuthentication instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAuthorizationHeaderAuthentication

default <T> T withAuthorizationHeaderAuthentication(Function<AuthorizationHeaderAuthentication,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<AuthorizationHeaderAuthentication> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference