Package io.objectbox.sync

Class SyncCredentials

java.lang.Object

io.objectbox.sync.SyncCredentials

Direct Known Subclasses:

SyncCredentialsToken, SyncCredentialsUserPassword

public abstract class SyncCredentials
extends Object

Use the static helper methods to build Sync credentials, for example SyncCredentials.sharedSecret("secret").

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SyncCredentials.CredentialsType

Field Summary

Fields

Modifier and Type	Field	Description
private final SyncCredentials.CredentialsType	type

Constructor Summary

Constructors

Constructor	Description
SyncCredentials(SyncCredentials.CredentialsType type)

Method Summary

Modifier and Type	Method	Description
(package private) abstract SyncCredentials	createClone()	Creates a copy of these credentials.
SyncCredentials.CredentialsType	getType()
long	getTypeId()
static SyncCredentials	google(String idToken)	Authenticate with a Google account ID token obtained via Google Sign-In.
static SyncCredentials	jwtAccessToken(String jwtAccessToken)	JSON Web Token (JWT): an access token that is used to access resources.
static SyncCredentials	jwtCustomToken(String jwtCustomToken)	JSON Web Token (JWT): a token that is neither an ID, access, nor refresh token.
static SyncCredentials	jwtIdToken(String jwtIdToken)	JSON Web Token (JWT): an ID token that typically provides identity information about the authenticated user.
static SyncCredentials	jwtRefreshToken(String jwtRefreshToken)	JSON Web Token (JWT): a refresh token that is used to obtain a new access token.
static SyncCredentials	none()	No authentication, unsecured.
static SyncCredentials	obxAdminUser(String user, String password)	ObjectBox admin users (username/password)
static SyncCredentials	sharedSecret(byte[] secret)	Authenticate with a shared secret.
static SyncCredentials	sharedSecret(String secret)	Authenticate with a shared secret.
static SyncCredentials	userAndPassword(String user, String password)	Generic credential type suitable for ObjectBox admin (and possibly others in the future)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

type

private final SyncCredentials.CredentialsType type

Constructor Details

SyncCredentials

SyncCredentials(SyncCredentials.CredentialsType type)

Method Details

sharedSecret

public static SyncCredentials sharedSecret(String secret)

Authenticate with a shared secret. This could be a passphrase, big number or randomly chosen bytes. The string is expected to use UTF-8 characters.

sharedSecret

public static SyncCredentials sharedSecret(byte[] secret)

Authenticate with a shared secret. This could be a passphrase, big number or randomly chosen bytes.

google

public static SyncCredentials google(String idToken)

Authenticate with a Google account ID token obtained via Google Sign-In.

obxAdminUser

public static SyncCredentials obxAdminUser(String user,
 String password)

ObjectBox admin users (username/password)

userAndPassword

public static SyncCredentials userAndPassword(String user,
 String password)

Generic credential type suitable for ObjectBox admin (and possibly others in the future)

jwtIdToken

public static SyncCredentials jwtIdToken(String jwtIdToken)

JSON Web Token (JWT): an ID token that typically provides identity information about the authenticated user.

jwtAccessToken

public static SyncCredentials jwtAccessToken(String jwtAccessToken)

JSON Web Token (JWT): an access token that is used to access resources.

jwtRefreshToken

public static SyncCredentials jwtRefreshToken(String jwtRefreshToken)

JSON Web Token (JWT): a refresh token that is used to obtain a new access token.

jwtCustomToken

public static SyncCredentials jwtCustomToken(String jwtCustomToken)

JSON Web Token (JWT): a token that is neither an ID, access, nor refresh token.

none

public static SyncCredentials none()

No authentication, unsecured. Use only for development and testing purposes.

getType

public SyncCredentials.CredentialsType getType()

getTypeId

public long getTypeId()

createClone

abstract SyncCredentials createClone()

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.