Skip to content

package-server.md

Latest commit

 

History

History
69 lines (63 loc) · 3.23 KB

package-server.md

File metadata and controls

69 lines (63 loc) · 3.23 KB

package-server

Package a Liberty server.

Starting with WebSphere Liberty 8.5.5.9, it is possible to package a server into an executable jar file by setting the include parameter to runnable. The created jar file can be executed using the java -jar command.

Additional Parameters

The following are the parameters supported by this goal in addition to the common server parameters and the common parameters.

Parameter Description Required
packageFile Location of the target file or directory. If the target location is a file, the contents of the server instance will be compressed into the specified file. If the target location is a directory, the contents of the server instance will be compressed into ${packageFile}/${project.build.finalName}.zip|jar file. If the target location is not specified, it defaults to ${project.build.directory}/${project.build.finalName}.zip|jar. A jar file is created when the packaging type is runnable. A zip file is created for other packaging types. No
include Packaging type. Can be used with values all, usr, minify, wlp, runnable, all,runnable, and minify,runnable. The default value is all. The runnable value is supported beginning with 8.5.5.9 and works with jar type archives only. Yes, only when the os option is set
os A comma-delimited list of operating systems that you want the packaged server to support. To specify that an operating system is not to be supported, prefix it with a minus sign ("-"). The 'include' attribute must be set to minify. No
skipLibertyPackage If true, the package-server goal is bypassed entirely. The default value is false. No

Examples:

  1. Package test server into a zip file.
<plugin>
    <groupId>net.wasdev.wlp.maven.plugins</groupId>
    <artifactId>liberty-maven-plugin</artifactId>
    <executions>
        <execution>
            <id>package-server</id>
            <phase>package</phase>
            <goals>
                <goal>package-server</goal>
            </goals>
            <configuration>
                <packageFile>${project.build.directory}/test.zip</packageFile>
            </configuration>
        </execution>
        ...
    </executions>
    <configuration>
       <installDirectory>/opt/ibm/wlp</installDirectory>
       <serverName>test</serverName>
    </configuration>
</plugin>
  1. Package test server into a runnable jar file.
<plugin>
    <groupId>net.wasdev.wlp.maven.plugins</groupId>
    <artifactId>liberty-maven-plugin</artifactId>
    <executions>
        ...
        <execution>
            <id>package-server</id>
            <phase>package</phase>
            <goals>
                <goal>package-server</goal>
            </goals>
            <configuration>
                <packageFile>${project.build.directory}/test.jar</packageFile>
                <include>runnable</include>
            </configuration>
        </execution>
        ...
    </executions>
    <configuration>
       <installDirectory>/opt/ibm/wlp</installDirectory>
       <serverName>test</serverName>
    </configuration>
</plugin>