vltpack:upload-file

Full name:

net.adamcin:vltpack-maven-plugin:1.3.0:upload-file

Description:

Command-line goal that provides the ability to upload a package file and install it directly into a running instance.

Attributes:

  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0.2.
  • Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name Type Since Description
file File 1.0.2
Specify the path to a valid vault package file.

User property is: file.

Optional Parameters

Name Type Since Description
autosave int 1.0.2
Change the autosave threshold for the install command. 1024 is the minimum.

Default value is: 1024.
User property is: vltpack.upload.autosave.
context String 1.0.2
Granite Servlet context by which JCR paths are appended

Default value is: /.
User property is: vltpack.context.
force boolean 1.0.2
Force upload of packages if they already exist in the target environment

User property is: vltpack.upload.force.
host String 1.0.2
Hostname for the Granite server

Default value is: localhost.
User property is: vltpack.host.
https boolean 1.0.2
Whether to use an SSL connection instead of a normal HTTP connection. Does not affect the configured TCP port

User property is: vltpack.https.
localRepositoryPath File 1.0.4
Specify the local repository path for resolved artifacts Refer to maven-install-plugin:install-file

User property is: vltpack.localRepositoryPath.
noProxy boolean 1.0.2
Set to true to completely disable HTTP proxy connections for this plugin. Overrides any other HTTP proxy configuration

User property is: vltpack.proxy.noProxy.
pass String 1.0.2
Password to use in connection credentials

Default value is: admin.
User property is: vltpack.pass.
port Integer 1.0.2
TCP Port for the Granite server

Default value is: 4502.
User property is: vltpack.port.
proxyHost String 1.0.2
The HTTP Proxy hostname

Default value is: localhost.
User property is: vltpack.proxy.host.
proxyPass String 1.0.2
The HTTP Proxy password

User property is: vltpack.proxy.pass.
proxyPort int 1.0.2
The HTTP Proxy port. Set to -1 to use the default proxy port.

User property is: vltpack.proxy.port.
proxyProtocol String 1.0.2
The HTTP Proxy protocol

Default value is: http.
User property is: vltpack.proxy.protocol.
proxySet boolean 1.0.2
Set to true to override the proxy configuration in the user's Maven Settings with the associated mojo parameter alternatives

User property is: vltpack.proxy.set.
proxyUser String 1.0.2
The HTTP Proxy username

User property is: vltpack.proxy.user.
recursive boolean 1.0.2
Set to false to not install any subpackages that might be embedded within each dependency

Default value is: true.
User property is: vltpack.upload.recursive.
serviceTimeout int 1.0.2
Set the timeout used for waiting for Package Manager service availability before sending any POST requests. The wait is to avoid creating dummy nodes in the repository when the SlingPostServlet handles premature package manager requests, which can confuse the link rewriter and mess up links to the package manager console.

Default value is: 60.
User property is: vltpack.upload.timeout.
skip boolean 1.0.2
Set to true to skip execution of this mojo

User property is: vltpack.skip.upload-file.
user String 1.0.2
Specify the CQ username associated with package creation and installation

Default value is: admin.
User property is: vltpack.user.

Parameter Details

autosave:

Change the autosave threshold for the install command. 1024 is the minimum.
  • Type: int
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.upload.autosave
  • Default: 1024

context:

Granite Servlet context by which JCR paths are appended
  • Type: java.lang.String
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.context
  • Default: /

file:

Specify the path to a valid vault package file.
  • Type: java.io.File
  • Since: 1.0.2
  • Required: Yes
  • User Property: file

force:

Force upload of packages if they already exist in the target environment
  • Type: boolean
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.upload.force

host:

Hostname for the Granite server
  • Type: java.lang.String
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.host
  • Default: localhost

https:

Whether to use an SSL connection instead of a normal HTTP connection. Does not affect the configured TCP port
  • Type: boolean
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.https

localRepositoryPath:

Specify the local repository path for resolved artifacts Refer to maven-install-plugin:install-file
  • Type: java.io.File
  • Since: 1.0.4
  • Required: No
  • User Property: vltpack.localRepositoryPath

noProxy:

Set to true to completely disable HTTP proxy connections for this plugin. Overrides any other HTTP proxy configuration
  • Type: boolean
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.proxy.noProxy

pass:

Password to use in connection credentials
  • Type: java.lang.String
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.pass
  • Default: admin

port:

TCP Port for the Granite server
  • Type: java.lang.Integer
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.port
  • Default: 4502

proxyHost:

The HTTP Proxy hostname
  • Type: java.lang.String
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.proxy.host
  • Default: localhost

proxyPass:

The HTTP Proxy password
  • Type: java.lang.String
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.proxy.pass

proxyPort:

The HTTP Proxy port. Set to -1 to use the default proxy port.
  • Type: int
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.proxy.port

proxyProtocol:

The HTTP Proxy protocol
  • Type: java.lang.String
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.proxy.protocol
  • Default: http

proxySet:

Set to true to override the proxy configuration in the user's Maven Settings with the associated mojo parameter alternatives
  • Type: boolean
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.proxy.set

proxyUser:

The HTTP Proxy username
  • Type: java.lang.String
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.proxy.user

recursive:

Set to false to not install any subpackages that might be embedded within each dependency
  • Type: boolean
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.upload.recursive
  • Default: true

serviceTimeout:

Set the timeout used for waiting for Package Manager service availability before sending any POST requests. The wait is to avoid creating dummy nodes in the repository when the SlingPostServlet handles premature package manager requests, which can confuse the link rewriter and mess up links to the package manager console.
  • Type: int
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.upload.timeout
  • Default: 60

skip:

Set to true to skip execution of this mojo
  • Type: boolean
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.skip.upload-file

user:

Specify the CQ username associated with package creation and installation
  • Type: java.lang.String
  • Since: 1.0.2
  • Required: No
  • User Property: vltpack.user
  • Default: admin