Class JwtAdditionalClaim
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<JwtAdditionalClaim.Builder,JwtAdditionalClaim>
An additional claim rule for an issuer.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic JwtAdditionalClaim.Builderbuilder()final StringThe name of the claim to check.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.The accepted value for the claim.final JwtClaimFormatformat()The format of the claim value.final StringThe format of the claim value.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the ExpectedValues property.final inthashCode()final Booleanrequired()Specifies whether the claim must be present in the token.static Class<? extends JwtAdditionalClaim.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
claimName
The name of the claim to check. The value cannot be empty and cannot be
iss,aud,exp,nbf,iat,scope, orscp.- Returns:
- The name of the claim to check. The value cannot be empty and cannot be
iss,aud,exp,nbf,iat,scope, orscp.
-
format
The format of the claim value. The only valid value is
SINGLE_STRING.If the service returns an enum value that is not available in the current SDK version,
formatwill returnJwtClaimFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromformatAsString().- Returns:
- The format of the claim value. The only valid value is
SINGLE_STRING. - See Also:
-
formatAsString
The format of the claim value. The only valid value is
SINGLE_STRING.If the service returns an enum value that is not available in the current SDK version,
formatwill returnJwtClaimFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromformatAsString().- Returns:
- The format of the claim value. The only valid value is
SINGLE_STRING. - See Also:
-
required
Specifies whether the claim must be present in the token. Defaults to
false. Whentrue, the token must contain the claim.- Returns:
- Specifies whether the claim must be present in the token. Defaults to
false. Whentrue, the token must contain the claim.
-
hasExpectedValues
public final boolean hasExpectedValues()For responses, this returns true if the service returned a value for the ExpectedValues property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
expectedValues
The accepted value for the claim. The value cannot be empty. When a value is specified, the claim must match it exactly, and the match is case-sensitive. When no value is specified, the claim only has to be present.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasExpectedValues()method.- Returns:
- The accepted value for the claim. The value cannot be empty. When a value is specified, the claim must match it exactly, and the match is case-sensitive. When no value is specified, the claim only has to be present.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<JwtAdditionalClaim.Builder,JwtAdditionalClaim> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-