Package io.quarkiverse.openfga.deployment

Class DevServicesOpenFGAConfig

  • public class DevServicesOpenFGAConfig
extends Object

    • Field Detail

      • enabled

        @ConfigItem
public Optional<Boolean> enabled
        If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.

        When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in 'dev' or 'test' mode.

      • imageName

        @ConfigItem
public Optional<String> imageName
        The container image name to use, for container based DevServices providers.

      • shared

        @ConfigItem(defaultValue="true")
public boolean shared
        Indicates if the OpenFGA instance managed by Quarkus DevServices is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, DevServices for OpenFGA starts a new container.

        The discovery uses the quarkus-dev-service-openfga label. The value is configured using the service-name property.

        Container sharing is only used in 'dev' mode.

      • serviceName

        @ConfigItem(defaultValue="openfga")
public String serviceName
        The value of the quarkus-dev-service-openfga label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, DevServices for OpenFGA looks for a container with the quarkus-dev-service-openfga label set to the configured value. If found, it will use this container instead of starting a new one, otherwise it starts a new container with the quarkus-dev-service-openfga label set to the specified value.

        This property is used when you need multiple shared OpenFGA instances.

      • httpPort

        @ConfigItem
public OptionalInt httpPort
        Optional fixed port the HTTP service will be bound to.

        If not defined, the port will be chosen randomly.

      • grpcPort

        @ConfigItem
public OptionalInt grpcPort
        Optional fixed port the gRPC service will be bound to.

        If not defined, the port will be chosen randomly.

      • playgroundPort

        @ConfigItem
public OptionalInt playgroundPort
        Optional fixed port the Playground service will be bound to.

        If not defined, the port will be chosen randomly.

      • storeName

        @ConfigItem(defaultValue="dev")
public String storeName
        Name of authorization store to create for DevServices.

        Defaults to "dev".

      • authorizationModel

        @ConfigItem
public Optional<String> authorizationModel
        JSON formatted authorization model to upload during DevServices initialization.

      • authorizationModelLocation

        @ConfigItem
public Optional<String> authorizationModelLocation
        Location of JSON formatted authorization model file to upload during DevServices initialization.

        The location can be prefixed with classpath: or filesystem: to specify where the file will be read from; if not prefixed, it will be read from the classpath.

      • authorizationTuples

        @ConfigItem
public Optional<String> authorizationTuples
        JSON formatted authorization tuples to upload during DevServices initialization.

      • authorizationTuplesLocation

        @ConfigItem
public Optional<String> authorizationTuplesLocation
        Location of JSON formatted authorization tuples file to upload during DevServices initialization.

        The location can be prefixed with classpath: or filesystem: to specify where the file will be read from; if not prefixed, it will be read from the classpath.

    • Constructor Detail

      • DevServicesOpenFGAConfig

        public DevServicesOpenFGAConfig()