TokenService (UI Server Platform Chassis for Spring 3.11 API)

java.lang.Object
- org.odpi.openmetadata.userinterface.uichassis.springboot.auth.RoleService
- - org.odpi.openmetadata.userinterface.uichassis.springboot.auth.TokenService

Direct Known Subclasses:

RedisAuthService, SessionAuthService, TokenAuthService
```
public class TokenService
extends RoleService
```

Field Summary

Fields
Modifier and Type Field Description

protected String tokenSecret

protected Long tokenTimeout
token timout in minutes

Constructor Summary

Constructors
Constructor Description

TokenService()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`createTokenForUser(TokenUser user, String secret)`
`TokenUser`	`fromJSON(String userJSON)`
`long`	`getTokenTimeout()`
`TokenUser`	`parseUserFromToken(String token, String secret)`
`String`	`toJSON(Object obj)`

Methods inherited from class org.odpi.openmetadata.userinterface.uichassis.springboot.auth.RoleService
extractUserAppRoles, getVisibleComponents

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

Field Detail

tokenSecret

@Value("${token.secret}")
protected String tokenSecret

tokenTimeout

@Value("${token.timeout:30}")
protected Long tokenTimeout

token timout in minutes

Constructor Detail
- TokenService
```
public TokenService()
```

Method Detail
- getTokenTimeout
```
public long getTokenTimeout()
```
  Returns:
  
  token timeout in milliseconds
- toJSON
```
public String toJSON(Object obj)
```
  Parameters:
  
  obj - the object to be serialized
  
  Returns:
  
  the json string representing TokenUser
- createTokenForUser
```
public String createTokenForUser(TokenUser user,
                                 String secret)
```
  Parameters:
  
  user - the user to create token for
  
  secret - the secret for signature
  
  Returns:
  
  jwt token
- parseUserFromToken
```
public TokenUser parseUserFromToken(String token,
                                    String secret)
```
  Parameters:
  
  token - the encoded token
  
  secret - secret phrase to decode
  
  Returns:
  
  parsed TokenUser
- fromJSON
```
public TokenUser fromJSON(String userJSON)
```
  Parameters:
  
  userJSON - representation of the TokenUser
  
  Returns:
  
  the TokenUser