com.amazonaws.services.kms.model.DecryptRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi 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;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*/
public class DecryptRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable {
/**
*
* Ciphertext to be decrypted. The blob includes metadata.
*
*/
private java.nio.ByteBuffer ciphertextBlob;
/**
*
* The encryption context. If this was specified in the Encrypt
* function, it must be specified here or the decryption operation will
* fail. For more information, see Encryption Context.
*
*/
private com.amazonaws.internal.SdkInternalMap encryptionContext;
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the AWS Key Management Service Developer
* Guide.
*
*/
private com.amazonaws.internal.SdkInternalList grantTokens;
/**
*
* Ciphertext to be decrypted. The blob includes metadata.
*
*
* 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 to be decrypted. The blob includes metadata.
*/
public void setCiphertextBlob(java.nio.ByteBuffer ciphertextBlob) {
this.ciphertextBlob = ciphertextBlob;
}
/**
*
* Ciphertext to be decrypted. The blob includes metadata.
*
*
* {@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 to be decrypted. The blob includes metadata.
*/
public java.nio.ByteBuffer getCiphertextBlob() {
return this.ciphertextBlob;
}
/**
*
* Ciphertext to be decrypted. The blob includes metadata.
*
*
* @param ciphertextBlob
* Ciphertext to be decrypted. The blob includes metadata.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DecryptRequest withCiphertextBlob(java.nio.ByteBuffer ciphertextBlob) {
setCiphertextBlob(ciphertextBlob);
return this;
}
/**
*
* The encryption context. If this was specified in the Encrypt
* function, it must be specified here or the decryption operation will
* fail. For more information, see Encryption Context.
*
*
* @return The encryption context. If this was specified in the
* Encrypt function, it must be specified here or the
* decryption operation will fail. For more information, see Encryption Context.
*/
public java.util.Map getEncryptionContext() {
if (encryptionContext == null) {
encryptionContext = new com.amazonaws.internal.SdkInternalMap();
}
return encryptionContext;
}
/**
*
* The encryption context. If this was specified in the Encrypt
* function, it must be specified here or the decryption operation will
* fail. For more information, see Encryption Context.
*
*
* @param encryptionContext
* The encryption context. If this was specified in the
* Encrypt function, it must be specified here or the
* decryption operation will fail. For more information, see Encryption Context.
*/
public void setEncryptionContext(
java.util.Map encryptionContext) {
this.encryptionContext = encryptionContext == null ? null
: new com.amazonaws.internal.SdkInternalMap(
encryptionContext);
}
/**
*
* The encryption context. If this was specified in the Encrypt
* function, it must be specified here or the decryption operation will
* fail. For more information, see Encryption Context.
*
*
* @param encryptionContext
* The encryption context. If this was specified in the
* Encrypt function, it must be specified here or the
* decryption operation will fail. For more information, see Encryption Context.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DecryptRequest withEncryptionContext(
java.util.Map encryptionContext) {
setEncryptionContext(encryptionContext);
return this;
}
public DecryptRequest addEncryptionContextEntry(String key, String value) {
if (null == this.encryptionContext) {
this.encryptionContext = new com.amazonaws.internal.SdkInternalMap();
}
if (this.encryptionContext.containsKey(key))
throw new IllegalArgumentException("Duplicated keys ("
+ key.toString() + ") are provided.");
this.encryptionContext.put(key, value);
return this;
}
/**
* Removes all the entries added into EncryptionContext. <p> Returns a
* reference to this object so that method calls can be chained together.
*/
public DecryptRequest clearEncryptionContextEntries() {
this.encryptionContext = null;
return this;
}
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the AWS Key Management Service Developer
* Guide.
*
*
* @return A list of grant tokens.
*
* For more information, see Grant Tokens in the AWS Key Management Service Developer
* Guide.
*/
public java.util.List getGrantTokens() {
if (grantTokens == null) {
grantTokens = new com.amazonaws.internal.SdkInternalList();
}
return grantTokens;
}
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the AWS Key Management Service Developer
* Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* For more information, see Grant Tokens in the AWS Key Management Service Developer
* Guide.
*/
public void setGrantTokens(java.util.Collection grantTokens) {
if (grantTokens == null) {
this.grantTokens = null;
return;
}
this.grantTokens = new com.amazonaws.internal.SdkInternalList(
grantTokens);
}
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the AWS Key Management Service Developer
* Guide.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setGrantTokens(java.util.Collection)} or
* {@link #withGrantTokens(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param grantTokens
* A list of grant tokens.
*
* For more information, see Grant Tokens in the AWS Key Management Service Developer
* Guide.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DecryptRequest withGrantTokens(String... grantTokens) {
if (this.grantTokens == null) {
setGrantTokens(new com.amazonaws.internal.SdkInternalList(
grantTokens.length));
}
for (String ele : grantTokens) {
this.grantTokens.add(ele);
}
return this;
}
/**
*
* A list of grant tokens.
*
*
* For more information, see Grant Tokens in the AWS Key Management Service Developer
* Guide.
*
*
* @param grantTokens
* A list of grant tokens.
*
* For more information, see Grant Tokens in the AWS Key Management Service Developer
* Guide.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DecryptRequest withGrantTokens(
java.util.Collection grantTokens) {
setGrantTokens(grantTokens);
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 (getEncryptionContext() != null)
sb.append("EncryptionContext: " + getEncryptionContext() + ",");
if (getGrantTokens() != null)
sb.append("GrantTokens: " + getGrantTokens());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DecryptRequest == false)
return false;
DecryptRequest other = (DecryptRequest) obj;
if (other.getCiphertextBlob() == null
^ this.getCiphertextBlob() == null)
return false;
if (other.getCiphertextBlob() != null
&& other.getCiphertextBlob().equals(this.getCiphertextBlob()) == false)
return false;
if (other.getEncryptionContext() == null
^ this.getEncryptionContext() == null)
return false;
if (other.getEncryptionContext() != null
&& other.getEncryptionContext().equals(
this.getEncryptionContext()) == false)
return false;
if (other.getGrantTokens() == null ^ this.getGrantTokens() == null)
return false;
if (other.getGrantTokens() != null
&& other.getGrantTokens().equals(this.getGrantTokens()) == 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
+ ((getEncryptionContext() == null) ? 0
: getEncryptionContext().hashCode());
hashCode = prime
* hashCode
+ ((getGrantTokens() == null) ? 0 : getGrantTokens().hashCode());
return hashCode;
}
@Override
public DecryptRequest clone() {
return (DecryptRequest) super.clone();
}
}