JsonWebToken (Red Hat Single Sign-On CD 7 public API)

java.lang.Object
- org.keycloak.representations.JsonWebToken

All Implemented Interfaces:

Serializable, Token

Direct Known Subclasses:

DockerResponseToken, IDToken, PermissionTicketToken, TokenIntrospectionResponse
```
public class JsonWebToken
extends Object
implements Serializable, Token
```
Version:

$Revision: 1 $

Author:

Bill Burke

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String[]`	`audience`
`protected int`	`expiration`
`protected String`	`id`
`protected int`	`issuedAt`
`String`	`issuedFor`
`protected String`	`issuer`
`protected int`	`notBefore`
`protected Map<String,Object>`	`otherClaims`
`protected String`	`subject`
`protected String`	`type`

Constructor Summary

Constructors
Constructor and Description

JsonWebToken()

Constructors
Constructor and Description
`JsonWebToken()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JsonWebToken`	`addAudience(String audience)`
`JsonWebToken`	`audience(String... audience)`
`JsonWebToken`	`expiration(int expiration)`
`String[]`	`getAudience()`
`TokenCategory`	`getCategory()`
`int`	`getExpiration()`
`String`	`getId()`
`int`	`getIssuedAt()`
`String`	`getIssuedFor()` OAuth client the token was issued for.
`String`	`getIssuer()`
`int`	`getNotBefore()`
`Map<String,Object>`	`getOtherClaims()` This is a map of any other claims and data that might be in the IDToken.
`String`	`getSubject()`
`String`	`getType()`
`boolean`	`hasAudience(String audience)`
`JsonWebToken`	`id(String id)`
`boolean`	`isActive()` Tests that the token is not expired and is not-before.
`boolean`	`isActive(int allowedTimeSkew)`
`boolean`	`isExpired()`
`boolean`	`isNotBefore(int allowedTimeSkew)`
`JsonWebToken`	`issuedAt(int issuedAt)`
`JsonWebToken`	`issuedFor(String issuedFor)`
`JsonWebToken`	`issuedNow()` Set issuedAt to the current time
`JsonWebToken`	`issuer(String issuer)`
`JsonWebToken`	`notBefore(int notBefore)`
`void`	`setOtherClaims(String name, Object value)`
`void`	`setSubject(String subject)`
`JsonWebToken`	`subject(String subject)`
`JsonWebToken`	`type(String type)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id
```
protected String id
```

expiration
```
protected int expiration
```

notBefore
```
protected int notBefore
```

issuedAt
```
protected int issuedAt
```

issuer
```
protected String issuer
```

audience
```
protected String[] audience
```

subject
```
protected String subject
```

type
```
protected String type
```

issuedFor
```
public String issuedFor
```

otherClaims

protected Map<String,Object> otherClaims

Constructor Detail
- JsonWebToken
```
public JsonWebToken()
```

Method Detail

getId
```
public String getId()
```

id
```
public JsonWebToken id(String id)
```

getExpiration
```
public int getExpiration()
```

expiration

public JsonWebToken expiration(int expiration)

isExpired
```
public boolean isExpired()
```

getNotBefore
```
public int getNotBefore()
```

notBefore

public JsonWebToken notBefore(int notBefore)

isNotBefore

public boolean isNotBefore(int allowedTimeSkew)

isActive
```
public boolean isActive()
```
Tests that the token is not expired and is not-before.

Returns:

isActive

public boolean isActive(int allowedTimeSkew)

getIssuedAt
```
public int getIssuedAt()
```

issuedNow
```
public JsonWebToken issuedNow()
```
Set issuedAt to the current time

issuedAt

public JsonWebToken issuedAt(int issuedAt)

getIssuer
```
public String getIssuer()
```

issuer

public JsonWebToken issuer(String issuer)

getAudience
```
public String[] getAudience()
```

hasAudience

public boolean hasAudience(String audience)

audience

public JsonWebToken audience(String... audience)

addAudience

public JsonWebToken addAudience(String audience)

getSubject
```
public String getSubject()
```

subject

public JsonWebToken subject(String subject)

setSubject

public void setSubject(String subject)

getType
```
public String getType()
```

type

public JsonWebToken type(String type)

getIssuedFor
```
public String getIssuedFor()
```
OAuth client the token was issued for.

Returns:

issuedFor

public JsonWebToken issuedFor(String issuedFor)

getOtherClaims
```
public Map<String,Object> getOtherClaims()
```
This is a map of any other claims and data that might be in the IDToken. Could be custom claims set up by the auth server

Returns:

setOtherClaims

public void setOtherClaims(String name,
                           Object value)

getCategory
```
public TokenCategory getCategory()
```
Specified by:

getCategory in interface Token

Class JsonWebToken

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

expiration

notBefore

issuedAt

issuer

audience

subject

type

issuedFor

otherClaims

Constructor Detail

JsonWebToken

Method Detail

getId

id

getExpiration

expiration

isExpired

getNotBefore

notBefore

isNotBefore

isActive

isActive

getIssuedAt

issuedNow

issuedAt

getIssuer

issuer

getAudience

hasAudience

audience

addAudience

getSubject

subject

setSubject

getType

type

getIssuedFor

issuedFor

getOtherClaims

setOtherClaims

getCategory