Class BundleDeployMojo
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.sling.maven.bundlesupport.BundleDeployMojo
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
@Deprecated
@Mojo(name="deploy",
defaultPhase=DEPLOY)
public class BundleDeployMojo
extends org.apache.maven.plugin.AbstractMojo
Deprecated.
Use the OBR goals from the maven-bundle-plugin instead.
Deploy a JAR representing an OSGi Bundle to a Sling OSGi Bundle Repository.
This method posts the bundle built by maven to the OSGi Bundle Repository.
The plugin uses a multipart/format-data POST request to just post the file to
the URL configured in the
obr
property.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
Determines whether or not to fail the build if the HTTP POST or PUT returns an non-OK response code.protected org.eclipse.aether.RepositorySystemSession
protected List<org.eclipse.aether.repository.RemoteRepository>
protected org.eclipse.aether.RepositorySystem
protected URI
The WebConsole URL of the running Sling instance.protected URI
The URL of the running Sling instance.protected String
An optional url suffix which will be appended to thesling.url
for use as the real target url.Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic URI
addTrailingSlash
(URI targetURL) protected File
changeVersion
(File file, String oldVersion, String newVersion) Deprecated.Change the version in jarvoid
execute()
Deprecated.Execute this Mojoprotected File
fixBundleVersion
(File jarFile) Deprecated.Optionally fixes up the version of the bundle given in the jar File.protected String
getBundleSymbolicName
(File jarFile) Returns the symbolic name of the given bundle.protected URI
protected org.apache.hc.client5.http.impl.classic.CloseableHttpClient
protected String
Deprecated.Returns the path and name of the jar file containing the bundle to be uploaded.protected org.apache.hc.client5.http.config.RequestConfig.Builder
protected URI
protected File
resolveArtifact
(org.eclipse.aether.artifact.Artifact artifact) Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
-
Field Details
-
slingUrl
@Parameter(property="sling.url", defaultValue="http://localhost:8080/system/console", required=true) protected URI slingUrlThe URL of the running Sling instance.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. -
slingConsoleUrl
The WebConsole URL of the running Sling instance. This is required for file system provider operations. If not configured the value of slingUrl is used. -
slingUrlSuffix
An optional url suffix which will be appended to thesling.url
for use as the real target url. This allows to configure different target URLs in each POM, while using the same commonsling.url
in a parent POM (eg.sling.url=http://localhost:8080
andsling.urlSuffix=/project/specific/path
). This is typically used in conjunction with WebDAV or SlingPostServlet deployment methods. -
failOnError
@Parameter(property="sling.failOnError", defaultValue="true") protected boolean failOnErrorDetermines whether or not to fail the build if the HTTP POST or PUT returns an non-OK response code. -
repoSystem
@Component protected org.eclipse.aether.RepositorySystem repoSystem -
repoSession
@Parameter(defaultValue="${repositorySystemSession}", readonly=true, required=true) protected org.eclipse.aether.RepositorySystemSession repoSession -
repositories
@Parameter(defaultValue="${project.remoteProjectRepositories}", readonly=true, required=true) protected List<org.eclipse.aether.repository.RemoteRepository> repositories
-
-
Constructor Details
-
BundleDeployMojo
public BundleDeployMojo()Deprecated.
-
-
Method Details
-
execute
public void execute() throws org.apache.maven.plugin.MojoExecutionExceptionDeprecated.Execute this Mojo- Specified by:
execute
in interfaceorg.apache.maven.plugin.Mojo
- Throws:
org.apache.maven.plugin.MojoExecutionException
-
getJarFileName
Deprecated.Returns the path and name of the jar file containing the bundle to be uploaded. This method always returns a non-null
name but throws aMojoExecutionException
if the name is not known.- Returns:
- The name of the file to be uploaded, this is never
null
.
-
fixBundleVersion
Deprecated.Optionally fixes up the version of the bundle given in the jar File. If no version fixup is required thejarFile
may just be returned.- Parameters:
jarFile
- The file whose bundle version should be fixed- Returns:
- The file containing the fixed version or
jarFile
if the version was not fixed. - Throws:
org.apache.maven.plugin.MojoExecutionException
- May be thrown in case of any problems
-
changeVersion
protected File changeVersion(File file, String oldVersion, String newVersion) throws org.apache.maven.plugin.MojoExecutionException Deprecated.Change the version in jar- Parameters:
file
- FileoldVersion
- Old versionnewVersion
- New version- Returns:
- File
- Throws:
org.apache.maven.plugin.MojoExecutionException
- Exception
-
getBundleSymbolicName
Returns the symbolic name of the given bundle. If thejarFile
does not contain a manifest with aBundle-SymbolicName
headernull
is returned. Otherwise the value of theBundle-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.- Parameters:
jarFile
- The file providing the bundle whose symbolic name is requested.- Returns:
- The bundle's symbolic name from the
Bundle-SymbolicName
manifest header ornull
if no manifest exists in the file or the header is not contained in the manifest. However, ifnull
is returned, the file may be assumed to not contain an OSGi bundle.
-
getTargetURL
- Returns:
- Returns the combination of
sling.url
andsling.urlSuffix
. Always ends with "/".
-
getConsoleTargetURL
- Returns:
- Returns the combination of
sling.console.url
andsling.urlSuffix
. Always ends with "/".
-
addTrailingSlash
-
getHttpClient
protected org.apache.hc.client5.http.impl.classic.CloseableHttpClient getHttpClient()- Returns:
- Get the http client
-
getRequestConfigBuilder
protected org.apache.hc.client5.http.config.RequestConfig.Builder getRequestConfigBuilder() -
resolveArtifact
protected File resolveArtifact(org.eclipse.aether.artifact.Artifact artifact) throws org.apache.maven.plugin.MojoExecutionException - Throws:
org.apache.maven.plugin.MojoExecutionException
-