com.amazonaws.services.securitytoken.model.GetFederationTokenResult 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.securitytoken.model;
import java.io.Serializable;
/**
*
* Contains the response to a successful GetFederationToken request,
* including temporary AWS credentials that can be used to make AWS requests.
*
*/
public class GetFederationTokenResult implements Serializable, Cloneable {
/**
*
* The temporary security credentials, which include an access key ID, a
* secret access key, and a security (or session) token.
*
*
* Note: The size of the security token that STS APIs return is not
* fixed. We strongly recommend that you make no assumptions about the
* maximum size. As of this writing, the typical size is less than 4096
* bytes, but that can vary. Also, future updates to AWS might require
* larger sizes.
*
*/
private Credentials credentials;
/**
*
* Identifiers for the federated user associated with the credentials (such
* as arn:aws:sts::123456789012:federated-user/Bob or
* 123456789012:Bob). You can use the federated user's ARN in
* your resource-based policies, such as an Amazon S3 bucket policy.
*
*/
private FederatedUser federatedUser;
/**
*
* A percentage value indicating the size of the policy in packed form. The
* service rejects policies for which the packed size is greater than 100
* percent of the allowed value.
*
*/
private Integer packedPolicySize;
/**
*
* The temporary security credentials, which include an access key ID, a
* secret access key, and a security (or session) token.
*
*
* Note: The size of the security token that STS APIs return is not
* fixed. We strongly recommend that you make no assumptions about the
* maximum size. As of this writing, the typical size is less than 4096
* bytes, but that can vary. Also, future updates to AWS might require
* larger sizes.
*
*
* @param credentials
* The temporary security credentials, which include an access key
* ID, a secret access key, and a security (or session) token.
*
* Note: The size of the security token that STS APIs return
* is not fixed. We strongly recommend that you make no assumptions
* about the maximum size. As of this writing, the typical size is
* less than 4096 bytes, but that can vary. Also, future updates to
* AWS might require larger sizes.
*/
public void setCredentials(Credentials credentials) {
this.credentials = credentials;
}
/**
*
* The temporary security credentials, which include an access key ID, a
* secret access key, and a security (or session) token.
*
*
* Note: The size of the security token that STS APIs return is not
* fixed. We strongly recommend that you make no assumptions about the
* maximum size. As of this writing, the typical size is less than 4096
* bytes, but that can vary. Also, future updates to AWS might require
* larger sizes.
*
*
* @return The temporary security credentials, which include an access key
* ID, a secret access key, and a security (or session) token.
*
* Note: The size of the security token that STS APIs return
* is not fixed. We strongly recommend that you make no assumptions
* about the maximum size. As of this writing, the typical size is
* less than 4096 bytes, but that can vary. Also, future updates to
* AWS might require larger sizes.
*/
public Credentials getCredentials() {
return this.credentials;
}
/**
*
* The temporary security credentials, which include an access key ID, a
* secret access key, and a security (or session) token.
*
*
* Note: The size of the security token that STS APIs return is not
* fixed. We strongly recommend that you make no assumptions about the
* maximum size. As of this writing, the typical size is less than 4096
* bytes, but that can vary. Also, future updates to AWS might require
* larger sizes.
*
*
* @param credentials
* The temporary security credentials, which include an access key
* ID, a secret access key, and a security (or session) token.
*
* Note: The size of the security token that STS APIs return
* is not fixed. We strongly recommend that you make no assumptions
* about the maximum size. As of this writing, the typical size is
* less than 4096 bytes, but that can vary. Also, future updates to
* AWS might require larger sizes.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public GetFederationTokenResult withCredentials(Credentials credentials) {
setCredentials(credentials);
return this;
}
/**
*
* Identifiers for the federated user associated with the credentials (such
* as arn:aws:sts::123456789012:federated-user/Bob or
* 123456789012:Bob). You can use the federated user's ARN in
* your resource-based policies, such as an Amazon S3 bucket policy.
*
*
* @param federatedUser
* Identifiers for the federated user associated with the credentials
* (such as arn:aws:sts::123456789012:federated-user/Bob
* or 123456789012:Bob). You can use the federated
* user's ARN in your resource-based policies, such as an Amazon S3
* bucket policy.
*/
public void setFederatedUser(FederatedUser federatedUser) {
this.federatedUser = federatedUser;
}
/**
*
* Identifiers for the federated user associated with the credentials (such
* as arn:aws:sts::123456789012:federated-user/Bob or
* 123456789012:Bob). You can use the federated user's ARN in
* your resource-based policies, such as an Amazon S3 bucket policy.
*
*
* @return Identifiers for the federated user associated with the
* credentials (such as
* arn:aws:sts::123456789012:federated-user/Bob or
* 123456789012:Bob). You can use the federated user's
* ARN in your resource-based policies, such as an Amazon S3 bucket
* policy.
*/
public FederatedUser getFederatedUser() {
return this.federatedUser;
}
/**
*
* Identifiers for the federated user associated with the credentials (such
* as arn:aws:sts::123456789012:federated-user/Bob or
* 123456789012:Bob). You can use the federated user's ARN in
* your resource-based policies, such as an Amazon S3 bucket policy.
*
*
* @param federatedUser
* Identifiers for the federated user associated with the credentials
* (such as arn:aws:sts::123456789012:federated-user/Bob
* or 123456789012:Bob). You can use the federated
* user's ARN in your resource-based policies, such as an Amazon S3
* bucket policy.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public GetFederationTokenResult withFederatedUser(
FederatedUser federatedUser) {
setFederatedUser(federatedUser);
return this;
}
/**
*
* A percentage value indicating the size of the policy in packed form. The
* service rejects policies for which the packed size is greater than 100
* percent of the allowed value.
*
*
* @param packedPolicySize
* A percentage value indicating the size of the policy in packed
* form. The service rejects policies for which the packed size is
* greater than 100 percent of the allowed value.
*/
public void setPackedPolicySize(Integer packedPolicySize) {
this.packedPolicySize = packedPolicySize;
}
/**
*
* A percentage value indicating the size of the policy in packed form. The
* service rejects policies for which the packed size is greater than 100
* percent of the allowed value.
*
*
* @return A percentage value indicating the size of the policy in packed
* form. The service rejects policies for which the packed size is
* greater than 100 percent of the allowed value.
*/
public Integer getPackedPolicySize() {
return this.packedPolicySize;
}
/**
*
* A percentage value indicating the size of the policy in packed form. The
* service rejects policies for which the packed size is greater than 100
* percent of the allowed value.
*
*
* @param packedPolicySize
* A percentage value indicating the size of the policy in packed
* form. The service rejects policies for which the packed size is
* greater than 100 percent of the allowed value.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public GetFederationTokenResult withPackedPolicySize(
Integer packedPolicySize) {
setPackedPolicySize(packedPolicySize);
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 (getCredentials() != null)
sb.append("Credentials: " + getCredentials() + ",");
if (getFederatedUser() != null)
sb.append("FederatedUser: " + getFederatedUser() + ",");
if (getPackedPolicySize() != null)
sb.append("PackedPolicySize: " + getPackedPolicySize());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetFederationTokenResult == false)
return false;
GetFederationTokenResult other = (GetFederationTokenResult) obj;
if (other.getCredentials() == null ^ this.getCredentials() == null)
return false;
if (other.getCredentials() != null
&& other.getCredentials().equals(this.getCredentials()) == false)
return false;
if (other.getFederatedUser() == null ^ this.getFederatedUser() == null)
return false;
if (other.getFederatedUser() != null
&& other.getFederatedUser().equals(this.getFederatedUser()) == false)
return false;
if (other.getPackedPolicySize() == null
^ this.getPackedPolicySize() == null)
return false;
if (other.getPackedPolicySize() != null
&& other.getPackedPolicySize().equals(
this.getPackedPolicySize()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getCredentials() == null) ? 0 : getCredentials().hashCode());
hashCode = prime
* hashCode
+ ((getFederatedUser() == null) ? 0 : getFederatedUser()
.hashCode());
hashCode = prime
* hashCode
+ ((getPackedPolicySize() == null) ? 0 : getPackedPolicySize()
.hashCode());
return hashCode;
}
@Override
public GetFederationTokenResult clone() {
try {
return (GetFederationTokenResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException(
"Got a CloneNotSupportedException from Object.clone() "
+ "even though we're Cloneable!", e);
}
}
}