SyncCredentialsToken

java.lang.Object
- io.objectbox.sync.SyncCredentials
- - io.objectbox.sync.SyncCredentialsToken

@Internal
public final class SyncCredentialsToken
extends SyncCredentials

Internal credentials implementation. Use SyncCredentials to build credentials.

Nested Class Summary
- Nested classes/interfaces inherited from class io.objectbox.sync.SyncCredentials
  SyncCredentials.CredentialsType

Field Summary

Fields
Modifier and Type Field Description

private boolean cleared

private byte[] token

Constructor Summary

Constructors
Constructor	Description
`SyncCredentialsToken(SyncCredentials.CredentialsType type)`
`SyncCredentialsToken(SyncCredentials.CredentialsType type, byte[] token)`
`SyncCredentialsToken(SyncCredentials.CredentialsType type, java.lang.String token)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`	Clear after usage.
`(package private) SyncCredentialsToken`	`createClone()`	Creates a copy of these credentials.
`byte[]`	`getTokenBytes()`

Methods inherited from class io.objectbox.sync.SyncCredentials
getType, getTypeId, google, jwtAccessToken, jwtCustomToken, jwtIdToken, jwtRefreshToken, none, obxAdminUser, sharedSecret, sharedSecret, userAndPassword

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

- Field Detail
  - token
```
@Nullable
private byte[] token
```
  - cleared
```
private volatile boolean cleared
```
- Constructor Detail
  - SyncCredentialsToken
```
SyncCredentialsToken(SyncCredentials.CredentialsType type)
```
  - SyncCredentialsToken
```
SyncCredentialsToken(SyncCredentials.CredentialsType type,
                     byte[] token)
```
  - SyncCredentialsToken
```
SyncCredentialsToken(SyncCredentials.CredentialsType type,
                     java.lang.String token)
```
- Method Detail
  - getTokenBytes
```
@Nullable
public byte[] getTokenBytes()
```
  - clear
```
public void clear()
```
    Clear after usage.
    Note that when the token is passed as a String, that String is removed from memory at the earliest with the next garbage collector run.
    Also note that while the token is removed from the Java heap, it is present on the native heap of the Sync component using it.
  - createClone
```
SyncCredentialsToken createClone()
```
    Description copied from class: SyncCredentials
    
    Creates a copy of these credentials.
    This can be useful to use the same credentials when creating multiple clients or a server in combination with a client as some credentials may get cleared when building a client or server.
    
    Specified by:
    
    createClone in class SyncCredentials