Skip to content

Commit 310cbc5

Browse files
Add doc for archive helper (#1372)
1 parent f97e5ec commit 310cbc5

File tree

1 file changed

+93
-0
lines changed

1 file changed

+93
-0
lines changed
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: "Archive Helper Tool"
3+
date: 2019-02-23T17:19:24-05:00
4+
draft: false
5+
weight: 12
6+
description: "Helps you create and modify archive files."
7+
---
8+
9+
10+
With the Archive Helper Tool, you can display the contents of an archive file, add, update, extract, and remove files, as needed.
11+
12+
Use the Archive Helper Tool `-help` option to display its commands. Each command takes a subcommand, which may require one or more command-line options.
13+
14+
### `archiveHelper` commands
15+
| Command | Description |
16+
| ---- | ---- |
17+
| `add` | Add items to the archive file. |
18+
| `extract` | Extract items from the archive file. |
19+
| `list` | List contents of the archive file. |
20+
| `remove` | Remove items to the archive file. |
21+
22+
For each command, use the `-help` option for usage information about its subcommands.
23+
24+
For example, to display the subcommands of the `archiveHelper` `add` command:
25+
```yaml
26+
$ <wls-deploy-home>/bin/archiveHelper.sh add -help
27+
```
28+
This will result in the following output:
29+
```yaml
30+
Add items to the archive file.
31+
Usage: archiveHelper add [-help] [COMMAND]
32+
33+
Command-line options:
34+
-help Get help for the archiveHelper add command
35+
36+
Subcommands:
37+
application Add application to the archive file.
38+
applicationPlan Add application deployment plan to the archive file.
39+
classpathLibrary Add classpath library to the archive file.
40+
coherenceConfig Add a Coherence config file to the archive file.
41+
coherencePersistenceDir Add a Coherence persistence directory to the archive
42+
file.
43+
custom Add custom file/directory to the archive file.
44+
databaseWallet Add database wallet to the archive file.
45+
domainBinScript Add $DOMAIN_HOME/bin script to the archive file.
46+
domainLibrary Add $DOMAIN_HOME/lib library to the archive file.
47+
fileStore Add empty file store directory to the archive file.
48+
jmsForeignServer Add a JMS Foreign Server binding file to the archive
49+
file.
50+
mimeMapping Add MIME mapping file to the archive file.
51+
nodeManagerKeystore Add node manager keystore to the archive file.
52+
opssWallet Add OPSS wallet to the archive file.
53+
rcuWallet Add RCU database wallet to the archive file.
54+
script Add script to the archive file.
55+
serverKeystore Add a server keystore to the archive file.
56+
sharedLibrary Add shared library to the archive file.
57+
sharedLibraryPlan Add shared library deployment plan to the archive
58+
file.
59+
structuredApplication Add structured application installation directory to
60+
the archive file.
61+
```
62+
To display the command-line options for the `archiveHelper` `add application` subcommand:
63+
```yaml
64+
$ <wls-deploy-home>/bin/archiveHelper.sh add application -help
65+
```
66+
This will result in the following output:
67+
```yaml
68+
Add application to the archive file.
69+
Usage: archiveHelper add application [-help] [-overwrite]
70+
-archive_file=<archive_file> -source=<path>
71+
72+
Command-line options:
73+
-archive_file=<archive_file>
74+
Path to the archive file to use.
75+
-overwrite Overwrite the existing entry in the archive file, if any
76+
-source=<path> File system path to the application to add
77+
-help Get help for the archiveHelper add application subcommand
78+
79+
Note: If using an Application Installation Directory, please see the
80+
archiveHelper add structuredApplication command.
81+
```
82+
### Usage scenarios
83+
84+
- `list application`: List the applications in the archive file.
85+
```yaml
86+
$ <wls-deploy-home>/bin/archiveHelper.sh list application -archive_file=C:\temp\archive-helper-test.zip
87+
```
88+
89+
- `add application`: Update an existing application in the archive.
90+
```yaml
91+
$ <wls-deploy-home>/bin/archiveHelper.sh add application -archive_file=C:\temp\archive-helper-test.zip -source=C:\temp\my-app.war -overwrite
92+
```
93+
**NOTE**: Without the `-overwrite` option, the application gets added to the archive with a numerical suffix.

0 commit comments

Comments
 (0)