software.amazon.awssdk.services.kms.model.SignResponse 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.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
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.LocationTrait;
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 SignResponse extends KmsResponse implements ToCopyableBuilder {
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(SignResponse::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final SdkField SIGNATURE_FIELD = SdkField. builder(MarshallingType.SDK_BYTES)
.memberName("Signature").getter(getter(SignResponse::signature)).setter(setter(Builder::signature))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Signature").build()).build();
private static final SdkField SIGNING_ALGORITHM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SigningAlgorithm").getter(getter(SignResponse::signingAlgorithmAsString))
.setter(setter(Builder::signingAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SigningAlgorithm").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_ID_FIELD, SIGNATURE_FIELD,
SIGNING_ALGORITHM_FIELD));
private final String keyId;
private final SdkBytes signature;
private final String signingAlgorithm;
private SignResponse(BuilderImpl builder) {
super(builder);
this.keyId = builder.keyId;
this.signature = builder.signature;
this.signingAlgorithm = builder.signingAlgorithm;
}
/**
*
* The Amazon Resource Name (key ARN) of the
* asymmetric KMS key that was used to sign the message.
*
*
* @return The Amazon Resource Name (key ARN) of
* the asymmetric KMS key that was used to sign the message.
*/
public final String keyId() {
return keyId;
}
/**
*
* The cryptographic signature that was generated for the message.
*
*
* -
*
* When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
*
*
* -
*
* When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512 signing
* algorithms, this value is a DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section 2.2.3. This is the most commonly
* used signature format and is appropriate for most uses.
*
*
*
*
* When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not
* Base64-encoded.
*
*
* @return The cryptographic signature that was generated for the message.
*
* -
*
* When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
*
*
* -
*
* When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512
* signing algorithms, this value is a DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section 2.2.3. This is the most
* commonly used signature format and is appropriate for most uses.
*
*
*
*
* When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is
* not Base64-encoded.
*/
public final SdkBytes signature() {
return signature;
}
/**
*
* The signing algorithm that was used to sign the message.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #signingAlgorithm}
* will return {@link SigningAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #signingAlgorithmAsString}.
*
*
* @return The signing algorithm that was used to sign the message.
* @see SigningAlgorithmSpec
*/
public final SigningAlgorithmSpec signingAlgorithm() {
return SigningAlgorithmSpec.fromValue(signingAlgorithm);
}
/**
*
* The signing algorithm that was used to sign the message.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #signingAlgorithm}
* will return {@link SigningAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #signingAlgorithmAsString}.
*
*
* @return The signing algorithm that was used to sign the message.
* @see SigningAlgorithmSpec
*/
public final String signingAlgorithmAsString() {
return signingAlgorithm;
}
@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(keyId());
hashCode = 31 * hashCode + Objects.hashCode(signature());
hashCode = 31 * hashCode + Objects.hashCode(signingAlgorithmAsString());
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 SignResponse)) {
return false;
}
SignResponse other = (SignResponse) obj;
return Objects.equals(keyId(), other.keyId()) && Objects.equals(signature(), other.signature())
&& Objects.equals(signingAlgorithmAsString(), other.signingAlgorithmAsString());
}
/**
* 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("SignResponse").add("KeyId", keyId()).add("Signature", signature())
.add("SigningAlgorithm", signingAlgorithmAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "Signature":
return Optional.ofNullable(clazz.cast(signature()));
case "SigningAlgorithm":
return Optional.ofNullable(clazz.cast(signingAlgorithmAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SignResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (key ARN) of the
* asymmetric KMS key that was used to sign the message.
*
*
* @param keyId
* The Amazon Resource Name (key ARN)
* of the asymmetric KMS key that was used to sign the message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* The cryptographic signature that was generated for the message.
*
*
* -
*
* When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
*
*
* -
*
* When used with the ECDSA_SHA_256, ECDSA_SHA_384, or ECDSA_SHA_512
* signing algorithms, this value is a DER-encoded object as defined by ANSI X9.62–2005 and RFC 3279 Section 2.2.3. This is the most
* commonly used signature format and is appropriate for most uses.
*
*
*
*
* When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it is not
* Base64-encoded.
*
*
* @param signature
* The cryptographic signature that was generated for the message.
*
* -
*
* When used with the supported RSA signing algorithms, the encoding of this value is defined by PKCS #1 in RFC 8017.
*
*
* -
*
* When used with the ECDSA_SHA_256, ECDSA_SHA_384, or
* ECDSA_SHA_512 signing algorithms, this value is a DER-encoded object as defined by ANSI
* X9.62–2005 and RFC 3279 Section 2.2.3.
* This is the most commonly used signature format and is appropriate for most uses.
*
*
*
*
* When you use the HTTP API or the Amazon Web Services CLI, the value is Base64-encoded. Otherwise, it
* is not Base64-encoded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder signature(SdkBytes signature);
/**
*
* The signing algorithm that was used to sign the message.
*
*
* @param signingAlgorithm
* The signing algorithm that was used to sign the message.
* @see SigningAlgorithmSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see SigningAlgorithmSpec
*/
Builder signingAlgorithm(String signingAlgorithm);
/**
*
* The signing algorithm that was used to sign the message.
*
*
* @param signingAlgorithm
* The signing algorithm that was used to sign the message.
* @see SigningAlgorithmSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see SigningAlgorithmSpec
*/
Builder signingAlgorithm(SigningAlgorithmSpec signingAlgorithm);
}
static final class BuilderImpl extends KmsResponse.BuilderImpl implements Builder {
private String keyId;
private SdkBytes signature;
private String signingAlgorithm;
private BuilderImpl() {
}
private BuilderImpl(SignResponse model) {
super(model);
keyId(model.keyId);
signature(model.signature);
signingAlgorithm(model.signingAlgorithm);
}
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 ByteBuffer getSignature() {
return signature == null ? null : signature.asByteBuffer();
}
public final void setSignature(ByteBuffer signature) {
signature(signature == null ? null : SdkBytes.fromByteBuffer(signature));
}
@Override
public final Builder signature(SdkBytes signature) {
this.signature = signature;
return this;
}
public final String getSigningAlgorithm() {
return signingAlgorithm;
}
public final void setSigningAlgorithm(String signingAlgorithm) {
this.signingAlgorithm = signingAlgorithm;
}
@Override
public final Builder signingAlgorithm(String signingAlgorithm) {
this.signingAlgorithm = signingAlgorithm;
return this;
}
@Override
public final Builder signingAlgorithm(SigningAlgorithmSpec signingAlgorithm) {
this.signingAlgorithm(signingAlgorithm == null ? null : signingAlgorithm.toString());
return this;
}
@Override
public SignResponse build() {
return new SignResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}