@Mojo(name="install-file",
requiresProject=false)
public class BundleInstallFileMojo
extends org.apache.maven.plugin.AbstractMojo
Modifier and Type | Field and Description |
---|---|
protected BundleDeploymentMethod |
deploymentMethod
Bundle deployment method.
|
protected boolean |
failOnError
Determines whether or not to fail the build if
the HTTP POST or PUT returns an non-OK response code.
|
protected String |
mimeType
The content type / mime type used for WebDAV or Sling POST deployment.
|
protected org.apache.maven.project.MavenProject |
project
The Maven project.
|
protected String |
slingConsoleUrl
The WebConsole URL of the running Sling instance.
|
protected String |
slingUrl
The URL of the running Sling instance.
|
protected String |
slingUrlSuffix
An optional url suffix which will be appended to the
sling.url
for use as the real target url. |
protected boolean |
usePut
Deprecated.
Use
deploymentMethod instead. |
Constructor and Description |
---|
BundleInstallFileMojo() |
Modifier and Type | Method and Description |
---|---|
protected void |
configure(String targetURL,
File file) |
void |
execute() |
protected String |
getBundleFileName() |
protected String |
getBundleSymbolicName(File jarFile)
Returns the symbolic name of the given bundle.
|
protected String |
getConsoleTargetURL() |
protected BundleDeploymentMethod |
getDeploymentMethod()
Retrieve the bundle deployment method matching the configuration.
|
protected org.apache.commons.httpclient.HttpClient |
getHttpClient() |
protected String |
getTargetURL() |
@Parameter(property="sling.usePut", defaultValue="false") protected boolean usePut
deploymentMethod
instead.uninstall
goal, a HTTP DELETE will be
used.@Parameter(property="sling.deploy.method", required=false) protected BundleDeploymentMethod deploymentMethod
slingUrl
points to the Felix Web Console in that case.slingUrl
points to the entry path of
the Sling WebDAV bundle (defaults to /dav/default in the Sling starter). Issues a HTTP Delete for the uninstall goal.slingUrl
points a path which is handled by the Sling POST Servlet (usually below regular Sling root URL).usePut
.@Parameter(property="sling.mimeType", defaultValue="application/java-archive", required=true) protected String mimeType
@Parameter(defaultValue="${project}", required=true, readonly=true) protected org.apache.maven.project.MavenProject project
@Parameter(property="sling.url", defaultValue="http://localhost:8080/system/console", required=true) protected String slingUrl
The default is only useful for WebConsole deployment.
For WebDAV deployment it is recommended to include the Sling Simple WebDAV servlet root, for instance http://localhost:8080/dav/default/libs/sling/install. Omitting the dav/default segment can lead to conflicts with other servlets.
@Parameter(property="sling.console.url") protected String slingConsoleUrl
@Parameter(property="sling.urlSuffix") protected String slingUrlSuffix
sling.url
for use as the real target url. This allows to configure different target URLs
in each POM, while using the same common sling.url
in a parent
POM (eg. sling.url=http://localhost:8080
and
sling.urlSuffix=/project/specific/path
). This is typically used
in conjunction with WebDAV or SlingPostServlet deployment methods.@Parameter(property="sling.failOnError", defaultValue="true", required=true) protected boolean failOnError
protected String getBundleFileName() throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
public void execute() throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
protected void configure(String targetURL, File file) throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
protected BundleDeploymentMethod getDeploymentMethod() throws org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoExecutionException
- Exceptionprotected String getBundleSymbolicName(File jarFile)
jarFile
does not contain a manifest with a
Bundle-SymbolicName
header null
is
returned. Otherwise the value of the Bundle-SymbolicName
header is returned.
This method may also be used to check whether the file is a bundle at all
as it is assumed, that only if the file contains an OSGi bundle will the
Bundle-SymbolicName
manifest header be set.
jarFile
- The file providing the bundle whose symbolic name is
requested.Bundle-SymbolicName
manifest header or
null
if no manifest exists in the file or the
header is not contained in the manifest. However, if
null
is returned, the file may be assumed to not
contain an OSGi bundle.protected String getTargetURL()
sling.url
and sling.urlSuffix
.protected String getConsoleTargetURL()
sling.console.url
and sling.urlSuffix
.protected org.apache.commons.httpclient.HttpClient getHttpClient()
Copyright © 2007–2019 The Apache Software Foundation. All rights reserved.