com.amazonaws.services.kms.model.GenerateDataKeyResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2010-2016 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 com.amazonaws.services.kms.model;
import java.io.Serializable;
/**
*
*/
public class GenerateDataKeyResult implements Serializable, Cloneable {
/**
*
* Ciphertext that contains the encrypted data key. You must store the blob
* and enough information to reconstruct the encryption context so that the
* data encrypted by using the key can later be decrypted. You must provide
* both the ciphertext blob and the encryption context to the Decrypt
* API to recover the plaintext data key and decrypt the object.
*
*
* If you are using the CLI, the value is Base64 encoded. Otherwise, it is
* not encoded.
*
*/
private java.nio.ByteBuffer ciphertextBlob;
/**
*
* Plaintext that contains the data key. Use this for encryption and
* decryption and then remove it from memory as soon as possible.
*
*/
private java.nio.ByteBuffer plaintext;
/**
*
* System generated unique identifier of the key to be used to decrypt the
* encrypted copy of the data key.
*
*/
private String keyId;
/**
*
* Ciphertext that contains the encrypted data key. You must store the blob
* and enough information to reconstruct the encryption context so that the
* data encrypted by using the key can later be decrypted. You must provide
* both the ciphertext blob and the encryption context to the Decrypt
* API to recover the plaintext data key and decrypt the object.
*
*
* If you are using the CLI, the value is Base64 encoded. Otherwise, it is
* not encoded.
*
*
* AWS SDK for Java performs a Base64 encoding on this field before sending
* this request to AWS service by default. Users of the SDK should not
* perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the
* content or position of the byte buffer will be seen by all objects that
* have a reference to this object. It is recommended to call
* ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or
* reading from the buffer. This behavior will be changed in a future major
* version of the SDK.
*
*
* @param ciphertextBlob
* Ciphertext that contains the encrypted data key. You must store
* the blob and enough information to reconstruct the encryption
* context so that the data encrypted by using the key can later be
* decrypted. You must provide both the ciphertext blob and the
* encryption context to the Decrypt API to recover the
* plaintext data key and decrypt the object.
*
* If you are using the CLI, the value is Base64 encoded. Otherwise,
* it is not encoded.
*/
public void setCiphertextBlob(java.nio.ByteBuffer ciphertextBlob) {
this.ciphertextBlob = ciphertextBlob;
}
/**
*
* Ciphertext that contains the encrypted data key. You must store the blob
* and enough information to reconstruct the encryption context so that the
* data encrypted by using the key can later be decrypted. You must provide
* both the ciphertext blob and the encryption context to the Decrypt
* API to recover the plaintext data key and decrypt the object.
*
*
* If you are using the CLI, the value is Base64 encoded. Otherwise, it is
* not encoded.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods
* changes their {@code position}. We recommend using
* {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view
* of the buffer with an independent {@code position}, and calling
* {@code get} methods on this rather than directly on the returned
* {@code ByteBuffer}. Doing so will ensure that anyone else using the
* {@code ByteBuffer} will not be affected by changes to the {@code position}
* .
*
*
* @return Ciphertext that contains the encrypted data key. You must store
* the blob and enough information to reconstruct the encryption
* context so that the data encrypted by using the key can later be
* decrypted. You must provide both the ciphertext blob and the
* encryption context to the Decrypt API to recover the
* plaintext data key and decrypt the object.
*
* If you are using the CLI, the value is Base64 encoded. Otherwise,
* it is not encoded.
*/
public java.nio.ByteBuffer getCiphertextBlob() {
return this.ciphertextBlob;
}
/**
*
* Ciphertext that contains the encrypted data key. You must store the blob
* and enough information to reconstruct the encryption context so that the
* data encrypted by using the key can later be decrypted. You must provide
* both the ciphertext blob and the encryption context to the Decrypt
* API to recover the plaintext data key and decrypt the object.
*
*
* If you are using the CLI, the value is Base64 encoded. Otherwise, it is
* not encoded.
*
*
* @param ciphertextBlob
* Ciphertext that contains the encrypted data key. You must store
* the blob and enough information to reconstruct the encryption
* context so that the data encrypted by using the key can later be
* decrypted. You must provide both the ciphertext blob and the
* encryption context to the Decrypt API to recover the
* plaintext data key and decrypt the object.
*
* If you are using the CLI, the value is Base64 encoded. Otherwise,
* it is not encoded.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public GenerateDataKeyResult withCiphertextBlob(
java.nio.ByteBuffer ciphertextBlob) {
setCiphertextBlob(ciphertextBlob);
return this;
}
/**
*
* Plaintext that contains the data key. Use this for encryption and
* decryption and then remove it from memory as soon as possible.
*
*
* AWS SDK for Java performs a Base64 encoding on this field before sending
* this request to AWS service by default. Users of the SDK should not
* perform Base64 encoding on this field.
*
*
* Warning: ByteBuffers returned by the SDK are mutable. Changes to the
* content or position of the byte buffer will be seen by all objects that
* have a reference to this object. It is recommended to call
* ByteBuffer.duplicate() or ByteBuffer.asReadOnlyBuffer() before using or
* reading from the buffer. This behavior will be changed in a future major
* version of the SDK.
*
*
* @param plaintext
* Plaintext that contains the data key. Use this for encryption and
* decryption and then remove it from memory as soon as possible.
*/
public void setPlaintext(java.nio.ByteBuffer plaintext) {
this.plaintext = plaintext;
}
/**
*
* Plaintext that contains the data key. Use this for encryption and
* decryption and then remove it from memory as soon as possible.
*
*
* {@code ByteBuffer}s are stateful. Calling their {@code get} methods
* changes their {@code position}. We recommend using
* {@link java.nio.ByteBuffer#asReadOnlyBuffer()} to create a read-only view
* of the buffer with an independent {@code position}, and calling
* {@code get} methods on this rather than directly on the returned
* {@code ByteBuffer}. Doing so will ensure that anyone else using the
* {@code ByteBuffer} will not be affected by changes to the {@code position}
* .
*
*
* @return Plaintext that contains the data key. Use this for encryption and
* decryption and then remove it from memory as soon as possible.
*/
public java.nio.ByteBuffer getPlaintext() {
return this.plaintext;
}
/**
*
* Plaintext that contains the data key. Use this for encryption and
* decryption and then remove it from memory as soon as possible.
*
*
* @param plaintext
* Plaintext that contains the data key. Use this for encryption and
* decryption and then remove it from memory as soon as possible.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public GenerateDataKeyResult withPlaintext(java.nio.ByteBuffer plaintext) {
setPlaintext(plaintext);
return this;
}
/**
*
* System generated unique identifier of the key to be used to decrypt the
* encrypted copy of the data key.
*
*
* @param keyId
* System generated unique identifier of the key to be used to
* decrypt the encrypted copy of the data key.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* System generated unique identifier of the key to be used to decrypt the
* encrypted copy of the data key.
*
*
* @return System generated unique identifier of the key to be used to
* decrypt the encrypted copy of the data key.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* System generated unique identifier of the key to be used to decrypt the
* encrypted copy of the data key.
*
*
* @param keyId
* System generated unique identifier of the key to be used to
* decrypt the encrypted copy of the data key.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public GenerateDataKeyResult withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCiphertextBlob() != null)
sb.append("CiphertextBlob: " + getCiphertextBlob() + ",");
if (getPlaintext() != null)
sb.append("Plaintext: " + getPlaintext() + ",");
if (getKeyId() != null)
sb.append("KeyId: " + getKeyId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GenerateDataKeyResult == false)
return false;
GenerateDataKeyResult other = (GenerateDataKeyResult) obj;
if (other.getCiphertextBlob() == null
^ this.getCiphertextBlob() == null)
return false;
if (other.getCiphertextBlob() != null
&& other.getCiphertextBlob().equals(this.getCiphertextBlob()) == false)
return false;
if (other.getPlaintext() == null ^ this.getPlaintext() == null)
return false;
if (other.getPlaintext() != null
&& other.getPlaintext().equals(this.getPlaintext()) == false)
return false;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null
&& other.getKeyId().equals(this.getKeyId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getCiphertextBlob() == null) ? 0 : getCiphertextBlob()
.hashCode());
hashCode = prime * hashCode
+ ((getPlaintext() == null) ? 0 : getPlaintext().hashCode());
hashCode = prime * hashCode
+ ((getKeyId() == null) ? 0 : getKeyId().hashCode());
return hashCode;
}
@Override
public GenerateDataKeyResult clone() {
try {
return (GenerateDataKeyResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}