software.amazon.awssdk.services.kms.model.VerifyMacRequest Maven / Gradle / Ivy
Show all versions of kms Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.kms.model;
import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class VerifyMacRequest extends KmsRequest implements ToCopyableBuilder {
private static final SdkField MESSAGE_FIELD = SdkField. builder(MarshallingType.SDK_BYTES)
.memberName("Message").getter(getter(VerifyMacRequest::message)).setter(setter(Builder::message))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Message").build()).build();
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(VerifyMacRequest::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final SdkField MAC_ALGORITHM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MacAlgorithm").getter(getter(VerifyMacRequest::macAlgorithmAsString))
.setter(setter(Builder::macAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MacAlgorithm").build()).build();
private static final SdkField MAC_FIELD = SdkField. builder(MarshallingType.SDK_BYTES).memberName("Mac")
.getter(getter(VerifyMacRequest::mac)).setter(setter(Builder::mac))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Mac").build()).build();
private static final SdkField> GRANT_TOKENS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("GrantTokens")
.getter(getter(VerifyMacRequest::grantTokens))
.setter(setter(Builder::grantTokens))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GrantTokens").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField DRY_RUN_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DryRun").getter(getter(VerifyMacRequest::dryRun)).setter(setter(Builder::dryRun))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DryRun").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MESSAGE_FIELD, KEY_ID_FIELD,
MAC_ALGORITHM_FIELD, MAC_FIELD, GRANT_TOKENS_FIELD, DRY_RUN_FIELD));
private final SdkBytes message;
private final String keyId;
private final String macAlgorithm;
private final SdkBytes mac;
private final List grantTokens;
private final Boolean dryRun;
private VerifyMacRequest(BuilderImpl builder) {
super(builder);
this.message = builder.message;
this.keyId = builder.keyId;
this.macAlgorithm = builder.macAlgorithm;
this.mac = builder.mac;
this.grantTokens = builder.grantTokens;
this.dryRun = builder.dryRun;
}
/**
*
* The message that will be used in the verification. Enter the same message that was used to generate the HMAC.
*
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
*
*
* @return The message that will be used in the verification. Enter the same message that was used to generate the
* HMAC.
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
*/
public final SdkBytes message() {
return message;
}
/**
*
* The KMS key that will be used in the verification.
*
*
* Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the
* VerifyMac operation fails.
*
*
* @return The KMS key that will be used in the verification.
*
* Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key,
* the VerifyMac operation fails.
*/
public final String keyId() {
return keyId;
}
/**
*
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute
* the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #macAlgorithm} will
* return {@link MacAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #macAlgorithmAsString}.
*
*
* @return The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to
* compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the
* KeyId parameter.
* @see MacAlgorithmSpec
*/
public final MacAlgorithmSpec macAlgorithm() {
return MacAlgorithmSpec.fromValue(macAlgorithm);
}
/**
*
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to compute
* the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId parameter.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #macAlgorithm} will
* return {@link MacAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #macAlgorithmAsString}.
*
*
* @return The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to
* compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the
* KeyId parameter.
* @see MacAlgorithmSpec
*/
public final String macAlgorithmAsString() {
return macAlgorithm;
}
/**
*
* The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified the
* same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
*
*
* @return The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you
* specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
*/
public final SdkBytes mac() {
return mac;
}
/**
* For responses, this returns true if the service returned a value for the GrantTokens property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasGrantTokens() {
return grantTokens != null && !(grantTokens instanceof SdkAutoConstructList);
}
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved
* eventual consistency. For more information, see Grant token and Using a grant
* token in the Key Management Service Developer Guide.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasGrantTokens} method.
*
*
* @return A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and
* Using
* a grant token in the Key Management Service Developer Guide.
*/
public final List grantTokens() {
return grantTokens;
}
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @return Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*/
public final Boolean dryRun() {
return dryRun;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(message());
hashCode = 31 * hashCode + Objects.hashCode(keyId());
hashCode = 31 * hashCode + Objects.hashCode(macAlgorithmAsString());
hashCode = 31 * hashCode + Objects.hashCode(mac());
hashCode = 31 * hashCode + Objects.hashCode(hasGrantTokens() ? grantTokens() : null);
hashCode = 31 * hashCode + Objects.hashCode(dryRun());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof VerifyMacRequest)) {
return false;
}
VerifyMacRequest other = (VerifyMacRequest) obj;
return Objects.equals(message(), other.message()) && Objects.equals(keyId(), other.keyId())
&& Objects.equals(macAlgorithmAsString(), other.macAlgorithmAsString()) && Objects.equals(mac(), other.mac())
&& hasGrantTokens() == other.hasGrantTokens() && Objects.equals(grantTokens(), other.grantTokens())
&& Objects.equals(dryRun(), other.dryRun());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("VerifyMacRequest").add("Message", message() == null ? null : "*** Sensitive Data Redacted ***")
.add("KeyId", keyId()).add("MacAlgorithm", macAlgorithmAsString()).add("Mac", mac())
.add("GrantTokens", hasGrantTokens() ? grantTokens() : null).add("DryRun", dryRun()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Message":
return Optional.ofNullable(clazz.cast(message()));
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "MacAlgorithm":
return Optional.ofNullable(clazz.cast(macAlgorithmAsString()));
case "Mac":
return Optional.ofNullable(clazz.cast(mac()));
case "GrantTokens":
return Optional.ofNullable(clazz.cast(grantTokens()));
case "DryRun":
return Optional.ofNullable(clazz.cast(dryRun()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((VerifyMacRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The message that will be used in the verification. Enter the same message that was used to generate the HMAC.
*
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If you
* generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash digest.
*
*
* @param message
* The message that will be used in the verification. Enter the same message that was used to generate
* the HMAC.
*
* GenerateMac and VerifyMac do not provide special handling for message digests. If
* you generated an HMAC for a hash digest of a message, you must verify the HMAC for the same hash
* digest.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder message(SdkBytes message);
/**
*
* The KMS key that will be used in the verification.
*
*
* Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key, the
* VerifyMac operation fails.
*
*
* @param keyId
* The KMS key that will be used in the verification.
*
* Enter a key ID of the KMS key that was used to generate the HMAC. If you identify a different KMS key,
* the VerifyMac operation fails.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to
* compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId
* parameter.
*
*
* @param macAlgorithm
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to
* compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the
* KeyId parameter.
* @see MacAlgorithmSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see MacAlgorithmSpec
*/
Builder macAlgorithm(String macAlgorithm);
/**
*
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to
* compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the KeyId
* parameter.
*
*
* @param macAlgorithm
* The MAC algorithm that will be used in the verification. Enter the same MAC algorithm that was used to
* compute the HMAC. This algorithm must be supported by the HMAC KMS key identified by the
* KeyId parameter.
* @see MacAlgorithmSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see MacAlgorithmSpec
*/
Builder macAlgorithm(MacAlgorithmSpec macAlgorithm);
/**
*
* The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you specified
* the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
*
*
* @param mac
* The HMAC to verify. Enter the HMAC that was generated by the GenerateMac operation when you
* specified the same message, HMAC KMS key, and MAC algorithm as the values specified in this request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder mac(SdkBytes mac);
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and Using a
* grant token in the Key Management Service Developer Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token
* and Using
* a grant token in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantTokens(Collection grantTokens);
/**
*
* A list of grant tokens.
*
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token and Using a
* grant token in the Key Management Service Developer Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* Use a grant token when your permission to call this operation comes from a new grant that has not yet
* achieved eventual consistency. For more information, see Grant token
* and Using
* a grant token in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantTokens(String... grantTokens);
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @param dryRun
* Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS
* API calls in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dryRun(Boolean dryRun);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends KmsRequest.BuilderImpl implements Builder {
private SdkBytes message;
private String keyId;
private String macAlgorithm;
private SdkBytes mac;
private List grantTokens = DefaultSdkAutoConstructList.getInstance();
private Boolean dryRun;
private BuilderImpl() {
}
private BuilderImpl(VerifyMacRequest model) {
super(model);
message(model.message);
keyId(model.keyId);
macAlgorithm(model.macAlgorithm);
mac(model.mac);
grantTokens(model.grantTokens);
dryRun(model.dryRun);
}
public final ByteBuffer getMessage() {
return message == null ? null : message.asByteBuffer();
}
public final void setMessage(ByteBuffer message) {
message(message == null ? null : SdkBytes.fromByteBuffer(message));
}
@Override
public final Builder message(SdkBytes message) {
this.message = message;
return this;
}
public final String getKeyId() {
return keyId;
}
public final void setKeyId(String keyId) {
this.keyId = keyId;
}
@Override
public final Builder keyId(String keyId) {
this.keyId = keyId;
return this;
}
public final String getMacAlgorithm() {
return macAlgorithm;
}
public final void setMacAlgorithm(String macAlgorithm) {
this.macAlgorithm = macAlgorithm;
}
@Override
public final Builder macAlgorithm(String macAlgorithm) {
this.macAlgorithm = macAlgorithm;
return this;
}
@Override
public final Builder macAlgorithm(MacAlgorithmSpec macAlgorithm) {
this.macAlgorithm(macAlgorithm == null ? null : macAlgorithm.toString());
return this;
}
public final ByteBuffer getMac() {
return mac == null ? null : mac.asByteBuffer();
}
public final void setMac(ByteBuffer mac) {
mac(mac == null ? null : SdkBytes.fromByteBuffer(mac));
}
@Override
public final Builder mac(SdkBytes mac) {
this.mac = mac;
return this;
}
public final Collection getGrantTokens() {
if (grantTokens instanceof SdkAutoConstructList) {
return null;
}
return grantTokens;
}
public final void setGrantTokens(Collection grantTokens) {
this.grantTokens = GrantTokenListCopier.copy(grantTokens);
}
@Override
public final Builder grantTokens(Collection grantTokens) {
this.grantTokens = GrantTokenListCopier.copy(grantTokens);
return this;
}
@Override
@SafeVarargs
public final Builder grantTokens(String... grantTokens) {
grantTokens(Arrays.asList(grantTokens));
return this;
}
public final Boolean getDryRun() {
return dryRun;
}
public final void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
@Override
public final Builder dryRun(Boolean dryRun) {
this.dryRun = dryRun;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public VerifyMacRequest build() {
return new VerifyMacRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}