com.ibm.cos.v2.http.auth.spi.internal.signer

Class DefaultSignRequest<IdentityT extends Identity>

java.lang.Object

com.ibm.cos.v2.http.auth.spi.internal.signer.DefaultSignRequest<IdentityT>

All Implemented Interfaces:

BaseSignRequest<ContentStreamProvider,IdentityT>, SignRequest<IdentityT>, ToCopyableBuilder<SignRequest.Builder<IdentityT>,SignRequest<IdentityT>>

public final class DefaultSignRequest<IdentityT extends Identity>
extends Object
implements SignRequest<IdentityT>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultSignRequest.BuilderImpl<IdentityT extends Identity>

Nested classes/interfaces inherited from interface com.ibm.cos.v2.http.auth.spi.signer.SignRequest

SignRequest.Builder<IdentityT extends Identity>

Field Summary

Fields

Modifier and Type	Field and Description
protected IdentityT	identity
protected PayloadT	payload
protected Map<SignerProperty<?>,Object>	properties
protected SdkHttpRequest	request

Method Summary

Modifier and Type	Method and Description
static <IdentityT extends Identity> SignRequest.Builder<IdentityT>	builder()
static <IdentityT extends Identity> SignRequest.Builder<IdentityT>	builder(IdentityT identity) Get a new builder for creating a SignRequest.
IdentityT	identity() Returns the identity.
Optional<PayloadT>	payload() Returns the body payload of the request.
<T> T	property(SignerProperty<T> property) Returns the value of a property that the HttpSigner can use during signing.
SdkHttpRequest	request() Returns the HTTP request object, without the request body payload.
SignRequest.Builder<IdentityT>	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.http.auth.spi.signer.BaseSignRequest

hasProperty, identity, payload, property, request, requireProperty, requireProperty

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Field Detail

request

protected final SdkHttpRequest request

payload

protected final PayloadT payload

identity

protected final IdentityT extends Identity identity

properties

protected final Map<SignerProperty<?>,Object> properties

Method Detail

builder

public static <IdentityT extends Identity> SignRequest.Builder<IdentityT> builder()

builder

public static <IdentityT extends Identity> SignRequest.Builder<IdentityT> builder(IdentityT identity)

Description copied from interface: SignRequest

Get a new builder for creating a SignRequest.

Specified by:

builder in interface SignRequest<IdentityT extends Identity>

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public SignRequest.Builder<IdentityT> toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SignRequest.Builder<IdentityT extends Identity>,SignRequest<IdentityT extends Identity>>

Returns:

a builder for type T

request

public SdkHttpRequest request()

Description copied from interface: BaseSignRequest

Returns the HTTP request object, without the request body payload.

Specified by:

request in interface BaseSignRequest<PayloadT,IdentityT extends Identity>

payload

public Optional<PayloadT> payload()

Description copied from interface: BaseSignRequest

Returns the body payload of the request. A payload is optional. By default, the payload will be empty.

Specified by:

payload in interface BaseSignRequest<PayloadT,IdentityT extends Identity>

identity

public IdentityT identity()

Description copied from interface: BaseSignRequest

Returns the identity.

Specified by:

identity in interface BaseSignRequest<PayloadT,IdentityT extends Identity>

property

public <T> T property(SignerProperty<T> property)

Description copied from interface: BaseSignRequest

Returns the value of a property that the HttpSigner can use during signing.

Specified by:

property in interface BaseSignRequest<PayloadT,IdentityT extends Identity>