SdaPlatformBundle.InitialBuilder (sda-commons-starter 2.43.4 API)

java.lang.Object
- org.sdase.commons.starter.SdaPlatformBundle.InitialBuilder<C>

All Implemented Interfaces:

CorsCustomizer<C>, CustomConfigurationProviders.AuthConfigProviderBuilder<C>, CustomConfigurationProviders.CorsConfigProviderBuilder<C>, InitialPlatformBundleBuilder, JacksonCustomizer<C>, OpenApiCustomizer.OpenApiFinalBuilder<C>, OpenApiCustomizer.OpenApiInitialBuilder<C>, PlatformBundleBuilder<C>, SecurityCustomizer<C>

Enclosing class:

SdaPlatformBundle<C extends io.dropwizard.Configuration>
```
public static class SdaPlatformBundle.InitialBuilder<C extends io.dropwizard.Configuration>
extends java.lang.Object
implements InitialPlatformBundleBuilder, CustomConfigurationProviders.AuthConfigProviderBuilder<C>, CustomConfigurationProviders.CorsConfigProviderBuilder<C>, OpenApiCustomizer.OpenApiInitialBuilder<C>, OpenApiCustomizer.OpenApiFinalBuilder<C>, PlatformBundleBuilder<C>
```

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OpenApiCustomizer.OpenApiFinalBuilder<C>`	`addOpenApiResourcePackage(java.lang.String resourcePackage)` Adds a package to the packages Swagger should scan to pick up resources.
`OpenApiCustomizer.OpenApiFinalBuilder<C>`	`addOpenApiResourcePackageClass(java.lang.Class<?> swaggerResourcePackage)` Adds the package of the given class to the packages Swagger should scan to pick up resources.
`PlatformBundleBuilder<C>`	`alwaysWriteZonedDateTimeWithMillisInJson()` Registers a default serializer for `ZonedDateTime` that renders 3 digits of milliseconds.
`PlatformBundleBuilder<C>`	`alwaysWriteZonedDateTimeWithoutMillisInJson()` Registers a default serializer for `ZonedDateTime` that renders no milliseconds.
`SdaPlatformBundle<C>`	`build()` Builds the configured `SdaPlatformBundle` which must be added to the `Bootstrap` in `Application.initialize(Bootstrap)`.
`PlatformBundleBuilder<C>`	`disableBufferLimitValidationSecurityFeature()` Switches from suppressing the application start to a warn logging for violated buffer limits.
`<T extends io.dropwizard.Configuration> CustomConfigurationProviders.AuthConfigProviderBuilder<T>`	`usingCustomConfig(java.lang.Class<T> configurationClass)` Start an application that uses a custom configuration has to define providers for the configurations required by the `SdaPlatformBundle`.
`OpenApiCustomizer.OpenApiInitialBuilder<SdaPlatformConfiguration>`	`usingSdaPlatformConfiguration()` Start an application that uses the `SdaPlatformConfiguration` as base of it's configuration file.
`<T extends SdaPlatformConfiguration> OpenApiCustomizer.OpenApiInitialBuilder<T>`	`usingSdaPlatformConfiguration(java.lang.Class<T> configurationClass)` Start an application that uses a customized configuration which extends the `SdaPlatformConfiguration` as base of it's configuration file.
`CustomConfigurationProviders.CorsConfigProviderBuilder<C>`	`withAuthConfigProvider(org.sdase.commons.server.auth.config.AuthConfigProvider<C> authConfigProvider)` Enables authentication (i.e.
`PlatformBundleBuilder<C>`	`withCorsAdditionalAllowedHeaders(java.lang.String... additionalAllowedHeaders)` Defines additional HTTP headers that clients may send to the application.
`PlatformBundleBuilder<C>`	`withCorsAdditionalExposedHeaders(java.lang.String... additionalExposedHeaders)` Defines additional HTTP headers that can be exposed to clients.
`PlatformBundleBuilder<C>`	`withCorsAllowedMethods(java.lang.String... httpMethods)` Defines the HTTP methods that are used in the application and should be allowed for cross origin clients.
`OpenApiCustomizer.OpenApiInitialBuilder<C>`	`withCorsConfigProvider(org.sdase.commons.server.cors.CorsConfigProvider<C> corsConfigProvider)`
`OpenApiCustomizer.OpenApiFinalBuilder<C>`	`withExistingOpenAPI(java.lang.String openApiJsonOrYaml)` Use an existing OpenAPI 3 specification as base for the generation.
`OpenApiCustomizer.OpenApiFinalBuilder<C>`	`withExistingOpenAPIFromClasspathResource(java.lang.String path)` Reads an existing OpenAPI 3 specification from the given classpath resource and provide it to `OpenApiCustomizer.OpenApiInitialBuilder.withExistingOpenAPI(String)`
`PlatformBundleBuilder<C>`	`withObjectMapperCustomization(java.util.function.Consumer<com.fasterxml.jackson.databind.ObjectMapper> customizer)` Allows customization of the used `ObjectMapper`.
`CustomConfigurationProviders.CorsConfigProviderBuilder<C>`	`withOpaAuthorization(org.sdase.commons.server.auth.config.AuthConfigProvider<C> authConfigProvider, org.sdase.commons.server.opa.config.OpaConfigProvider<C> opaConfigProvider)` Enables authentication (i.e.
`CustomConfigurationProviders.CorsConfigProviderBuilder<C>`	`withoutAuthentication()` Disable authentication entirely.
`OpenApiCustomizer.OpenApiInitialBuilder<C>`	`withoutCorsSupport()` Disable CORS support.
`PlatformBundleBuilder<C>`	`withoutFieldFilter()` Disables the field filter entirely.
`PlatformBundleBuilder<C>`	`withoutHalSupport()` Skips registration of the HAL module.

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

- Method Detail
  - build
```
public SdaPlatformBundle<C> build()
```
    Description copied from interface: PlatformBundleBuilder
    
    Builds the configured SdaPlatformBundle which must be added to the Bootstrap in Application.initialize(Bootstrap).
    
    Specified by:
    
    build in interface PlatformBundleBuilder<C extends io.dropwizard.Configuration>
    
    Returns:
    
    the configured SdaPlatformBundle
  - usingSdaPlatformConfiguration
```
public OpenApiCustomizer.OpenApiInitialBuilder<SdaPlatformConfiguration> usingSdaPlatformConfiguration()
```
    Description copied from interface: InitialPlatformBundleBuilder
    
    Start an application that uses the SdaPlatformConfiguration as base of it's configuration file.
    
    Specified by:
    
    usingSdaPlatformConfiguration in interface InitialPlatformBundleBuilder
    
    Returns:
    
    the builder instance
  - usingSdaPlatformConfiguration
```
public <T extends SdaPlatformConfiguration> OpenApiCustomizer.OpenApiInitialBuilder<T> usingSdaPlatformConfiguration(java.lang.Class<T> configurationClass)
```
    Description copied from interface: InitialPlatformBundleBuilder
    
    Start an application that uses a customized configuration which extends the SdaPlatformConfiguration as base of it's configuration file.
    The method automatically enables OPA authorization and sets therefore the authorization configuration via CustomConfigurationProviders.AuthConfigProviderBuilder.withOpaAuthorization(AuthConfigProvider, OpaConfigProvider) and the cors configuration via CustomConfigurationProviders.CorsConfigProviderBuilder.withCorsConfigProvider(CorsConfigProvider)
    
    Specified by:
    
    usingSdaPlatformConfiguration in interface InitialPlatformBundleBuilder
    
    Parameters:
    
    configurationClass - - the customized configuration of the application
    
    Returns:
    
    the builder instance
  - usingCustomConfig
```
public <T extends io.dropwizard.Configuration> CustomConfigurationProviders.AuthConfigProviderBuilder<T> usingCustomConfig(java.lang.Class<T> configurationClass)
```
    Description copied from interface: InitialPlatformBundleBuilder
    
    Start an application that uses a custom configuration has to define providers for the configurations required by the SdaPlatformBundle.
    
    Specified by:
    
    usingCustomConfig in interface InitialPlatformBundleBuilder
    
    Type Parameters:
    
    T - the type of the applications configuration class
    
    Parameters:
    
    configurationClass - the class that stores the configuration
    
    Returns:
    
    the builder instance
  - withoutAuthentication
```
public CustomConfigurationProviders.CorsConfigProviderBuilder<C> withoutAuthentication()
```
    Description copied from interface: CustomConfigurationProviders.AuthConfigProviderBuilder
    
    Disable authentication entirely.
    
    Specified by:
    
    withoutAuthentication in interface CustomConfigurationProviders.AuthConfigProviderBuilder<C extends io.dropwizard.Configuration>
    
    Returns:
    
    the builder instance
  - withAuthConfigProvider
```
public CustomConfigurationProviders.CorsConfigProviderBuilder<C> withAuthConfigProvider(org.sdase.commons.server.auth.config.AuthConfigProvider<C> authConfigProvider)
```
    Description copied from interface: CustomConfigurationProviders.AuthConfigProviderBuilder
    
    Enables authentication (i.e. token validation) for annotated endpoints and requires tokens
    
    Specified by:
    
    withAuthConfigProvider in interface CustomConfigurationProviders.AuthConfigProviderBuilder<C extends io.dropwizard.Configuration>
    
    Parameters:
    
    authConfigProvider - a provider, for the AuthConfig, e.g. MyAppConfig::getAuth
    
    Returns:
    
    the builder instance
  - withOpaAuthorization
```
public CustomConfigurationProviders.CorsConfigProviderBuilder<C> withOpaAuthorization(org.sdase.commons.server.auth.config.AuthConfigProvider<C> authConfigProvider,
                                                                                      org.sdase.commons.server.opa.config.OpaConfigProvider<C> opaConfigProvider)
```
    Description copied from interface: CustomConfigurationProviders.AuthConfigProviderBuilder
    
    Enables authentication (i.e. token validation) for all endpoints and use the OpaBundle to authorize the requests. Requests without Authorization header will not be rejected but need to be handled in the Authorization policy.
    
    Specified by:
    
    withOpaAuthorization in interface CustomConfigurationProviders.AuthConfigProviderBuilder<C extends io.dropwizard.Configuration>
    
    Parameters:
    
    authConfigProvider - a provider, for the AuthConfig, e.g. MyAppConfig::getAuth
    
    opaConfigProvider - a provider, for the OpaConfig, e.g. MyAppConfig::getOpa
    
    Returns:
    
    the builder instance
  - withoutCorsSupport
```
public OpenApiCustomizer.OpenApiInitialBuilder<C> withoutCorsSupport()
```
    Description copied from interface: CustomConfigurationProviders.CorsConfigProviderBuilder
    
    Disable CORS support. Browsers are not allowed to access the application from a foreign domain.
    
    Specified by:
    
    withoutCorsSupport in interface CustomConfigurationProviders.CorsConfigProviderBuilder<C extends io.dropwizard.Configuration>
    
    Returns:
    
    the builder instance
  - withCorsConfigProvider
```
public OpenApiCustomizer.OpenApiInitialBuilder<C> withCorsConfigProvider(org.sdase.commons.server.cors.CorsConfigProvider<C> corsConfigProvider)
```
    Specified by:
    
    withCorsConfigProvider in interface CustomConfigurationProviders.CorsConfigProviderBuilder<C extends io.dropwizard.Configuration>
    
    Parameters:
    
    corsConfigProvider - a provider, for the CorsConfiguration, e.g. MyAppConfig::getCors
    
    Returns:
    
    the builder instance
  - disableBufferLimitValidationSecurityFeature
```
public PlatformBundleBuilder<C> disableBufferLimitValidationSecurityFeature()
```
    Description copied from interface: SecurityCustomizer
    
    Switches from suppressing the application start to a warn logging for violated buffer limits. In rare cases an application might need to increase the default limits and therefore has to disable strict validation. This option should be used with care.
    
    Specified by:
    
    disableBufferLimitValidationSecurityFeature in interface SecurityCustomizer<C extends io.dropwizard.Configuration>
    
    Returns:
    
    this builder instance
  - withCorsAllowedMethods
```
public PlatformBundleBuilder<C> withCorsAllowedMethods(java.lang.String... httpMethods)
```
    Description copied from interface: CorsCustomizer
    Defines the HTTP methods that are used in the application and should be allowed for cross origin clients. The given httpMethods overwrite the default methods.
    - "PATCH"
    Specified by:
    
    withCorsAllowedMethods in interface CorsCustomizer<C extends io.dropwizard.Configuration>
    
    Parameters:
    
    httpMethods - all HTTP methods that will be allowed by the CORS filter.
    
    Returns:
    
    the same builder instance
  - withCorsAdditionalAllowedHeaders
```
public PlatformBundleBuilder<C> withCorsAdditionalAllowedHeaders(java.lang.String... additionalAllowedHeaders)
```
    Description copied from interface: CorsCustomizer
    
    Defines additional HTTP headers that clients may send to the application. The headers defined in CorsBundle.FinalBuilder#ALWAYS_ALLOWED_HEADERS are always allowed to be send and must not be added here.
    
    Specified by:
    
    withCorsAdditionalAllowedHeaders in interface CorsCustomizer<C extends io.dropwizard.Configuration>
    
    Parameters:
    
    additionalAllowedHeaders - additional HTTP headers that clients may send to the application.
    
    Returns:
    
    the same builder instance
  - withCorsAdditionalExposedHeaders
```
public PlatformBundleBuilder<C> withCorsAdditionalExposedHeaders(java.lang.String... additionalExposedHeaders)
```
    Description copied from interface: CorsCustomizer
    
    Defines additional HTTP headers that can be exposed to clients. The headers defined in CorsBundle.FinalBuilder#ALWAYS_EXPOSED_HEADERS can always be exposed and must not be added here.
    
    Specified by:
    
    withCorsAdditionalExposedHeaders in interface CorsCustomizer<C extends io.dropwizard.Configuration>
    
    Parameters:
    
    additionalExposedHeaders - additional HTTP headers that can be exposed.
    
    Returns:
    
    the same builder instance
  - withoutHalSupport
```
public PlatformBundleBuilder<C> withoutHalSupport()
```
    Description copied from interface: JacksonCustomizer
    
    Skips registration of the HAL module. This may be used when links and embedded resources are not required or are achieved with other tooling.
    
    Specified by:
    
    withoutHalSupport in interface JacksonCustomizer<C extends io.dropwizard.Configuration>
    
    Returns:
    
    the builder
  - withoutFieldFilter
```
public PlatformBundleBuilder<C> withoutFieldFilter()
```
    Description copied from interface: JacksonCustomizer
    
    Disables the field filter entirely. The field filter may be used by clients to request only a subset of the properties of a resource and has to be activated with EnableFieldFilter for each resource.
    
    Specified by:
    
    withoutFieldFilter in interface JacksonCustomizer<C extends io.dropwizard.Configuration>
    
    Returns:
    
    the builder
  - withObjectMapperCustomization
```
public PlatformBundleBuilder<C> withObjectMapperCustomization(java.util.function.Consumer<com.fasterxml.jackson.databind.ObjectMapper> customizer)
```
    Description copied from interface: JacksonCustomizer
    
    Allows customization of the used ObjectMapper. More customizers may be added by calling this method multiple times.
    
    Specified by:
    
    withObjectMapperCustomization in interface JacksonCustomizer<C extends io.dropwizard.Configuration>
    
    Parameters:
    
    customizer - receives the used ObjectMapper for customization, e.g. to enable or disable specific features or configure formatting.
    
    Returns:
    
    the builder
  - alwaysWriteZonedDateTimeWithMillisInJson
```
public PlatformBundleBuilder<C> alwaysWriteZonedDateTimeWithMillisInJson()
```
    Description copied from interface: JacksonCustomizer
    
    Registers a default serializer for ZonedDateTime that renders 3 digits of milliseconds. The same serializer may be configured per field as documented in Iso8601Serializer.WithMillis.
    This setting overwrites the default behaviour of Jackson which omits milliseconds if they are zero or adds nanoseconds if they are set.
    
    Specified by:
    
    alwaysWriteZonedDateTimeWithMillisInJson in interface JacksonCustomizer<C extends io.dropwizard.Configuration>
    
    Returns:
    
    the builder
  - alwaysWriteZonedDateTimeWithoutMillisInJson
```
public PlatformBundleBuilder<C> alwaysWriteZonedDateTimeWithoutMillisInJson()
```
    Description copied from interface: JacksonCustomizer
    
    Registers a default serializer for ZonedDateTime that renders no milliseconds. The same serializer may be configured per field as documented in Iso8601Serializer.
    This setting overwrites the default behaviour of Jackson which omits milliseconds if they are zero or adds nanoseconds if they are set.
    
    Specified by:
    
    alwaysWriteZonedDateTimeWithoutMillisInJson in interface JacksonCustomizer<C extends io.dropwizard.Configuration>
    
    Returns:
    
    the builder
  - withExistingOpenAPI
```
public OpenApiCustomizer.OpenApiFinalBuilder<C> withExistingOpenAPI(java.lang.String openApiJsonOrYaml)
```
    Description copied from interface: OpenApiCustomizer.OpenApiInitialBuilder
    
    Use an existing OpenAPI 3 specification as base for the generation.
    Note that the OpenAPI annotations always override values from the files if classes are registered with OpenApiCustomizer.OpenApiInitialBuilder.addOpenApiResourcePackage(String) or OpenApiCustomizer.OpenApiInitialBuilder.addOpenApiResourcePackageClass(Class).
    
    Specified by:
    
    withExistingOpenAPI in interface OpenApiCustomizer.OpenApiInitialBuilder<C extends io.dropwizard.Configuration>
    
    Parameters:
    
    openApiJsonOrYaml - the OpenAPI 3 specification as json or yaml
    
    Returns:
    
    the builder instance
    
    See Also:
    
    OpenApiBundle.InitialBuilder.withExistingOpenAPI(String)
  - withExistingOpenAPIFromClasspathResource
```
public OpenApiCustomizer.OpenApiFinalBuilder<C> withExistingOpenAPIFromClasspathResource(java.lang.String path)
```
    Description copied from interface: OpenApiCustomizer.OpenApiInitialBuilder
    
    Reads an existing OpenAPI 3 specification from the given classpath resource and provide it to OpenApiCustomizer.OpenApiInitialBuilder.withExistingOpenAPI(String)
    
    Specified by:
    
    withExistingOpenAPIFromClasspathResource in interface OpenApiCustomizer.OpenApiInitialBuilder<C extends io.dropwizard.Configuration>
    
    Parameters:
    
    path - the path to an OpenAPI 3 YAML or JSON file in the classpath.
    
    Returns:
    
    the builder instance
    
    See Also:
    
    OpenApiBundle.InitialBuilder.withExistingOpenAPIFromClasspathResource(String)
  - addOpenApiResourcePackage
```
public OpenApiCustomizer.OpenApiFinalBuilder<C> addOpenApiResourcePackage(java.lang.String resourcePackage)
```
    Description copied from interface: OpenApiCustomizer.OpenApiInitialBuilder
    
    Adds a package to the packages Swagger should scan to pick up resources.
    
    Specified by:
    
    addOpenApiResourcePackage in interface OpenApiCustomizer.OpenApiInitialBuilder<C extends io.dropwizard.Configuration>
    
    Parameters:
    
    resourcePackage - the package to be scanned; not null
    
    Returns:
    
    the builder instance
    
    See Also:
    
    OpenApiBundle.InitialBuilder.addResourcePackage(String)
  - addOpenApiResourcePackageClass
```
public OpenApiCustomizer.OpenApiFinalBuilder<C> addOpenApiResourcePackageClass(java.lang.Class<?> swaggerResourcePackage)
```
    Description copied from interface: OpenApiCustomizer.OpenApiInitialBuilder
    
    Adds the package of the given class to the packages Swagger should scan to pick up resources.
    
    Specified by:
    
    addOpenApiResourcePackageClass in interface OpenApiCustomizer.OpenApiInitialBuilder<C extends io.dropwizard.Configuration>
    
    Parameters:
    
    swaggerResourcePackage - the class whose package should be scanned; not null
    
    Returns:
    
    the builder instance
    
    See Also:
    
    OpenApiBundle.InitialBuilder.addResourcePackageClass(Class)

Class SdaPlatformBundle.InitialBuilder<C extends io.dropwizard.Configuration>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

build

usingSdaPlatformConfiguration

usingSdaPlatformConfiguration

usingCustomConfig

withoutAuthentication

withAuthConfigProvider

withOpaAuthorization

withoutCorsSupport

withCorsConfigProvider

disableBufferLimitValidationSecurityFeature

withCorsAllowedMethods

withCorsAdditionalAllowedHeaders

withCorsAdditionalExposedHeaders

withoutHalSupport

withoutFieldFilter

withObjectMapperCustomization

alwaysWriteZonedDateTimeWithMillisInJson

alwaysWriteZonedDateTimeWithoutMillisInJson

withExistingOpenAPI

withExistingOpenAPIFromClasspathResource

addOpenApiResourcePackage

addOpenApiResourcePackageClass