Package io.quarkiverse.openfga.runtime.config

Class OpenFGAConfig

java.lang.Object

io.quarkiverse.openfga.runtime.config.OpenFGAConfig

@ConfigRoot(name="openfga",
            phase=RUN_TIME)
public class OpenFGAConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
boolean	alwaysResolveStoreId	Always Treat store as the name of a store and resolve the store id at runtime.
Optional<String>	authorizationModelId	Authorization model id for default AuthorizationModelClient bean.
Duration	connectTimeout	Timeout to establish a connection with OpenFGA.
static String	DEFAULT_CONNECT_TIMEOUT
static String	DEFAULT_READ_TIMEOUT
static String	NAME
Optional<List<String>>	nonProxyHosts	List of remote hosts that are not proxied when the client is configured to use a proxy.
Duration	readTimeout	Request timeout on OpenFGA.
Optional<String>	sharedKey	Shared authentication key.
String	store	Store id or name for default StoreClient bean.
OpenFGATLSConfig	tls	TLS configuration.
URL	url	OpenFGA server URL.

Constructor Summary

Constructors

Constructor	Description
OpenFGAConfig()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

DEFAULT_CONNECT_TIMEOUT

public static final String DEFAULT_CONNECT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_READ_TIMEOUT

public static final String DEFAULT_READ_TIMEOUT

See Also:

Constant Field Values

url

@ConfigItem
public URL url

OpenFGA server URL.

Example: http://openfga:8080

sharedKey

@ConfigItem
public Optional<String> sharedKey

Shared authentication key.

If none provided unauthenticated access will be attempted.

store

@ConfigItem
public String store

Store id or name for default StoreClient bean.

If the provided property does not match the OpenFGA store id format (^[ABCDEFGHJKMNPQRSTVWXYZ0-9]{26}$) it will be treated as a store name and a matching store id will be resolved at runtime.

See Also:

alwaysResolveStoreId

alwaysResolveStoreId

@ConfigItem(defaultValue="false")
public boolean alwaysResolveStoreId

Always Treat store as the name of a store and resolve the store id at runtime.

If true, the store id will always be resolved at runtime regardless of the format of the store property. Otherwise, the store id will be resolved only when store does not match the OpenFGA store id format.

See Also:

store

authorizationModelId

@ConfigItem
public Optional<String> authorizationModelId

Authorization model id for default AuthorizationModelClient bean.

If none is provided the default bean will target the default authorization model for the store.

tls

@ConfigItem
@ConfigDocSection
public OpenFGATLSConfig tls

TLS configuration.

connectTimeout

@ConfigItem(defaultValue="5S")
public Duration connectTimeout

Timeout to establish a connection with OpenFGA.

readTimeout

@ConfigItem(defaultValue="5S")
public Duration readTimeout

Request timeout on OpenFGA.

nonProxyHosts

@ConfigItem
public Optional<List<String>> nonProxyHosts

List of remote hosts that are not proxied when the client is configured to use a proxy. This list serves the same purpose as the JVM nonProxyHosts configuration.

Entries can use the * wildcard character for pattern matching, e.g *.example.com matches www.example.com.

Constructor Detail

OpenFGAConfig

public OpenFGAConfig()