Skip to content

Commit 302220b

Browse files
mike-irismike-iris
committed
add content to developer, add a few cross links, spell check
1 parent 074bf8f commit 302220b

File tree

8 files changed

+255
-78
lines changed

8 files changed

+255
-78
lines changed

‎docs/ExampleService.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ WSS service given the following:
66

77
- A command-line script called **sample.py** - see listing below.
88
- That Tomcat is installed.
9-
- A folder is available for storing files, in this example the fo/der is called /WSSHOME
9+
- A folder is available for storing files, in this example the folder is called /WSSHOME
1010

1111
#### This procedure's objective is to:
1212

13-
- create a web service called **mysrv/sample/1**, accessable at
13+
- create a web service called **mysrv/sample/1**, accessible at
1414
http://localhost:8080/mysrv/sample/1
1515
- have the web service deliver random numbers using parameter
1616
**num\_values**

‎docs/HandlerRequirements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ URL is translated into a respective command line form, e.g.
7777
**Only** parameters configured via `param.cfg` are passed to the
7878
handler, however, `relaxedValidation` maybe used to bypass this restriction.
7979
This may be useful for testing new options or enabling more flexibility in
80-
hanlders. The CmdProcessor will add the following parameters as needed.
80+
handlers. The CmdProcessor will add the following parameters as needed.
8181

8282
1. `--username USER` is added by the CmdProcessor when a user has been
8383
successfully authenticated.

‎docs/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# WebServiceShell (WSS)
22

3+
4+
## Documentation
5+
- [User](WebServiceShell-2.4.x.md)
6+
- [Example Service](ExampleService.md)
7+
- [Working with Handler Programs](HandlerRequirements.md)
8+
- [Setup Recommendations](Recommendations.md)
9+
310
### Introduction
411

512
The Web Service Shell (WSS) is a web service that can be configured via
@@ -22,4 +29,4 @@ of an HTTP server.
2229

2330
The WSS can also be configured to use a Java class rather than a command
2431
line program to fulfill the data retrieval. More details about using
25-
Java classes with the WSS can be found in the [documentation](./)
32+
Java classes with the WSS can be found in the [developer notes](docs/README.md)

‎docs/WebServiceShell-2.4.x.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -558,10 +558,10 @@ The following restrictions apply:
558558
header information before writing any other output
559559
- The header information must be text between marker strings in the
560560
following form:
561-
- starts with "HTTP\_HEADERS\_START"
561+
- starts with "HTTP_HEADERS_START"
562562
- followed by each header in regular HTTP format, terminated with
563563
linefeed or carriage return linefeed
564-
- ends with "HTTP\_HEADERS\_END"
564+
- ends with "HTTP_HEADERS_END"
565565
- The marker strings **must not** be followed by linefeed or carriage
566566
return linefeed.
567567

‎docs/developer/README.md

Lines changed: 83 additions & 32 deletions
Large diffs are not rendered by default.

‎docs/developer/WSS_request_sequence.png

6.93 KB
Loading

‎docs/developer/inputs/WSS_request_sequence.graffle

Lines changed: 93 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,88 @@
5050
<integer>12</integer>
5151
<key>GraphicsList</key>
5252
<array>
53+
<dict>
54+
<key>Bounds</key>
55+
<string>{{460.71029982764304, 502.77400287839743}, {21.600000858306885, 21.600000858306885}}</string>
56+
<key>Class</key>
57+
<string>ShapedGraphic</string>
58+
<key>FontInfo</key>
59+
<dict>
60+
<key>Color</key>
61+
<dict>
62+
<key>b</key>
63+
<string>1</string>
64+
<key>g</key>
65+
<string>1</string>
66+
<key>r</key>
67+
<string>1</string>
68+
</dict>
69+
<key>Size</key>
70+
<real>10</real>
71+
</dict>
72+
<key>ID</key>
73+
<integer>3045</integer>
74+
<key>Layer</key>
75+
<integer>1</integer>
76+
<key>Magnets</key>
77+
<array>
78+
<string>{0, 1}</string>
79+
<string>{0, -1}</string>
80+
<string>{1, 0}</string>
81+
<string>{-1, 0}</string>
82+
</array>
83+
<key>Scaling</key>
84+
<integer>1</integer>
85+
<key>Shape</key>
86+
<string>Circle</string>
87+
<key>Style</key>
88+
<dict>
89+
<key>fill</key>
90+
<dict>
91+
<key>Color</key>
92+
<dict>
93+
<key>b</key>
94+
<real>1</real>
95+
<key>g</key>
96+
<real>0.972549</real>
97+
<key>r</key>
98+
<real>0.92156899999999997</real>
99+
<key>space</key>
100+
<string>srgb</string>
101+
</dict>
102+
</dict>
103+
</dict>
104+
<key>Text</key>
105+
<dict>
106+
<key>RTFD</key>
107+
<data>
108+
BAtzdHJlYW10eXBlZIHoA4QBQISEhBJOU0F0dHJpYnV0
109+
ZWRTdHJpbmcAhIQITlNPYmplY3QAhZKEhIQITlNTdHJp
110+
bmcBlIQBKwE0hoQCaUkBAZKEhIQMTlNEaWN0aW9uYXJ5
111+
AJSEAWkDkoSWlgdOU0NvbG9yhpKEhIQHTlNDb2xvcgCU
112+
hAFjAYQEZmZmZoMuHAg9g5F+mz6D2gNNPwGGkoSWlhBO
113+
U1BhcmFncmFwaFN0eWxlhpKEhIQXTlNNdXRhYmxlUGFy
114+
YWdyYXBoU3R5bGUAhIQQTlNQYXJhZ3JhcGhTdHlsZQCU
115+
hARDQ0BTAgCEhIQHTlNBcnJheQCUmQyShISECU5TVGV4
116+
dFRhYgCUhAJDZgAchpKEo6IAOIaShKOiAFSGkoSjogBw
117+
hpKEo6IAgYwAhpKEo6IAgagAhpKEo6IAgcQAhpKEo6IA
118+
geAAhpKEo6IAgfwAhpKEo6IAgRgBhpKEo6IAgTQBhpKE
119+
o6IAgVABhoYAhpKElpYGTlNGb250hpKEhIQGTlNGb250
120+
HpSZKIQFWzQwY10GAAAAHgAAAP/+SABlAGwAdgBlAHQA
121+
aQBjAGEALQBCAG8AbABkAAAAhAFmDJsAmwGbAJsAhoaG
122+
</data>
123+
<key>Text</key>
124+
<string>{\rtf1\ansi\ansicpg1252\cocoartf1561\cocoasubrtf600
125+
{\fonttbl\f0\fswiss\fcharset0 Helvetica;}
126+
{\colortbl;\red255\green255\blue255;\red8\green77\blue204;}
127+
{\*\expandedcolortbl;;\csgenericrgb\c3323\c30370\c80084;}
128+
\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\pardirnatural\qc\partightenfactor0
129+
130+
\f0\b\fs24 \cf2 4}</string>
131+
<key>VerticalPad</key>
132+
<real>0.0</real>
133+
</dict>
134+
</dict>
53135
<dict>
54136
<key>Bounds</key>
55137
<string>{{120.99133001803307, 95.270777569329198}, {67.646139507575072, 21.600000858306885}}</string>
@@ -2268,11 +2350,20 @@
22682350
</dict>
22692351
<dict>
22702352
<key>Bounds</key>
2271-
<string>{{429.54231861263059, 511.27512112382681}, {21.600000858306885, 21.600000858306885}}</string>
2353+
<string>{{358.22174815770711, 453.93348732858789}, {21.600000858306885, 21.600000858306885}}</string>
22722354
<key>Class</key>
22732355
<string>ShapedGraphic</string>
22742356
<key>FontInfo</key>
22752357
<dict>
2358+
<key>Color</key>
2359+
<dict>
2360+
<key>b</key>
2361+
<string>1</string>
2362+
<key>g</key>
2363+
<string>1</string>
2364+
<key>r</key>
2365+
<string>1</string>
2366+
</dict>
22762367
<key>Size</key>
22772368
<real>10</real>
22782369
</dict>
@@ -3651,7 +3742,7 @@ Glassfish}</string>
36513742
<key>MasterSheets</key>
36523743
<array/>
36533744
<key>ModificationDate</key>
3654-
<string>2018-08-10 20:57:22 +0000</string>
3745+
<string>2018-08-15 20:13:34 +0000</string>
36553746
<key>Modifier</key>
36563747
<string>Mike Stults</string>
36573748
<key>NotesVisible</key>

‎docs/glassfish/README.md

Lines changed: 66 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,79 @@
1+
# Glassfish 4.1.1 Basic Operating Notes
12

2-
Date: 10-Jan-2017
3-
Subj: Glassfish notes for this operation
3+
- 2018-08-16 - update
4+
- 2017-01-10
45

5-
The ports are adjusted to avoid conflicts with other services
6-
The settings are in file glassfish4/glassfish/domains/domain1/config/domain.xml
7-
http-listener-1 8102
8-
http-listener-2 8202
9-
admin-listener 8343
6+
To **change ports**, look for the following, default listener in the settings file **glassfish4/glassfish/domains/domain1/config/domain.xml**
107

11-
to see logs
12-
tail -f glassfish-8102-4.1.1/glassfish4/glassfish/domains/domain1/logs/server.log
13-
tail -f glassfish-8102-4.1.1/glassfish4/glassfish/domains/domain1/logs/intmag.log
8+
- http-listener-1 8102
9+
- http-listener-2 8202
10+
- admin-listener 8343
1411

15-
to start
16-
glassfish4/glassfish/bin/asadmin start-domain
12+
To **start** glassfish, use the following command.
13+
```
14+
glassfish4/glassfish/bin/asadmin start-domain
15+
```
16+
Note: the admin-listener port parameter **-- port 8348** may be needed. i.e.
17+
```
18+
glassfish4/glassfish/bin/asadmin --port 8348 start-domain
19+
```
1720

18-
to check system properties, wssConfigDir must be correctly set
19-
note: must use admin-listener port on all admin commands, port: 8343
20-
admin user name: admin
21-
admin pw: cube1iris
21+
To **stop**
22+
```
23+
glassfish4/glassfish/bin/asadmin stop-domain
24+
```
2225

23-
to get use a service
24-
http://cube1:8102/intmag/wssversion
25-
http://cube1:8102/intmag/v2/swagger
26+
To specify the WSS configuration file location, the Java property, wssConfigDir must be set explicitly to the path for the cfg files. The cfg files may be located at any convenient path. **to set wssConfigDir**
27+
```
28+
glassfish4/glassfish/bin/asadmin create-system-properties wssConfigDir=$(pwd)/glassfish/domains/domain1/wss_config
29+
```
2630

27-
to stop
28-
glassfish4/glassfish/bin/asadmin stop-domain
31+
Glassfish does not recognize the convention that Tomcat uses to create a context name based on "#" characters in the the war file name. If this does not matter, autodeploy may be used, see discussion below, however, to **deploy with a specific context, like fdsnws/event/1**, the context must be set explicitly with a deploy command:
32+
```
33+
glassfish4/glassfish/bin/asadmin deploy --contextroot fdsnws/event/1 /path/to/webserviceshell-2.4.war
34+
```
2935

30-
to replace web service, the server usually needs to be shutdown
31-
- shows up as errors related to stale file
32-
- it seems to be problem on cube1 where nfs mounts are used to provide the file system
33-
rm glassfish4/glassfish/domains/domain1/autodeploy/intmag.war
34-
glassfish4/glassfish/bin/asadmin stop-domain
35-
rm -rf glassfish4/glassfish/domains/domain1/applications/intmag/
36-
glassfish4/glassfish/bin/asadmin start-domain
37-
cp ~/transient/webserviceshell-2.3.war glassfish4/glassfish/domains/intmag.war
38-
mv glassfish4/glassfish/domains/intmag.war glassfish4/glassfish/domains/domain1/autodeploy/
36+
To **see logs**, check the domain1/logs folder for the server.log and WSS logs
37+
```
38+
tail -f glassfish4/glassfish/domains/domain1/logs/server.log
39+
tail -f glassfish4/glassfish/domains/domain1/logs/xyz_app.log
40+
```
3941

42+
**Using autodeploy:** autodeploy works as expected on OS X (excepting not recognizing "#"), but may not work reliably if NFS mounts are used to provide the file system. **Errors related to stale file ...** indicate this problem. **If using autodeploy on an NFS file system**, the following steps for deploying a service called "intmag", may be needed:
4043

41-
to install custom log formatter
42-
cp custom-formatter-1.0-SNAPSHOT.jar glassfish4/glassfish/domains/domain1/lib/ext/
43-
edit file glassfish4/glassfish/domains/domain1/config/logging.properties
44-
update GFFIleHandler.formatter to
45-
com.sun.enterprise.server.logging.GFFileHandler.formatter=edu.iris.logging.GlassfishCustomFormatter
46-
see log properties, may need to restart
47-
glassfish4/glassfish/bin/asadmin --port 8348 restart-domain domain1
44+
```
45+
# remove war file
46+
rm glassfish4/glassfish/domains/domain1/autodeploy/intmag.war
47+
# stop server
48+
glassfish4/glassfish/bin/asadmin stop-domain
49+
# remover respective applications folder
50+
rm -rf glassfish4/glassfish/domains/domain1/applications/intmag/
51+
# start server
52+
glassfish4/glassfish/bin/asadmin start-domain
53+
# make a copy of war file with appropriate name
54+
cp ~/transient/webserviceshell-2.3.war glassfish4/glassfish/domains/intmag.war
55+
# move it into autodeploy folder
56+
mv glassfish4/glassfish/domains/intmag.war glassfish4/glassfish/domains/domain1/autodeploy/
57+
```
4858

49-
to see log properties
59+
**Optional logger installation:** For extended testing with glassfish, the **default log messages can be very verbose**, an optional custom logger is available called custom-formatter-1.0-SNAPSHOT, **to install a custom log formatter in glassfish**:
60+
61+
- Check log properties before and after changes to verify installation
62+
```
5063
glassfish4/glassfish/bin/asadmin --port 8348 list-log-attributes
64+
```
65+
- put the formatter jar file in the lib/ext folder
66+
```
67+
cp custom-formatter-1.0-SNAPSHOT.jar glassfish4/glassfish/domains/domain1/lib/ext/
68+
```
69+
- change the configuration
70+
- ** edit file** glassfish4/glassfish/domains/domain1/config/logging.properties
71+
- update property **GFFIleHandler.formatter**
72+
- the full setting is
73+
**com.sun.enterprise.server.logging.GFFileHandler.formatter=edu.iris.logging.GlassfishCustomFormatter**
5174

75+
76+
- check log properties, **a restart may be needed**
77+
```
78+
glassfish4/glassfish/bin/asadmin --port 8348 restart-domain domain1
79+
```

0 commit comments

Comments
 (0)