/* * Copyright 2018-2023 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.iot.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* The authorizer description. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AuthorizerDescription implements Serializable, Cloneable, StructuredPojo { /** *

* The authorizer name. *

*/ private String authorizerName; /** *

* The authorizer ARN. *

*/ private String authorizerArn; /** *

* The authorizer's Lambda function ARN. *

*/ private String authorizerFunctionArn; /** *

* The key used to extract the token from the HTTP headers. *

*/ private String tokenKeyName; /** *

* The public keys used to validate the token signature returned by your custom authentication service. *

*/ private java.util.Map tokenSigningPublicKeys; /** *

* The status of the authorizer. *

*/ private String status; /** *

* The UNIX timestamp of when the authorizer was created. *

*/ private java.util.Date creationDate; /** *

* The UNIX timestamp of when the authorizer was last updated. *

*/ private java.util.Date lastModifiedDate; /** *

* Specifies whether IoT validates the token signature in an authorization request. *

*/ private Boolean signingDisabled; /** *

* When true, the result from the authorizer’s Lambda function is cached for the time specified in * refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection. *

*/ private Boolean enableCachingForHttp; /** *

* The authorizer name. *

* * @param authorizerName * The authorizer name. */ public void setAuthorizerName(String authorizerName) { this.authorizerName = authorizerName; } /** *

* The authorizer name. *

* * @return The authorizer name. */ public String getAuthorizerName() { return this.authorizerName; } /** *

* The authorizer name. *

* * @param authorizerName * The authorizer name. * @return Returns a reference to this object so that method calls can be chained together. */ public AuthorizerDescription withAuthorizerName(String authorizerName) { setAuthorizerName(authorizerName); return this; } /** *

* The authorizer ARN. *

* * @param authorizerArn * The authorizer ARN. */ public void setAuthorizerArn(String authorizerArn) { this.authorizerArn = authorizerArn; } /** *

* The authorizer ARN. *

* * @return The authorizer ARN. */ public String getAuthorizerArn() { return this.authorizerArn; } /** *

* The authorizer ARN. *

* * @param authorizerArn * The authorizer ARN. * @return Returns a reference to this object so that method calls can be chained together. */ public AuthorizerDescription withAuthorizerArn(String authorizerArn) { setAuthorizerArn(authorizerArn); return this; } /** *

* The authorizer's Lambda function ARN. *

* * @param authorizerFunctionArn * The authorizer's Lambda function ARN. */ public void setAuthorizerFunctionArn(String authorizerFunctionArn) { this.authorizerFunctionArn = authorizerFunctionArn; } /** *

* The authorizer's Lambda function ARN. *

* * @return The authorizer's Lambda function ARN. */ public String getAuthorizerFunctionArn() { return this.authorizerFunctionArn; } /** *

* The authorizer's Lambda function ARN. *

* * @param authorizerFunctionArn * The authorizer's Lambda function ARN. * @return Returns a reference to this object so that method calls can be chained together. */ public AuthorizerDescription withAuthorizerFunctionArn(String authorizerFunctionArn) { setAuthorizerFunctionArn(authorizerFunctionArn); return this; } /** *

* The key used to extract the token from the HTTP headers. *

* * @param tokenKeyName * The key used to extract the token from the HTTP headers. */ public void setTokenKeyName(String tokenKeyName) { this.tokenKeyName = tokenKeyName; } /** *

* The key used to extract the token from the HTTP headers. *

* * @return The key used to extract the token from the HTTP headers. */ public String getTokenKeyName() { return this.tokenKeyName; } /** *

* The key used to extract the token from the HTTP headers. *

* * @param tokenKeyName * The key used to extract the token from the HTTP headers. * @return Returns a reference to this object so that method calls can be chained together. */ public AuthorizerDescription withTokenKeyName(String tokenKeyName) { setTokenKeyName(tokenKeyName); return this; } /** *

* The public keys used to validate the token signature returned by your custom authentication service. *

* * @return The public keys used to validate the token signature returned by your custom authentication service. */ public java.util.Map getTokenSigningPublicKeys() { return tokenSigningPublicKeys; } /** *

* The public keys used to validate the token signature returned by your custom authentication service. *

* * @param tokenSigningPublicKeys * The public keys used to validate the token signature returned by your custom authentication service. */ public void setTokenSigningPublicKeys(java.util.Map tokenSigningPublicKeys) { this.tokenSigningPublicKeys = tokenSigningPublicKeys; } /** *

* The public keys used to validate the token signature returned by your custom authentication service. *

* * @param tokenSigningPublicKeys * The public keys used to validate the token signature returned by your custom authentication service. * @return Returns a reference to this object so that method calls can be chained together. */ public AuthorizerDescription withTokenSigningPublicKeys(java.util.Map tokenSigningPublicKeys) { setTokenSigningPublicKeys(tokenSigningPublicKeys); return this; } /** * Add a single TokenSigningPublicKeys entry * * @see AuthorizerDescription#withTokenSigningPublicKeys * @returns a reference to this object so that method calls can be chained together. */ public AuthorizerDescription addTokenSigningPublicKeysEntry(String key, String value) { if (null == this.tokenSigningPublicKeys) { this.tokenSigningPublicKeys = new java.util.HashMap(); } if (this.tokenSigningPublicKeys.containsKey(key)) throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided."); this.tokenSigningPublicKeys.put(key, value); return this; } /** * Removes all the entries added into TokenSigningPublicKeys. * * @return Returns a reference to this object so that method calls can be chained together. */ public AuthorizerDescription clearTokenSigningPublicKeysEntries() { this.tokenSigningPublicKeys = null; return this; } /** *

* The status of the authorizer. *

* * @param status * The status of the authorizer. * @see AuthorizerStatus */ public void setStatus(String status) { this.status = status; } /** *

* The status of the authorizer. *

* * @return The status of the authorizer. * @see AuthorizerStatus */ public String getStatus() { return this.status; } /** *

* The status of the authorizer. *

* * @param status * The status of the authorizer. * @return Returns a reference to this object so that method calls can be chained together. * @see AuthorizerStatus */ public AuthorizerDescription withStatus(String status) { setStatus(status); return this; } /** *

* The status of the authorizer. *

* * @param status * The status of the authorizer. * @return Returns a reference to this object so that method calls can be chained together. * @see AuthorizerStatus */ public AuthorizerDescription withStatus(AuthorizerStatus status) { this.status = status.toString(); return this; } /** *

* The UNIX timestamp of when the authorizer was created. *

* * @param creationDate * The UNIX timestamp of when the authorizer was created. */ public void setCreationDate(java.util.Date creationDate) { this.creationDate = creationDate; } /** *

* The UNIX timestamp of when the authorizer was created. *

* * @return The UNIX timestamp of when the authorizer was created. */ public java.util.Date getCreationDate() { return this.creationDate; } /** *

* The UNIX timestamp of when the authorizer was created. *

* * @param creationDate * The UNIX timestamp of when the authorizer was created. * @return Returns a reference to this object so that method calls can be chained together. */ public AuthorizerDescription withCreationDate(java.util.Date creationDate) { setCreationDate(creationDate); return this; } /** *

* The UNIX timestamp of when the authorizer was last updated. *

* * @param lastModifiedDate * The UNIX timestamp of when the authorizer was last updated. */ public void setLastModifiedDate(java.util.Date lastModifiedDate) { this.lastModifiedDate = lastModifiedDate; } /** *

* The UNIX timestamp of when the authorizer was last updated. *

* * @return The UNIX timestamp of when the authorizer was last updated. */ public java.util.Date getLastModifiedDate() { return this.lastModifiedDate; } /** *

* The UNIX timestamp of when the authorizer was last updated. *

* * @param lastModifiedDate * The UNIX timestamp of when the authorizer was last updated. * @return Returns a reference to this object so that method calls can be chained together. */ public AuthorizerDescription withLastModifiedDate(java.util.Date lastModifiedDate) { setLastModifiedDate(lastModifiedDate); return this; } /** *

* Specifies whether IoT validates the token signature in an authorization request. *

* * @param signingDisabled * Specifies whether IoT validates the token signature in an authorization request. */ public void setSigningDisabled(Boolean signingDisabled) { this.signingDisabled = signingDisabled; } /** *

* Specifies whether IoT validates the token signature in an authorization request. *

* * @return Specifies whether IoT validates the token signature in an authorization request. */ public Boolean getSigningDisabled() { return this.signingDisabled; } /** *

* Specifies whether IoT validates the token signature in an authorization request. *

* * @param signingDisabled * Specifies whether IoT validates the token signature in an authorization request. * @return Returns a reference to this object so that method calls can be chained together. */ public AuthorizerDescription withSigningDisabled(Boolean signingDisabled) { setSigningDisabled(signingDisabled); return this; } /** *

* Specifies whether IoT validates the token signature in an authorization request. *

* * @return Specifies whether IoT validates the token signature in an authorization request. */ public Boolean isSigningDisabled() { return this.signingDisabled; } /** *

* When true, the result from the authorizer’s Lambda function is cached for the time specified in * refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection. *

* * @param enableCachingForHttp * When true, the result from the authorizer’s Lambda function is cached for the time specified * in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP * connection. */ public void setEnableCachingForHttp(Boolean enableCachingForHttp) { this.enableCachingForHttp = enableCachingForHttp; } /** *

* When true, the result from the authorizer’s Lambda function is cached for the time specified in * refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection. *

* * @return When true, the result from the authorizer’s Lambda function is cached for the time specified * in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP * connection. */ public Boolean getEnableCachingForHttp() { return this.enableCachingForHttp; } /** *

* When true, the result from the authorizer’s Lambda function is cached for the time specified in * refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection. *

* * @param enableCachingForHttp * When true, the result from the authorizer’s Lambda function is cached for the time specified * in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP * connection. * @return Returns a reference to this object so that method calls can be chained together. */ public AuthorizerDescription withEnableCachingForHttp(Boolean enableCachingForHttp) { setEnableCachingForHttp(enableCachingForHttp); return this; } /** *

* When true, the result from the authorizer’s Lambda function is cached for the time specified in * refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP connection. *

* * @return When true, the result from the authorizer’s Lambda function is cached for the time specified * in refreshAfterInSeconds. The cached result is used while the device reuses the same HTTP * connection. */ public Boolean isEnableCachingForHttp() { return this.enableCachingForHttp; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getAuthorizerName() != null) sb.append("AuthorizerName: ").append(getAuthorizerName()).append(","); if (getAuthorizerArn() != null) sb.append("AuthorizerArn: ").append(getAuthorizerArn()).append(","); if (getAuthorizerFunctionArn() != null) sb.append("AuthorizerFunctionArn: ").append(getAuthorizerFunctionArn()).append(","); if (getTokenKeyName() != null) sb.append("TokenKeyName: ").append(getTokenKeyName()).append(","); if (getTokenSigningPublicKeys() != null) sb.append("TokenSigningPublicKeys: ").append(getTokenSigningPublicKeys()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getCreationDate() != null) sb.append("CreationDate: ").append(getCreationDate()).append(","); if (getLastModifiedDate() != null) sb.append("LastModifiedDate: ").append(getLastModifiedDate()).append(","); if (getSigningDisabled() != null) sb.append("SigningDisabled: ").append(getSigningDisabled()).append(","); if (getEnableCachingForHttp() != null) sb.append("EnableCachingForHttp: ").append(getEnableCachingForHttp()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof AuthorizerDescription == false) return false; AuthorizerDescription other = (AuthorizerDescription) obj; if (other.getAuthorizerName() == null ^ this.getAuthorizerName() == null) return false; if (other.getAuthorizerName() != null && other.getAuthorizerName().equals(this.getAuthorizerName()) == false) return false; if (other.getAuthorizerArn() == null ^ this.getAuthorizerArn() == null) return false; if (other.getAuthorizerArn() != null && other.getAuthorizerArn().equals(this.getAuthorizerArn()) == false) return false; if (other.getAuthorizerFunctionArn() == null ^ this.getAuthorizerFunctionArn() == null) return false; if (other.getAuthorizerFunctionArn() != null && other.getAuthorizerFunctionArn().equals(this.getAuthorizerFunctionArn()) == false) return false; if (other.getTokenKeyName() == null ^ this.getTokenKeyName() == null) return false; if (other.getTokenKeyName() != null && other.getTokenKeyName().equals(this.getTokenKeyName()) == false) return false; if (other.getTokenSigningPublicKeys() == null ^ this.getTokenSigningPublicKeys() == null) return false; if (other.getTokenSigningPublicKeys() != null && other.getTokenSigningPublicKeys().equals(this.getTokenSigningPublicKeys()) == false) return false; if (other.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false) return false; if (other.getCreationDate() == null ^ this.getCreationDate() == null) return false; if (other.getCreationDate() != null && other.getCreationDate().equals(this.getCreationDate()) == false) return false; if (other.getLastModifiedDate() == null ^ this.getLastModifiedDate() == null) return false; if (other.getLastModifiedDate() != null && other.getLastModifiedDate().equals(this.getLastModifiedDate()) == false) return false; if (other.getSigningDisabled() == null ^ this.getSigningDisabled() == null) return false; if (other.getSigningDisabled() != null && other.getSigningDisabled().equals(this.getSigningDisabled()) == false) return false; if (other.getEnableCachingForHttp() == null ^ this.getEnableCachingForHttp() == null) return false; if (other.getEnableCachingForHttp() != null && other.getEnableCachingForHttp().equals(this.getEnableCachingForHttp()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAuthorizerName() == null) ? 0 : getAuthorizerName().hashCode()); hashCode = prime * hashCode + ((getAuthorizerArn() == null) ? 0 : getAuthorizerArn().hashCode()); hashCode = prime * hashCode + ((getAuthorizerFunctionArn() == null) ? 0 : getAuthorizerFunctionArn().hashCode()); hashCode = prime * hashCode + ((getTokenKeyName() == null) ? 0 : getTokenKeyName().hashCode()); hashCode = prime * hashCode + ((getTokenSigningPublicKeys() == null) ? 0 : getTokenSigningPublicKeys().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getCreationDate() == null) ? 0 : getCreationDate().hashCode()); hashCode = prime * hashCode + ((getLastModifiedDate() == null) ? 0 : getLastModifiedDate().hashCode()); hashCode = prime * hashCode + ((getSigningDisabled() == null) ? 0 : getSigningDisabled().hashCode()); hashCode = prime * hashCode + ((getEnableCachingForHttp() == null) ? 0 : getEnableCachingForHttp().hashCode()); return hashCode; } @Override public AuthorizerDescription clone() { try { return (AuthorizerDescription) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.iot.model.transform.AuthorizerDescriptionMarshaller.getInstance().marshall(this, protocolMarshaller); } }