Package com.ibm.websphere.security.jwt
Interface Claims
- 
- All Superinterfaces:
- java.util.Map<java.lang.String,java.lang.Object>
 
 public interface Claims extends java.util.Map<java.lang.String,java.lang.Object>TheClaimsinterface represents JSON Web Token (JWT) payload claims and offers convenient get methods for some of the well known JWT claims such as "iss", "exp", and "iat".- Since:
- 1.0
 
- 
- 
Field SummaryFields Modifier and Type Field Description static java.lang.StringAUDIENCEThe AUDIENCE is used to represent the "aud" claimstatic java.lang.StringAZPThe AZP is used to represent the "azp" claimstatic java.lang.StringEXPIRATIONThe EXPIRATION is used to represent the "exp" claimstatic java.lang.StringIDThe ID is used to represent the "jti" claimstatic java.lang.StringISSUED_ATThe ISSUED_AT is used to represent the "iat" claimstatic java.lang.StringISSUERThe ISSUER is used to represent the "iss" claimstatic java.lang.StringNOT_BEFOREThe NOT_BEFORE is used to represent the "nbf" claimstatic java.lang.StringSUBJECTThe SUBJECT is used to represent the "sub" claimstatic java.lang.StringTOKEN_TYPEThe TOKEN_TYPE is used to represent the "token_type" claim
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.Object>getAllClaims()java.util.List<java.lang.String>getAudience()java.lang.StringgetAuthorizedParty()<T> TgetClaim(java.lang.String claimName, java.lang.Class<T> requiredType)longgetExpiration()longgetIssuedAt()java.lang.StringgetIssuer()java.lang.StringgetJwtId()longgetNotBefore()java.lang.StringgetSubject()java.lang.StringtoJsonString()
 
- 
- 
- 
Field Detail- 
ISSUERstatic final java.lang.String ISSUER The ISSUER is used to represent the "iss" claim- See Also:
- Constant Field Values
 
 - 
SUBJECTstatic final java.lang.String SUBJECT The SUBJECT is used to represent the "sub" claim- See Also:
- Constant Field Values
 
 - 
AUDIENCEstatic final java.lang.String AUDIENCE The AUDIENCE is used to represent the "aud" claim- See Also:
- Constant Field Values
 
 - 
EXPIRATIONstatic final java.lang.String EXPIRATION The EXPIRATION is used to represent the "exp" claim- See Also:
- Constant Field Values
 
 - 
NOT_BEFOREstatic final java.lang.String NOT_BEFORE The NOT_BEFORE is used to represent the "nbf" claim- See Also:
- Constant Field Values
 
 - 
ISSUED_ATstatic final java.lang.String ISSUED_AT The ISSUED_AT is used to represent the "iat" claim- See Also:
- Constant Field Values
 
 - 
IDstatic final java.lang.String ID The ID is used to represent the "jti" claim- See Also:
- Constant Field Values
 
 - 
AZPstatic final java.lang.String AZP The AZP is used to represent the "azp" claim- See Also:
- Constant Field Values
 
 - 
TOKEN_TYPEstatic final java.lang.String TOKEN_TYPE The TOKEN_TYPE is used to represent the "token_type" claim- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getIssuerjava.lang.String getIssuer() - Returns:
- The "iss" claim
 
 - 
getSubjectjava.lang.String getSubject() - Returns:
- The "sub" claim
 
 - 
getAudiencejava.util.List<java.lang.String> getAudience() - Returns:
- The "aud" claim
 
 - 
getExpirationlong getExpiration() - Returns:
- The "exp" claim
 
 - 
getNotBeforelong getNotBefore() - Returns:
- The "nbf" claim
 
 - 
getIssuedAtlong getIssuedAt() - Returns:
- The "iat" claim
 
 - 
getJwtIdjava.lang.String getJwtId() - Returns:
- The "jti" claim
 
 - 
getAuthorizedPartyjava.lang.String getAuthorizedParty() - Returns:
- The "azp" claim
 
 - 
getClaim<T> T getClaim(java.lang.String claimName, java.lang.Class<T> requiredType)- Parameters:
- claimName- claim name
- requiredType- This is the required type of the claim value
- Returns:
- The claim value that matches the requiredType
 
 - 
getAllClaimsjava.util.Map<java.lang.String,java.lang.Object> getAllClaims() - Returns:
- All the claims
 
 - 
toJsonStringjava.lang.String toJsonString() - Returns:
- All the claims in JSON string format
 
 
- 
 
-