com.amazonaws.services.kms.model.GrantConstraints Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2011-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;
/**
*
* A structure for specifying the conditions under which the operations
* permitted by the grant are allowed.
*
*
* You can use this structure to allow the operations permitted by the grant
* only when a specified encryption context is present. For more information
* about encryption context, see Encryption Context in the AWS Key Management Service Developer
* Guide.
*
*/
public class GrantConstraints implements Serializable, Cloneable {
/**
*
* Contains a list of key-value pairs, a subset of which must be present in
* the encryption context of a subsequent operation permitted by the grant.
* When a subsequent operation permitted by the grant includes an encryption
* context that matches this list or is a subset of this list, the grant
* allows the operation. Otherwise, the operation is not allowed.
*
*/
private com.amazonaws.internal.SdkInternalMap encryptionContextSubset;
/**
*
* Contains a list of key-value pairs that must be present in the encryption
* context of a subsequent operation permitted by the grant. When a
* subsequent operation permitted by the grant includes an encryption
* context that matches this list, the grant allows the operation.
* Otherwise, the operation is not allowed.
*
*/
private com.amazonaws.internal.SdkInternalMap encryptionContextEquals;
/**
*
* Contains a list of key-value pairs, a subset of which must be present in
* the encryption context of a subsequent operation permitted by the grant.
* When a subsequent operation permitted by the grant includes an encryption
* context that matches this list or is a subset of this list, the grant
* allows the operation. Otherwise, the operation is not allowed.
*
*
* @return Contains a list of key-value pairs, a subset of which must be
* present in the encryption context of a subsequent operation
* permitted by the grant. When a subsequent operation permitted by
* the grant includes an encryption context that matches this list
* or is a subset of this list, the grant allows the operation.
* Otherwise, the operation is not allowed.
*/
public java.util.Map getEncryptionContextSubset() {
if (encryptionContextSubset == null) {
encryptionContextSubset = new com.amazonaws.internal.SdkInternalMap();
}
return encryptionContextSubset;
}
/**
*
* Contains a list of key-value pairs, a subset of which must be present in
* the encryption context of a subsequent operation permitted by the grant.
* When a subsequent operation permitted by the grant includes an encryption
* context that matches this list or is a subset of this list, the grant
* allows the operation. Otherwise, the operation is not allowed.
*
*
* @param encryptionContextSubset
* Contains a list of key-value pairs, a subset of which must be
* present in the encryption context of a subsequent operation
* permitted by the grant. When a subsequent operation permitted by
* the grant includes an encryption context that matches this list or
* is a subset of this list, the grant allows the operation.
* Otherwise, the operation is not allowed.
*/
public void setEncryptionContextSubset(
java.util.Map encryptionContextSubset) {
this.encryptionContextSubset = encryptionContextSubset == null ? null
: new com.amazonaws.internal.SdkInternalMap(
encryptionContextSubset);
}
/**
*
* Contains a list of key-value pairs, a subset of which must be present in
* the encryption context of a subsequent operation permitted by the grant.
* When a subsequent operation permitted by the grant includes an encryption
* context that matches this list or is a subset of this list, the grant
* allows the operation. Otherwise, the operation is not allowed.
*
*
* @param encryptionContextSubset
* Contains a list of key-value pairs, a subset of which must be
* present in the encryption context of a subsequent operation
* permitted by the grant. When a subsequent operation permitted by
* the grant includes an encryption context that matches this list or
* is a subset of this list, the grant allows the operation.
* Otherwise, the operation is not allowed.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public GrantConstraints withEncryptionContextSubset(
java.util.Map encryptionContextSubset) {
setEncryptionContextSubset(encryptionContextSubset);
return this;
}
public GrantConstraints addEncryptionContextSubsetEntry(String key,
String value) {
if (null == this.encryptionContextSubset) {
this.encryptionContextSubset = new com.amazonaws.internal.SdkInternalMap();
}
if (this.encryptionContextSubset.containsKey(key))
throw new IllegalArgumentException("Duplicated keys ("
+ key.toString() + ") are provided.");
this.encryptionContextSubset.put(key, value);
return this;
}
/**
* Removes all the entries added into EncryptionContextSubset. <p>
* Returns a reference to this object so that method calls can be chained
* together.
*/
public GrantConstraints clearEncryptionContextSubsetEntries() {
this.encryptionContextSubset = null;
return this;
}
/**
*
* Contains a list of key-value pairs that must be present in the encryption
* context of a subsequent operation permitted by the grant. When a
* subsequent operation permitted by the grant includes an encryption
* context that matches this list, the grant allows the operation.
* Otherwise, the operation is not allowed.
*
*
* @return Contains a list of key-value pairs that must be present in the
* encryption context of a subsequent operation permitted by the
* grant. When a subsequent operation permitted by the grant
* includes an encryption context that matches this list, the grant
* allows the operation. Otherwise, the operation is not allowed.
*/
public java.util.Map getEncryptionContextEquals() {
if (encryptionContextEquals == null) {
encryptionContextEquals = new com.amazonaws.internal.SdkInternalMap();
}
return encryptionContextEquals;
}
/**
*
* Contains a list of key-value pairs that must be present in the encryption
* context of a subsequent operation permitted by the grant. When a
* subsequent operation permitted by the grant includes an encryption
* context that matches this list, the grant allows the operation.
* Otherwise, the operation is not allowed.
*
*
* @param encryptionContextEquals
* Contains a list of key-value pairs that must be present in the
* encryption context of a subsequent operation permitted by the
* grant. When a subsequent operation permitted by the grant includes
* an encryption context that matches this list, the grant allows the
* operation. Otherwise, the operation is not allowed.
*/
public void setEncryptionContextEquals(
java.util.Map encryptionContextEquals) {
this.encryptionContextEquals = encryptionContextEquals == null ? null
: new com.amazonaws.internal.SdkInternalMap(
encryptionContextEquals);
}
/**
*
* Contains a list of key-value pairs that must be present in the encryption
* context of a subsequent operation permitted by the grant. When a
* subsequent operation permitted by the grant includes an encryption
* context that matches this list, the grant allows the operation.
* Otherwise, the operation is not allowed.
*
*
* @param encryptionContextEquals
* Contains a list of key-value pairs that must be present in the
* encryption context of a subsequent operation permitted by the
* grant. When a subsequent operation permitted by the grant includes
* an encryption context that matches this list, the grant allows the
* operation. Otherwise, the operation is not allowed.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public GrantConstraints withEncryptionContextEquals(
java.util.Map encryptionContextEquals) {
setEncryptionContextEquals(encryptionContextEquals);
return this;
}
public GrantConstraints addEncryptionContextEqualsEntry(String key,
String value) {
if (null == this.encryptionContextEquals) {
this.encryptionContextEquals = new com.amazonaws.internal.SdkInternalMap();
}
if (this.encryptionContextEquals.containsKey(key))
throw new IllegalArgumentException("Duplicated keys ("
+ key.toString() + ") are provided.");
this.encryptionContextEquals.put(key, value);
return this;
}
/**
* Removes all the entries added into EncryptionContextEquals. <p>
* Returns a reference to this object so that method calls can be chained
* together.
*/
public GrantConstraints clearEncryptionContextEqualsEntries() {
this.encryptionContextEquals = null;
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 (getEncryptionContextSubset() != null)
sb.append("EncryptionContextSubset: "
+ getEncryptionContextSubset() + ",");
if (getEncryptionContextEquals() != null)
sb.append("EncryptionContextEquals: "
+ getEncryptionContextEquals());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GrantConstraints == false)
return false;
GrantConstraints other = (GrantConstraints) obj;
if (other.getEncryptionContextSubset() == null
^ this.getEncryptionContextSubset() == null)
return false;
if (other.getEncryptionContextSubset() != null
&& other.getEncryptionContextSubset().equals(
this.getEncryptionContextSubset()) == false)
return false;
if (other.getEncryptionContextEquals() == null
^ this.getEncryptionContextEquals() == null)
return false;
if (other.getEncryptionContextEquals() != null
&& other.getEncryptionContextEquals().equals(
this.getEncryptionContextEquals()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getEncryptionContextSubset() == null) ? 0
: getEncryptionContextSubset().hashCode());
hashCode = prime
* hashCode
+ ((getEncryptionContextEquals() == null) ? 0
: getEncryptionContextEquals().hashCode());
return hashCode;
}
@Override
public GrantConstraints clone() {
try {
return (GrantConstraints) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}