Package io.apicurio.registry.resolver
Class SchemaResolverConfig
- java.lang.Object
-
- io.apicurio.registry.resolver.SchemaResolverConfig
-
public class SchemaResolverConfig extends Object
Contains theDefaultSchemaResolverconfiguration properties.- Author:
- eric.wittmann@gmail.com, Fabian Martinez
-
-
Field Summary
Fields Modifier and Type Field Description static StringARTIFACT_RESOLVER_STRATEGYFully qualified Java classname of a class that implementsArtifactReferenceResolverStrategyand is responsible for mapping between the Record being resolved and an artifactId.static StringARTIFACT_RESOLVER_STRATEGY_DEFAULTUses the ArtifactReference available for each record.static StringAUTH_CLIENT_IDThe Client Id of the Auth Service.static StringAUTH_CLIENT_SECRETThe Secret of the Auth Service.static StringAUTH_PASSWORDThe Password of the Auth Service.static StringAUTH_REALMThe Realm of the Auth Service.static StringAUTH_SERVICE_URLThe URL of the Auth Service.static StringAUTH_SERVICE_URL_TOKEN_ENDPOINTstatic StringAUTH_TOKEN_ENDPOINTThe URL of the Token Endpoint.static StringAUTH_USERNAMEThe Username of the Auth Service.static StringAUTO_REGISTER_ARTIFACTOptional, boolean to indicate whether serializer classes should attempt to create an artifact in the registry.static booleanAUTO_REGISTER_ARTIFACT_DEFAULTstatic StringAUTO_REGISTER_ARTIFACT_IF_EXISTSOptional, one ofIfExiststo indicate the behavior of the client when there is a conflict creating an artifact because the artifact already exists.static StringAUTO_REGISTER_ARTIFACT_IF_EXISTS_DEFAULTstatic StringCHECK_PERIOD_MSIndicates how long to cache artifacts before auto-eviction.static longCHECK_PERIOD_MS_DEFAULTstatic StringDEREFERENCE_SCHEMAUsed to indicate the auto-register feature to try to dereference the schema before registering it in Registry.static booleanDEREFERENCE_SCHEMA_DEFAULTstatic StringEXPLICIT_ARTIFACT_GROUP_IDOnly applicable for serializers Optional, set explicitly the groupId used for querying/creating an artifact.static StringEXPLICIT_ARTIFACT_IDOnly applicable for serializers Optional, set explicitly the artifactId used for querying/creating an artifact.static StringEXPLICIT_ARTIFACT_VERSIONOnly applicable for serializers Optional, set explicitly the version used for querying/creating an artifact.static StringFIND_LATEST_ARTIFACTOptional, boolean to indicate whether serializer classes should attempt to find the latest artifact in the registry for the corresponding groupId/artifactId.static booleanFIND_LATEST_ARTIFACT_DEFAULTstatic StringREGISTRY_URLThe URL of the Apicurio Registry.static StringREQUEST_HEADERS_PREFIXConfig prefix that allows configuration of arbitrary HTTP client request headers used by the Registry REST Client in the serde class when communicating with the Registry.static StringREQUEST_KEY_PASSWORDKey password used when e.g.static StringREQUEST_KEYSTORE_LOCATIONLocation of a keystore to use when e.g.static StringREQUEST_KEYSTORE_PASSWORDPassword of the keystore to use when e.g.static StringREQUEST_KEYSTORE_TYPEType of keystore to use when e.g.static StringREQUEST_TRUSTSTORE_LOCATIONLocation of a trust store to use when connecting to the registry via SSL.static StringREQUEST_TRUSTSTORE_PASSWORDPassword of the trust store to use when connecting to the registry via SSL.static StringREQUEST_TRUSTSTORE_TYPEType of trust store to use when connecting to the registry via SSL.static StringRETRY_BACKOFF_MSIf a schema can not be be retrieved from the Registry, serdes may retry a number of times.static longRETRY_BACKOFF_MS_DEFAULTstatic StringRETRY_COUNTIf a schema can not be retrieved from the Registry, serdes may retry a number of times.static longRETRY_COUNT_DEFAULT
-
Constructor Summary
Constructors Constructor Description SchemaResolverConfig()
-
-
-
Field Detail
-
ARTIFACT_RESOLVER_STRATEGY
public static final String ARTIFACT_RESOLVER_STRATEGY
Fully qualified Java classname of a class that implementsArtifactReferenceResolverStrategyand is responsible for mapping between the Record being resolved and an artifactId. For example there is a strategy to use the topic name as the schema's artifactId. Only used bySchemaResolver.resolveSchema(io.apicurio.registry.resolver.data.Record)- See Also:
- Constant Field Values
-
ARTIFACT_RESOLVER_STRATEGY_DEFAULT
public static final String ARTIFACT_RESOLVER_STRATEGY_DEFAULT
Uses the ArtifactReference available for each record. RequiresMetadata.artifactReference()to be set. Note this default artifact resolver strategy differs in behavior from the classic Kafka serdes ArtifactResolverStrategy
-
AUTO_REGISTER_ARTIFACT
public static final String AUTO_REGISTER_ARTIFACT
Optional, boolean to indicate whether serializer classes should attempt to create an artifact in the registry. Note: JsonSchema serializer does not support this feature yet.- See Also:
- Constant Field Values
-
AUTO_REGISTER_ARTIFACT_DEFAULT
public static final boolean AUTO_REGISTER_ARTIFACT_DEFAULT
- See Also:
- Constant Field Values
-
AUTO_REGISTER_ARTIFACT_IF_EXISTS
public static final String AUTO_REGISTER_ARTIFACT_IF_EXISTS
Optional, one ofIfExiststo indicate the behavior of the client when there is a conflict creating an artifact because the artifact already exists.- See Also:
- Constant Field Values
-
AUTO_REGISTER_ARTIFACT_IF_EXISTS_DEFAULT
public static final String AUTO_REGISTER_ARTIFACT_IF_EXISTS_DEFAULT
-
FIND_LATEST_ARTIFACT
public static final String FIND_LATEST_ARTIFACT
Optional, boolean to indicate whether serializer classes should attempt to find the latest artifact in the registry for the corresponding groupId/artifactId. GroupId and artifactId are configured either viaArtifactReferenceResolverStrategyor via config properties such asEXPLICIT_ARTIFACT_ID.- See Also:
- Constant Field Values
-
FIND_LATEST_ARTIFACT_DEFAULT
public static final boolean FIND_LATEST_ARTIFACT_DEFAULT
- See Also:
- Constant Field Values
-
EXPLICIT_ARTIFACT_GROUP_ID
public static final String EXPLICIT_ARTIFACT_GROUP_ID
Only applicable for serializers Optional, set explicitly the groupId used for querying/creating an artifact. Overrides the groupId returned by theArtifactReferenceResolverStrategy- See Also:
- Constant Field Values
-
EXPLICIT_ARTIFACT_ID
public static final String EXPLICIT_ARTIFACT_ID
Only applicable for serializers Optional, set explicitly the artifactId used for querying/creating an artifact. Overrides the artifactId returned by theArtifactReferenceResolverStrategy- See Also:
- Constant Field Values
-
EXPLICIT_ARTIFACT_VERSION
public static final String EXPLICIT_ARTIFACT_VERSION
Only applicable for serializers Optional, set explicitly the version used for querying/creating an artifact. Overrides the version returned by theArtifactReferenceResolverStrategy- See Also:
- Constant Field Values
-
REGISTRY_URL
public static final String REGISTRY_URL
The URL of the Apicurio Registry. Required when using any Apicurio Registry serde class (serializer or deserializer).- See Also:
- Constant Field Values
-
AUTH_TOKEN_ENDPOINT
public static final String AUTH_TOKEN_ENDPOINT
The URL of the Token Endpoint. Required when using any Apicurio Registry serde class (serializer or deserializer) against a secured Apicurio Registry and AUTH_SERVICE_URL is not specified.- See Also:
- Constant Field Values
-
AUTH_SERVICE_URL
public static final String AUTH_SERVICE_URL
The URL of the Auth Service. Required when using any Apicurio Registry serde class (serializer or deserializer) against a secured Apicurio Registry.- See Also:
- Constant Field Values
-
AUTH_SERVICE_URL_TOKEN_ENDPOINT
public static final String AUTH_SERVICE_URL_TOKEN_ENDPOINT
- See Also:
- Constant Field Values
-
AUTH_REALM
public static final String AUTH_REALM
The Realm of the Auth Service.- See Also:
- Constant Field Values
-
AUTH_CLIENT_ID
public static final String AUTH_CLIENT_ID
The Client Id of the Auth Service.- See Also:
- Constant Field Values
-
AUTH_CLIENT_SECRET
public static final String AUTH_CLIENT_SECRET
The Secret of the Auth Service.- See Also:
- Constant Field Values
-
AUTH_USERNAME
public static final String AUTH_USERNAME
The Username of the Auth Service.- See Also:
- Constant Field Values
-
AUTH_PASSWORD
public static final String AUTH_PASSWORD
The Password of the Auth Service.- See Also:
- Constant Field Values
-
CHECK_PERIOD_MS
public static final String CHECK_PERIOD_MS
Indicates how long to cache artifacts before auto-eviction. If not included, the artifact will be fetched every time.- See Also:
- Constant Field Values
-
CHECK_PERIOD_MS_DEFAULT
public static final long CHECK_PERIOD_MS_DEFAULT
- See Also:
- Constant Field Values
-
RETRY_COUNT
public static final String RETRY_COUNT
If a schema can not be retrieved from the Registry, serdes may retry a number of times. This configuration option controls the number of retries before failing. Valid values are non-negative integers.- See Also:
- Constant Field Values
-
RETRY_COUNT_DEFAULT
public static final long RETRY_COUNT_DEFAULT
- See Also:
- Constant Field Values
-
RETRY_BACKOFF_MS
public static final String RETRY_BACKOFF_MS
If a schema can not be be retrieved from the Registry, serdes may retry a number of times. This configuration option controls the delay between the retry attempts, in milliseconds. Valid values are non-negative integers.- See Also:
- Constant Field Values
-
RETRY_BACKOFF_MS_DEFAULT
public static final long RETRY_BACKOFF_MS_DEFAULT
- See Also:
- Constant Field Values
-
REQUEST_HEADERS_PREFIX
public static final String REQUEST_HEADERS_PREFIX
Config prefix that allows configuration of arbitrary HTTP client request headers used by the Registry REST Client in the serde class when communicating with the Registry. For example, this could be used to pass authentication information:apicurio.registry.request.headers.Authorization=BASIC Y2tlbnQ6a3J5cHQwbnIwY2tzIQ==- See Also:
- Constant Field Values
-
REQUEST_TRUSTSTORE_LOCATION
public static final String REQUEST_TRUSTSTORE_LOCATION
Location of a trust store to use when connecting to the registry via SSL.- See Also:
- Constant Field Values
-
REQUEST_TRUSTSTORE_TYPE
public static final String REQUEST_TRUSTSTORE_TYPE
Type of trust store to use when connecting to the registry via SSL.- See Also:
- Constant Field Values
-
REQUEST_TRUSTSTORE_PASSWORD
public static final String REQUEST_TRUSTSTORE_PASSWORD
Password of the trust store to use when connecting to the registry via SSL.- See Also:
- Constant Field Values
-
REQUEST_KEYSTORE_LOCATION
public static final String REQUEST_KEYSTORE_LOCATION
Location of a keystore to use when e.g. connecting to the registry via mTLS.- See Also:
- Constant Field Values
-
REQUEST_KEYSTORE_TYPE
public static final String REQUEST_KEYSTORE_TYPE
Type of keystore to use when e.g. connecting to the registry via mTLS.- See Also:
- Constant Field Values
-
REQUEST_KEYSTORE_PASSWORD
public static final String REQUEST_KEYSTORE_PASSWORD
Password of the keystore to use when e.g. connecting to the registry via mTLS.- See Also:
- Constant Field Values
-
REQUEST_KEY_PASSWORD
public static final String REQUEST_KEY_PASSWORD
Key password used when e.g. connecting to the registry via mTLS.- See Also:
- Constant Field Values
-
DEREFERENCE_SCHEMA
public static final String DEREFERENCE_SCHEMA
Used to indicate the auto-register feature to try to dereference the schema before registering it in Registry. Only applicable whenAUTO_REGISTER_ARTIFACTis enabled.- See Also:
- Constant Field Values
-
DEREFERENCE_SCHEMA_DEFAULT
public static final boolean DEREFERENCE_SCHEMA_DEFAULT
- See Also:
- Constant Field Values
-
-