# | Line 1 | Line 1 | |
---|---|---|
1 | < | i-scream Server Startup |
2 | < | ======================= |
1 | > | i-scream Server README |
2 | > | ====================== |
3 | ||
4 | < | Current startup sequence: |
4 | > | Compiling |
5 | > | --------- |
6 | ||
7 | < | uk.ac.ukc.iscream.core.Core |
8 | < | uk.ac.ukc.iscream.clientinterface.ClientInterfaceMain |
8 | < | uk.ac.ukc.iscream.dbinterface.DBInterfaceMain |
9 | < | uk.ac.ukc.iscream.filtermanager.FilterManager |
10 | < | uk.ac.ukc.iscream.rootfilter.RootFilterMain |
11 | < | uk.ac.ukc.iscream.filter.FilterMain |
7 | > | The server can now easily be compiled without worrying about setting up any |
8 | > | of the CLASSPATH's, or setting the path to JacORB. It's all self contained. |
9 | ||
10 | < | In it's current state just typing "make run" will compile and package the |
14 | < | whole server. However, only the Core can be run from this until the branch |
15 | < | is merged back onto the main tree and the ComponentManager integrated. |
10 | > | Typical sequence to compile; |
11 | ||
12 | + | ./configure |
13 | + | make build |
14 | + | make install prefix=/some/path |
15 | + | make clean |
16 | + | |
17 | + | In more detail, the first line ensures that the required libraries are |
18 | + | available, and sets the Makefiles up so they know where everything is. |
19 | + | The second line compiles all of the code and creates a JAR file in the |
20 | + | build directory. |
21 | + | The install line installs the server and libraries to a given location, |
22 | + | along with the configuration files. |
23 | + | Finally, the last line cleans up. |
24 | + | |
25 | + | Running |
26 | + | ------- |
27 | + | |
28 | + | It is recommended that the components are started up in the following order. |
29 | + | |
30 | + | (This can be on multiple hosts if required, as long as the order is correct). |
31 | + | |
32 | + | Core |
33 | + | ClientInterfaceMain |
34 | + | DBInterface |
35 | + | FilterManager |
36 | + | RootFilter |
37 | + | FilterMain |
38 | + | |
39 | + | It is not necessary to start both the ClientInterfaceMain and DBInterface, |
40 | + | the server will handle only one or both. Multiple Filter's can be started |
41 | + | as required. |
42 | + | |
43 | + | These are all loaded through the ComponentManager. More details on how to |
44 | + | operate this will be provided later on. Typing "make run" will make an |
45 | + | attempt to load it up. |
46 | + | |
47 | + | Check build/etc/default.properties to set the startup list and order. |
48 | + | |
49 | nb. You will need to ensure that the relevant libraries are in the | |
50 | build/lib directory. See the README in there for details. | |
51 | + | |
52 | + | Makefile |
53 | + | ======== |
54 | + | The following targets are available; |
55 | + | |
56 | + | build |
57 | + | |
58 | + | Compile the entire server package, include the IDL file. Generates the |
59 | + | JAR file for the final package. |
60 | + | |
61 | + | run |
62 | + | |
63 | + | Run's the server from the JAR file in /build. |
64 | + | |
65 | + | clean |
66 | + | |
67 | + | Cleans all compiled code, and javadoc pages. |
68 | + | |
69 | + | distclean |
70 | + | |
71 | + | Also cleans files left by configure, including the libraries. |
72 | + | |
73 | + | install |
74 | + | |
75 | + | Installs the server to a given directory. Also takes a prefix; |
76 | + | make install prefix = /usr/i-scream |
77 | + | |
78 | + | cvsbuild |
79 | + | |
80 | + | Builds any tagged version of the server from CVS. This saves the need to |
81 | + | checkout a version to build it, as it's all done automatically; |
82 | + | make install rev = RELEASE_1 |
83 | + | Default tag is HEAD. |
84 | + | |
85 | + | javadoc |
86 | + | |
87 | + | Builds all the javadoc pages in the `doc' directory. |
– | Removed lines |
+ | Added lines |
< | Changed lines |
> | Changed lines |