software.amazon.awssdk.services.paymentcryptography.model.ExportKeyMaterial Maven / Gradle / Ivy
Show all versions of paymentcryptography 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.paymentcryptography.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.EnumSet;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
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.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.core.util.SdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Parameter information for key material export from Amazon Web Services Payment Cryptography using TR-31 or TR-34 or
* RSA wrap and unwrap key exchange method.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ExportKeyMaterial implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TR31_KEY_BLOCK_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Tr31KeyBlock")
.getter(getter(ExportKeyMaterial::tr31KeyBlock)).setter(setter(Builder::tr31KeyBlock))
.constructor(ExportTr31KeyBlock::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tr31KeyBlock").build()).build();
private static final SdkField TR34_KEY_BLOCK_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Tr34KeyBlock")
.getter(getter(ExportKeyMaterial::tr34KeyBlock)).setter(setter(Builder::tr34KeyBlock))
.constructor(ExportTr34KeyBlock::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tr34KeyBlock").build()).build();
private static final SdkField KEY_CRYPTOGRAM_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("KeyCryptogram")
.getter(getter(ExportKeyMaterial::keyCryptogram)).setter(setter(Builder::keyCryptogram))
.constructor(ExportKeyCryptogram::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyCryptogram").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TR31_KEY_BLOCK_FIELD,
TR34_KEY_BLOCK_FIELD, KEY_CRYPTOGRAM_FIELD));
private static final long serialVersionUID = 1L;
private final ExportTr31KeyBlock tr31KeyBlock;
private final ExportTr34KeyBlock tr34KeyBlock;
private final ExportKeyCryptogram keyCryptogram;
private final Type type;
private ExportKeyMaterial(BuilderImpl builder) {
this.tr31KeyBlock = builder.tr31KeyBlock;
this.tr34KeyBlock = builder.tr34KeyBlock;
this.keyCryptogram = builder.keyCryptogram;
this.type = builder.type;
}
/**
*
* Parameter information for key material export using symmetric TR-31 key exchange method.
*
*
* @return Parameter information for key material export using symmetric TR-31 key exchange method.
*/
public final ExportTr31KeyBlock tr31KeyBlock() {
return tr31KeyBlock;
}
/**
*
* Parameter information for key material export using the asymmetric TR-34 key exchange method.
*
*
* @return Parameter information for key material export using the asymmetric TR-34 key exchange method.
*/
public final ExportTr34KeyBlock tr34KeyBlock() {
return tr34KeyBlock;
}
/**
*
* Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
*
*
* @return Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
*/
public final ExportKeyCryptogram keyCryptogram() {
return keyCryptogram;
}
@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 + Objects.hashCode(tr31KeyBlock());
hashCode = 31 * hashCode + Objects.hashCode(tr34KeyBlock());
hashCode = 31 * hashCode + Objects.hashCode(keyCryptogram());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ExportKeyMaterial)) {
return false;
}
ExportKeyMaterial other = (ExportKeyMaterial) obj;
return Objects.equals(tr31KeyBlock(), other.tr31KeyBlock()) && Objects.equals(tr34KeyBlock(), other.tr34KeyBlock())
&& Objects.equals(keyCryptogram(), other.keyCryptogram());
}
/**
* 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("ExportKeyMaterial").add("Tr31KeyBlock", tr31KeyBlock()).add("Tr34KeyBlock", tr34KeyBlock())
.add("KeyCryptogram", keyCryptogram()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Tr31KeyBlock":
return Optional.ofNullable(clazz.cast(tr31KeyBlock()));
case "Tr34KeyBlock":
return Optional.ofNullable(clazz.cast(tr34KeyBlock()));
case "KeyCryptogram":
return Optional.ofNullable(clazz.cast(keyCryptogram()));
default:
return Optional.empty();
}
}
/**
* Create an instance of this class with {@link #tr31KeyBlock()} initialized to the given value.
*
*
* Parameter information for key material export using symmetric TR-31 key exchange method.
*
*
* @param tr31KeyBlock
* Parameter information for key material export using symmetric TR-31 key exchange method.
*/
public static ExportKeyMaterial fromTr31KeyBlock(ExportTr31KeyBlock tr31KeyBlock) {
return builder().tr31KeyBlock(tr31KeyBlock).build();
}
/**
* Create an instance of this class with {@link #tr31KeyBlock()} initialized to the given value.
*
*
* Parameter information for key material export using symmetric TR-31 key exchange method.
*
*
* @param tr31KeyBlock
* Parameter information for key material export using symmetric TR-31 key exchange method.
*/
public static ExportKeyMaterial fromTr31KeyBlock(Consumer tr31KeyBlock) {
ExportTr31KeyBlock.Builder builder = ExportTr31KeyBlock.builder();
tr31KeyBlock.accept(builder);
return fromTr31KeyBlock(builder.build());
}
/**
* Create an instance of this class with {@link #tr34KeyBlock()} initialized to the given value.
*
*
* Parameter information for key material export using the asymmetric TR-34 key exchange method.
*
*
* @param tr34KeyBlock
* Parameter information for key material export using the asymmetric TR-34 key exchange method.
*/
public static ExportKeyMaterial fromTr34KeyBlock(ExportTr34KeyBlock tr34KeyBlock) {
return builder().tr34KeyBlock(tr34KeyBlock).build();
}
/**
* Create an instance of this class with {@link #tr34KeyBlock()} initialized to the given value.
*
*
* Parameter information for key material export using the asymmetric TR-34 key exchange method.
*
*
* @param tr34KeyBlock
* Parameter information for key material export using the asymmetric TR-34 key exchange method.
*/
public static ExportKeyMaterial fromTr34KeyBlock(Consumer tr34KeyBlock) {
ExportTr34KeyBlock.Builder builder = ExportTr34KeyBlock.builder();
tr34KeyBlock.accept(builder);
return fromTr34KeyBlock(builder.build());
}
/**
* Create an instance of this class with {@link #keyCryptogram()} initialized to the given value.
*
*
* Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
*
*
* @param keyCryptogram
* Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
*/
public static ExportKeyMaterial fromKeyCryptogram(ExportKeyCryptogram keyCryptogram) {
return builder().keyCryptogram(keyCryptogram).build();
}
/**
* Create an instance of this class with {@link #keyCryptogram()} initialized to the given value.
*
*
* Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
*
*
* @param keyCryptogram
* Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
*/
public static ExportKeyMaterial fromKeyCryptogram(Consumer keyCryptogram) {
ExportKeyCryptogram.Builder builder = ExportKeyCryptogram.builder();
keyCryptogram.accept(builder);
return fromKeyCryptogram(builder.build());
}
/**
* Retrieve an enum value representing which member of this object is populated.
*
* When this class is returned in a service response, this will be {@link Type#UNKNOWN_TO_SDK_VERSION} if the
* service returned a member that is only known to a newer SDK version.
*
* When this class is created directly in your code, this will be {@link Type#UNKNOWN_TO_SDK_VERSION} if zero
* members are set, and {@code null} if more than one member is set.
*/
public Type type() {
return type;
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ExportKeyMaterial) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Parameter information for key material export using symmetric TR-31 key exchange method.
*
*
* @param tr31KeyBlock
* Parameter information for key material export using symmetric TR-31 key exchange method.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tr31KeyBlock(ExportTr31KeyBlock tr31KeyBlock);
/**
*
* Parameter information for key material export using symmetric TR-31 key exchange method.
*
* This is a convenience method that creates an instance of the {@link ExportTr31KeyBlock.Builder} avoiding the
* need to create one manually via {@link ExportTr31KeyBlock#builder()}.
*
*
* When the {@link Consumer} completes, {@link ExportTr31KeyBlock.Builder#build()} is called immediately and its
* result is passed to {@link #tr31KeyBlock(ExportTr31KeyBlock)}.
*
* @param tr31KeyBlock
* a consumer that will call methods on {@link ExportTr31KeyBlock.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tr31KeyBlock(ExportTr31KeyBlock)
*/
default Builder tr31KeyBlock(Consumer tr31KeyBlock) {
return tr31KeyBlock(ExportTr31KeyBlock.builder().applyMutation(tr31KeyBlock).build());
}
/**
*
* Parameter information for key material export using the asymmetric TR-34 key exchange method.
*
*
* @param tr34KeyBlock
* Parameter information for key material export using the asymmetric TR-34 key exchange method.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tr34KeyBlock(ExportTr34KeyBlock tr34KeyBlock);
/**
*
* Parameter information for key material export using the asymmetric TR-34 key exchange method.
*
* This is a convenience method that creates an instance of the {@link ExportTr34KeyBlock.Builder} avoiding the
* need to create one manually via {@link ExportTr34KeyBlock#builder()}.
*
*
* When the {@link Consumer} completes, {@link ExportTr34KeyBlock.Builder#build()} is called immediately and its
* result is passed to {@link #tr34KeyBlock(ExportTr34KeyBlock)}.
*
* @param tr34KeyBlock
* a consumer that will call methods on {@link ExportTr34KeyBlock.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tr34KeyBlock(ExportTr34KeyBlock)
*/
default Builder tr34KeyBlock(Consumer tr34KeyBlock) {
return tr34KeyBlock(ExportTr34KeyBlock.builder().applyMutation(tr34KeyBlock).build());
}
/**
*
* Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
*
*
* @param keyCryptogram
* Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyCryptogram(ExportKeyCryptogram keyCryptogram);
/**
*
* Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
*
* This is a convenience method that creates an instance of the {@link ExportKeyCryptogram.Builder} avoiding the
* need to create one manually via {@link ExportKeyCryptogram#builder()}.
*
*
* When the {@link Consumer} completes, {@link ExportKeyCryptogram.Builder#build()} is called immediately and
* its result is passed to {@link #keyCryptogram(ExportKeyCryptogram)}.
*
* @param keyCryptogram
* a consumer that will call methods on {@link ExportKeyCryptogram.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #keyCryptogram(ExportKeyCryptogram)
*/
default Builder keyCryptogram(Consumer keyCryptogram) {
return keyCryptogram(ExportKeyCryptogram.builder().applyMutation(keyCryptogram).build());
}
}
static final class BuilderImpl implements Builder {
private ExportTr31KeyBlock tr31KeyBlock;
private ExportTr34KeyBlock tr34KeyBlock;
private ExportKeyCryptogram keyCryptogram;
private Type type = Type.UNKNOWN_TO_SDK_VERSION;
private Set setTypes = EnumSet.noneOf(Type.class);
private BuilderImpl() {
}
private BuilderImpl(ExportKeyMaterial model) {
tr31KeyBlock(model.tr31KeyBlock);
tr34KeyBlock(model.tr34KeyBlock);
keyCryptogram(model.keyCryptogram);
}
public final ExportTr31KeyBlock.Builder getTr31KeyBlock() {
return tr31KeyBlock != null ? tr31KeyBlock.toBuilder() : null;
}
public final void setTr31KeyBlock(ExportTr31KeyBlock.BuilderImpl tr31KeyBlock) {
Object oldValue = this.tr31KeyBlock;
this.tr31KeyBlock = tr31KeyBlock != null ? tr31KeyBlock.build() : null;
handleUnionValueChange(Type.TR31_KEY_BLOCK, oldValue, this.tr31KeyBlock);
}
@Override
public final Builder tr31KeyBlock(ExportTr31KeyBlock tr31KeyBlock) {
Object oldValue = this.tr31KeyBlock;
this.tr31KeyBlock = tr31KeyBlock;
handleUnionValueChange(Type.TR31_KEY_BLOCK, oldValue, this.tr31KeyBlock);
return this;
}
public final ExportTr34KeyBlock.Builder getTr34KeyBlock() {
return tr34KeyBlock != null ? tr34KeyBlock.toBuilder() : null;
}
public final void setTr34KeyBlock(ExportTr34KeyBlock.BuilderImpl tr34KeyBlock) {
Object oldValue = this.tr34KeyBlock;
this.tr34KeyBlock = tr34KeyBlock != null ? tr34KeyBlock.build() : null;
handleUnionValueChange(Type.TR34_KEY_BLOCK, oldValue, this.tr34KeyBlock);
}
@Override
public final Builder tr34KeyBlock(ExportTr34KeyBlock tr34KeyBlock) {
Object oldValue = this.tr34KeyBlock;
this.tr34KeyBlock = tr34KeyBlock;
handleUnionValueChange(Type.TR34_KEY_BLOCK, oldValue, this.tr34KeyBlock);
return this;
}
public final ExportKeyCryptogram.Builder getKeyCryptogram() {
return keyCryptogram != null ? keyCryptogram.toBuilder() : null;
}
public final void setKeyCryptogram(ExportKeyCryptogram.BuilderImpl keyCryptogram) {
Object oldValue = this.keyCryptogram;
this.keyCryptogram = keyCryptogram != null ? keyCryptogram.build() : null;
handleUnionValueChange(Type.KEY_CRYPTOGRAM, oldValue, this.keyCryptogram);
}
@Override
public final Builder keyCryptogram(ExportKeyCryptogram keyCryptogram) {
Object oldValue = this.keyCryptogram;
this.keyCryptogram = keyCryptogram;
handleUnionValueChange(Type.KEY_CRYPTOGRAM, oldValue, this.keyCryptogram);
return this;
}
@Override
public ExportKeyMaterial build() {
return new ExportKeyMaterial(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private final void handleUnionValueChange(Type type, Object oldValue, Object newValue) {
if (this.type == type || oldValue == newValue) {
return;
}
if (newValue == null || newValue instanceof SdkAutoConstructList || newValue instanceof SdkAutoConstructMap) {
setTypes.remove(type);
} else if (oldValue == null || oldValue instanceof SdkAutoConstructList || oldValue instanceof SdkAutoConstructMap) {
setTypes.add(type);
}
if (setTypes.size() == 1) {
this.type = setTypes.iterator().next();
} else if (setTypes.isEmpty()) {
this.type = Type.UNKNOWN_TO_SDK_VERSION;
} else {
this.type = null;
}
}
}
/**
* @see ExportKeyMaterial#type()
*/
public enum Type {
TR31_KEY_BLOCK,
TR34_KEY_BLOCK,
KEY_CRYPTOGRAM,
UNKNOWN_TO_SDK_VERSION
}
}