Built by Maven

apicurio-registry:register

Full name:

io.apicurio:apicurio-registry-maven-plugin:3.1.7:register

Description:

Register artifacts against registry.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.

Required Parameters

Name Type Since Description
<artifacts> List<RegisterArtifact> - The list of artifacts to register.
<registryUrl> String - The registry's url. e.g. http://localhost:8080/apis/registry/v3
User Property: apicurio.url

Optional Parameters

Name Type Since Description
<authServerUrl> String - The URL of the authentication server (if required).
User Property: auth.server.url
<clientId> String - The client id to use when authenticating to the auth sever.
User Property: client.id
<clientScope> String - The client scope to use when authenticating to the auth sever.
User Property: client.scope
<clientSecret> String - The client secret to use when authenticating to the auth sever.
User Property: client.secret
<dryRun> boolean - Set this to 'true' to perform the action with the "dryRun" option enabled. This will effectively test whether registration *would have worked*. But it results in no changes made on the server.
Default: false
User Property: dryRun
<existingReferences> List<ExistingReference> - The list of pre-registered artifacts that can be used as references.
<keyStorePassword> String - Password for the key store (required for JKS and PKCS12 formats).
User Property: keyStorePassword
<keyStorePath> String - Path to the key store file for mutual TLS (mTLS) client authentication. Supports JKS, PKCS12, and PEM formats. The format is auto-detected from the file extension (.jks, .p12/.pfx, .pem/.crt/.cer) unless explicitly specified via keyStoreType.
User Property: keyStorePath
<keyStorePemKeyPath> String - Path to the PEM private key file (required when using PEM format for mTLS and keyStorePath points to the certificate file).
User Property: keyStorePemKeyPath
<keyStoreType> String - Type of the key store: JKS, PKCS12, or PEM. If not specified, the type is auto-detected from the file extension.
User Property: keyStoreType
<password> String - Authentication credentials: password
User Property: password
<skip> boolean - Set this to 'true' to skip registering the artifact(s). Convenient in case you want to skip for specific occasions.
Default: false
User Property: skipRegister
<trustAll> boolean - If set to true, trust all SSL/TLS certificates without validation. WARNING: This should only be used for development/testing purposes.
Default: false
User Property: trustAll
<trustStorePassword> String - Password for the trust store (required for JKS and PKCS12 formats).
User Property: trustStorePassword
<trustStorePath> String - Path to the trust store file for SSL/TLS connections. Supports JKS, PKCS12, and PEM formats. The format is auto-detected from the file extension (.jks, .p12/.pfx, .pem/.crt/.cer) unless explicitly specified via trustStoreType.
User Property: trustStorePath
<trustStoreType> String - Type of the trust store: JKS, PKCS12, or PEM. If not specified, the type is auto-detected from the file extension.
User Property: trustStoreType
<username> String - Authentication credentials: username
User Property: username
<verifyHostname> boolean - If set to false, disable hostname verification in SSL/TLS connections. WARNING: Disabling this reduces security and should only be used for development/testing.
Default: true
User Property: verifyHostname

Parameter Details

<artifacts>

The list of artifacts to register.
  • Type: java.util.List<io.apicurio.registry.maven.RegisterArtifact>
  • Required: Yes

<authServerUrl>

The URL of the authentication server (if required).
  • Type: java.lang.String
  • Required: No
  • User Property: auth.server.url

<clientId>

The client id to use when authenticating to the auth sever.
  • Type: java.lang.String
  • Required: No
  • User Property: client.id

<clientScope>

The client scope to use when authenticating to the auth sever.
  • Type: java.lang.String
  • Required: No
  • User Property: client.scope

<clientSecret>

The client secret to use when authenticating to the auth sever.
  • Type: java.lang.String
  • Required: No
  • User Property: client.secret

<dryRun>

Set this to 'true' to perform the action with the "dryRun" option enabled. This will effectively test whether registration *would have worked*. But it results in no changes made on the server.
  • Type: boolean
  • Required: No
  • User Property: dryRun
  • Default: false

<existingReferences>

The list of pre-registered artifacts that can be used as references.
  • Type: java.util.List<io.apicurio.registry.maven.ExistingReference>
  • Required: No

<keyStorePassword>

Password for the key store (required for JKS and PKCS12 formats).
  • Type: java.lang.String
  • Required: No
  • User Property: keyStorePassword

<keyStorePath>

Path to the key store file for mutual TLS (mTLS) client authentication. Supports JKS, PKCS12, and PEM formats. The format is auto-detected from the file extension (.jks, .p12/.pfx, .pem/.crt/.cer) unless explicitly specified via keyStoreType.
  • Type: java.lang.String
  • Required: No
  • User Property: keyStorePath

<keyStorePemKeyPath>

Path to the PEM private key file (required when using PEM format for mTLS and keyStorePath points to the certificate file).
  • Type: java.lang.String
  • Required: No
  • User Property: keyStorePemKeyPath

<keyStoreType>

Type of the key store: JKS, PKCS12, or PEM. If not specified, the type is auto-detected from the file extension.
  • Type: java.lang.String
  • Required: No
  • User Property: keyStoreType

<password>

Authentication credentials: password
  • Type: java.lang.String
  • Required: No
  • User Property: password

<registryUrl>

The registry's url. e.g. http://localhost:8080/apis/registry/v3
  • Type: java.lang.String
  • Required: Yes
  • User Property: apicurio.url

<skip>

Set this to 'true' to skip registering the artifact(s). Convenient in case you want to skip for specific occasions.
  • Type: boolean
  • Required: No
  • User Property: skipRegister
  • Default: false

<trustAll>

If set to true, trust all SSL/TLS certificates without validation. WARNING: This should only be used for development/testing purposes.
  • Type: boolean
  • Required: No
  • User Property: trustAll
  • Default: false

<trustStorePassword>

Password for the trust store (required for JKS and PKCS12 formats).
  • Type: java.lang.String
  • Required: No
  • User Property: trustStorePassword

<trustStorePath>

Path to the trust store file for SSL/TLS connections. Supports JKS, PKCS12, and PEM formats. The format is auto-detected from the file extension (.jks, .p12/.pfx, .pem/.crt/.cer) unless explicitly specified via trustStoreType.
  • Type: java.lang.String
  • Required: No
  • User Property: trustStorePath

<trustStoreType>

Type of the trust store: JKS, PKCS12, or PEM. If not specified, the type is auto-detected from the file extension.
  • Type: java.lang.String
  • Required: No
  • User Property: trustStoreType

<username>

Authentication credentials: username
  • Type: java.lang.String
  • Required: No
  • User Property: username

<verifyHostname>

If set to false, disable hostname verification in SSL/TLS connections. WARNING: Disabling this reduces security and should only be used for development/testing.
  • Type: boolean
  • Required: No
  • User Property: verifyHostname
  • Default: true