/*
* 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.cognitoidentity.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* <p>
* Gets an OpenID token, using a known Cognito ID. This known Cognito ID is
* returned by <a>GetId</a>. You can optionally add additional logins for the
* identity. Supplying multiple logins creates an implicit link.
* </p>
* <p>
* The OpenId token is valid for 15 minutes.
* </p>
* <p>
* This is a public API. You do not need any credentials to call this API.
* </p>
*/
public class GetOpenIdTokenRequest extends AmazonWebServiceRequest implements Serializable {
/**
* A unique identifier in the format REGION:GUID.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 55<br/>
* <b>Pattern: </b>[\w-]+:[0-9a-f-]+<br/>
*/
private String identityId;
/**
* A set of optional name-value pairs that map provider names to provider
* tokens. When using graph.facebook.com and www.amazon.com, supply the
* access_token returned from the provider's authflow. For
* accounts.google.com or any other OpenId Connect provider, always include
* the id_token.
*/
private java.util.Map<String, String> logins;
/**
* A unique identifier in the format REGION:GUID.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 55<br/>
* <b>Pattern: </b>[\w-]+:[0-9a-f-]+<br/>
*
* @return A unique identifier in the format REGION:GUID.
*/
public String getIdentityId() {
return identityId;
}
/**
* A unique identifier in the format REGION:GUID.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 55<br/>
* <b>Pattern: </b>[\w-]+:[0-9a-f-]+<br/>
*
* @param identityId A unique identifier in the format REGION:GUID.
*/
public void setIdentityId(String identityId) {
this.identityId = identityId;
}
/**
* A unique identifier in the format REGION:GUID.
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 55<br/>
* <b>Pattern: </b>[\w-]+:[0-9a-f-]+<br/>
*
* @param identityId A unique identifier in the format REGION:GUID.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GetOpenIdTokenRequest withIdentityId(String identityId) {
this.identityId = identityId;
return this;
}
/**
* A set of optional name-value pairs that map provider names to provider
* tokens. When using graph.facebook.com and www.amazon.com, supply the
* access_token returned from the provider's authflow. For
* accounts.google.com or any other OpenId Connect provider, always include
* the id_token.
*
* @return A set of optional name-value pairs that map provider names to
* provider tokens. When using graph.facebook.com and
* www.amazon.com, supply the access_token returned from the
* provider's authflow. For accounts.google.com or any other OpenId
* Connect provider, always include the id_token.
*/
public java.util.Map<String, String> getLogins() {
return logins;
}
/**
* A set of optional name-value pairs that map provider names to provider
* tokens. When using graph.facebook.com and www.amazon.com, supply the
* access_token returned from the provider's authflow. For
* accounts.google.com or any other OpenId Connect provider, always include
* the id_token.
*
* @param logins A set of optional name-value pairs that map provider names
* to provider tokens. When using graph.facebook.com and
* www.amazon.com, supply the access_token returned from the
* provider's authflow. For accounts.google.com or any other
* OpenId Connect provider, always include the id_token.
*/
public void setLogins(java.util.Map<String, String> logins) {
this.logins = logins;
}
/**
* A set of optional name-value pairs that map provider names to provider
* tokens. When using graph.facebook.com and www.amazon.com, supply the
* access_token returned from the provider's authflow. For
* accounts.google.com or any other OpenId Connect provider, always include
* the id_token.
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param logins A set of optional name-value pairs that map provider names
* to provider tokens. When using graph.facebook.com and
* www.amazon.com, supply the access_token returned from the
* provider's authflow. For accounts.google.com or any other
* OpenId Connect provider, always include the id_token.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GetOpenIdTokenRequest withLogins(java.util.Map<String, String> logins) {
this.logins = logins;
return this;
}
/**
* A set of optional name-value pairs that map provider names to provider
* tokens. When using graph.facebook.com and www.amazon.com, supply the
* access_token returned from the provider's authflow. For
* accounts.google.com or any other OpenId Connect provider, always include
* the id_token.
* <p>
* The method adds a new key-value pair into Logins parameter, and returns a
* reference to this object so that method calls can be chained together.
*
* @param key The key of the entry to be added into Logins.
* @param value The corresponding value of the entry to be added into
* Logins.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public GetOpenIdTokenRequest addLoginsEntry(String key, String value) {
if (null == this.logins) {
this.logins = new java.util.HashMap<String, String>();
}
if (this.logins.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString()
+ ") are provided.");
this.logins.put(key, value);
return this;
}
/**
* Removes all the entries added into Logins.
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*/
public GetOpenIdTokenRequest clearLoginsEntries() {
this.logins = 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 (getIdentityId() != null)
sb.append("IdentityId: " + getIdentityId() + ",");
if (getLogins() != null)
sb.append("Logins: " + getLogins());
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getIdentityId() == null) ? 0 : getIdentityId().hashCode());
hashCode = prime * hashCode + ((getLogins() == null) ? 0 : getLogins().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetOpenIdTokenRequest == false)
return false;
GetOpenIdTokenRequest other = (GetOpenIdTokenRequest) obj;
if (other.getIdentityId() == null ^ this.getIdentityId() == null)
return false;
if (other.getIdentityId() != null
&& other.getIdentityId().equals(this.getIdentityId()) == false)
return false;
if (other.getLogins() == null ^ this.getLogins() == null)
return false;
if (other.getLogins() != null && other.getLogins().equals(this.getLogins()) == false)
return false;
return true;
}
}