src/java/_INSTALL
branchstart-work-070517
changeset 253 cbca0358c49c
parent 251 7c9f587ea67b
child 254 191c5ce5982d
     1.1 --- a/src/java/_INSTALL	Sat Nov 24 11:58:00 2007 +0100
     1.2 +++ b/src/java/_INSTALL	Sat Nov 24 18:27:38 2007 +0100
     1.3 @@ -1,4 +1,4 @@
     1.4 -Install and start the whole isac-system within eclipse
     1.5 +Install isac-system for java-developers within eclipse
     1.6  WN0511, WN071122 (eclipse 3.3 on ginkgo) 
     1.7  
     1.8  We relate all directories below to the following bases (which actually may
     1.9 @@ -9,20 +9,29 @@
    1.10  	$cvs$                   /$eclipse_workspace$/proto2/isac/
    1.11  	$eclipse$		        /usr/local/eclipse/
    1.12  	
    1.13 -	$demo_instal$			IST/netshares/commons/isac/proto2/
    1.14 +	$demo_instal$	isacdev@pear.ist.intra:/mnt/hda7/isacdev/workspace/proto2/
    1.15  
    1.16 -INSTALL:
    1.17 -
    1.18 +==============================================================================
    1.19 +install the isac-system:
    1.20 +~~~~~~~~~~~~~~~~~~~~~~~~
    1.21  #-1# prepare connection to isac's cvs-repository: see
    1.22  	$cvs$/_INFO-eclipse-cvs.txt and/or 
    1.23  	$cvs$/_INFO-eclipse-cvs-windows.txt how to setup passwordless ssh
    1.24  	check success with ...
    1.25    # 	ssh _username_@gw.ist.tugraz.at 
    1.26 -	..which must not request for a password any more.
    1.27 +	..which must not request for a password any more !!!
    1.28  
    1.29  -------------------
    1.30 +#0..2# TODO...see java 288ff
    1.31  # # checking out a project from a cvs repository (=title in help)
    1.32  
    1.33 +...
    1.34 +
    1.35 +    <proto2><Properties><Java Build Path><Default Output Folder> ..$bytecode$
    1.36 +    (the _whole_ path; with "proto2/bin-all/" dirs parallel to java would be
    1.37 +    deleted on building/clenaning the project; such dirs, however, are required in )
    1.38 +...
    1.39 +TODO 
    1.40  -------------------
    1.41  #0# setup an _empty_ project in eclipse:
    1.42    # mkdir $eclipse_workspace$/proto2/
    1.43 @@ -50,7 +59,7 @@
    1.44  ((manually this is:
    1.45  cvs -d :ext:USER@gw.ist.tugraz.at:/netshares/commons/isac/.cvs checkout isac 
    1.46  ))
    1.47 -  !!!!! See _DIR-STRUCTURE for DELETting certain directories
    1.48 +  !!!!! See _DIR-STRUCTURE for DELETing certain directories
    1.49          			
    1.50  #2# eclipse project setup:
    1.51  	(<rMouse> on proto2)<Properties><Java Build Path>: 
    1.52 @@ -63,10 +72,10 @@
    1.53  	$eclipse$/plugins/org.junit_3.8.1/junit.jar
    1.54      (these jars _must_ be located _within_ the eclipse installation;
    1.55      see proto2/.classpath if all libs are recorded)
    1.56 -  Now the red cross in the package-explorer should have disappeared.
    1.57 +  Now the red cross in the package-explorer should have disappeared !!!
    1.58    
    1.59  #3# generate "~/.java.policy":
    1.60 -/------------------------------------------------------------------------------------------------------------------------------------------------------------
    1.61 +/----------------------------------------------------------------------------------------------------\
    1.62  grant {
    1.63    permission java.net.SocketPermission "*:1024-65535", "connect,accept";
    1.64    permission java.net.SocketPermission "*:80", "connect";
    1.65 @@ -76,47 +85,38 @@
    1.66  grant {
    1.67    permission java.io.FilePermission "<<ALL FILES>>", "read, write, delete, execute", signedBy "ISAC";
    1.68  };
    1.69 -\------------------------------------------------------------------------------------------------------------------------------------------------------------
    1.70 +\----------------------------------------------------------------------------------------------------/
    1.71  comment to the file above:
    1.72    permission java.io.FilePermission "/$cvs$/", "read, write, execute";
    1.73  must have the _ABSOLUTE_ path ......~~~~~~~
    1.74  
    1.75 -#4# create property-files for the main's arguments
    1.76 -    # mkdir $cvs$/src/java/properties
    1.77 -    # copy each _TEMPLATE_ into this directory and adapt the paths
    1.78 -      e.g. _TEMPLATE_KEStore.properties --> KEStore.properties
    1.79 -
    1.80 -#5# create directoy with html-files for examples and math knowledge
    1.81 +#4# create directoy with html-files for examples and math knowledge
    1.82      # mkdir $eclipse_workspace$/proto2/www
    1.83      # mkdir $eclipse_workspace$/proto2/www/kbase/
    1.84      # $eclipse_workspace$/proto2/www> scp -r $demo_instal$/www/kbase/* .
    1.85  
    1.86 -#6# create the 'run configuration' for the class 'KEStore':
    1.87 -	open "isac.kestore.KEStore.java" in the 'java perspective', 
    1.88 -	<Run As> <Java Application> by <Run><Run> add the Argument:
    1.89 -		$cvs$isac/src/java/properties/KEStore.properties
    1.90 -	and edit this ....................^^^^^^^^^^^^^^^^^^ file according
    1.91 -	to _TEMPLATE-KEStore.properties
    1.92 +#5# create property-files for the main's arguments
    1.93 +    # mkdir $cvs$/src/java/properties
    1.94 +      AND PUT IT INTO .cvsignore (these files would destroy other installations):
    1.95 +      > emacs $cvs$/src/java/.cvsignore &
    1.96 +    # copy each _TEMPLATE_ into this directory and adapt the paths
    1.97 +      e.g. _TEMPLATE_KEStore.properties --> KEStore.properties
    1.98  
    1.99 -    attention: ABSOLUTE paths !
   1.100 -
   1.101 -	ONLY FOR THIS MODULE add VM-Argument
   1.102 -      -Djava.rmi.server.codebase=file:///$bytecode$
   1.103 -
   1.104 -#7# generate "$bytecode$/../sml/bridge.ini" used in #10#:
   1.105 -/-----------------------------------------------------------------------------------------------------------------------------
   1.106 +#6# prepare connection of BridgeMain to sml mathengine:
   1.107 +  #a# generate "$bytecode$/../sml/bridge.ini" (referenced in BridgeMain.properties)
   1.108 +/------------------------------------------------------------------------\
   1.109  transportMode=string
   1.110  socketPort=5555
   1.111  #_ABSOLUTE_ path to the java bytecode (MUST end with "/"):
   1.112  path=/$bytecode$/
   1.113  waitMillis=10000
   1.114  #_ABSOLUTE_ path to script for starting the isac-SML binary with Poly/ML
   1.115 -#and for BridgeLog/, see #9:
   1.116 +#and for BridgeLog/, see $cvs$/src/java/_INSTALL #6#b# #6#c#
   1.117  kernelExec=/$bytecode$/../sml/START_ISABELLE_2002
   1.118  kernelArgs=
   1.119 -\-----------------------------------------------------------------------------------------------------------------------------
   1.120 -
   1.121 -#8# generate "$bytecode$/../sml/START_ISABELLE_2002" used in #7# and make it executable
   1.122 +\------------------------------------------------------------------------/
   1.123 +  TODO: insert bridge.ini into BridgeMain.properties 
   1.124 +  #b# generate "$bytecode$/../sml/START_ISABELLE_2002" and make it executable
   1.125  	the SML-process of the isac-kernel (heap located at 
   1.126  	"/usr/local/Isabelle2002/heaps/polyml-4.1.3_x86-linux/HOL-Real-Isac") 
   1.127  	is started using the Isabelle-binary in 
   1.128 @@ -127,51 +127,87 @@
   1.129  	#####################################################################
   1.130         
   1.131         for running SML-process locally on nb:
   1.132 -/------------------------------------------------------------------------------------------
   1.133 +/------------------------------------------------------------------------------------\
   1.134    /usr/local/Isabelle2002/bin/isabelle HOL-Real-Isac
   1.135 -\------------------------------------------------------------------------------------------
   1.136 +\------------------------------------------------------------------------------------/
   1.137         for running SML-process remotely within IST:
   1.138 -/------------------------------------------------------------------------------------------
   1.139 +/------------------------------------------------------------------------------------\
   1.140    ssh _user_@pear.ist.intra exec /usr/local/Isabelle2002/bin/isabelle HOL-Real-Isac
   1.141 -\------------------------------------------------------------------------------------------
   1.142 +\------------------------------------------------------------------------------------/
   1.143         for running SML-process remotely at IST
   1.144 -/------------------------------------------------------------------------------------------
   1.145 +/------------------------------------------------------------------------------------\
   1.146    ssh _user_@gw.ist.tugraz.at exec /usr/local/Isabelle2002/bin/isabelle HOL-Real-Isac
   1.147 -\------------------------------------------------------------------------------------------
   1.148 +\------------------------------------------------------------------------------------/
   1.149  
   1.150         further information about the generation and handling of SML (i.e. the isac-kernel)
   1.151         via ssh in '$cvs$/src/START_ISABELLE-read.me
   1.152 -       and '$cvs$/src/java/INFO-eclpise-cvs.txt for rsa-Handling
   1.153 +       and '$cvs$/src/java/INFO-eclpise-cvs-linux.txt for rsa-Handling
   1.154 +    > ./START_ISABELLE_2002 
   1.155 +    ... should start the sml mathengine; the version is reported by ...
   1.156 +    > version_isac;
   1.157 +    > <ctrl><d> stops the sml-process again.
   1.158   
   1.159 -#9# make the _EXECUTABLE_ directory 'BridgeLog' in proto2/bin-all/sml
   1.160 -      
   1.161 -#10# create the 'run configuration' for 'isac.bridge.BridgeMain'
   1.162 -    analogously to #5# with _TEMPLATE-BridgeMain.properties      
   1.163 +  #c# generate directory $bytecode$/../sml/BridgeLog and make it executable
   1.164  
   1.165 -#11# create the 'run configuration' for 'isac.session.ObjectManager'
   1.166 -    analogously to #5# with _TEMPLATE-ObjectManager.properties      
   1.167 +#7# create the 'run configuration's for the java modules: 
   1.168 +	mark the respective module in the package explorer of the 'java perspective',
   1.169 +	<rMous><Run As> <Java Application> starts without arguments (errors!)
   1.170 +	(and inserts the module into the 'run configuration' see #8#
   1.171 +  # isac.kestore.KEStore.java
   1.172 +  # isac.bridge.BridgeMain.java
   1.173 +  # isac.session.ObjectManager.java
   1.174 +  # isac.gui.WindowApplication.java
   1.175 +  
   1.176 +#8# adapt the 'run configuration's for all modules by providing the path
   1.177 +    to the respective properties and adding certain VM-Arguments;
   1.178 +    <Run><Run> opens the configurations inserted in #7#; adapt them as follows
   1.179 +  # isac.kestore.KEStore.java arguments
   1.180 +    Program Arguments:	$cvs$isac/src/java/properties/KEStore.properties
   1.181 +    VM-Arguments:
   1.182 +  # isac.bridge.BridgeMain.java
   1.183 +    Program Arguments:	$cvs$isac/src/java/properties/BridgeMain.properties
   1.184 +    VM-Arguments:		-Djava.rmi.server.codebase=file:///$bytecode$
   1.185 +  # isac.session.ObjectManager.java
   1.186 +    Program Arguments:	$cvs$isac/src/java/properties/ObjectManager.properties
   1.187 +    VM-Arguments:		-Djava.rmi.server.codebase=file:///$bytecode$
   1.188 +  # isac.gui.WindowApplication.java
   1.189 +    Program Arguments:	$cvs$isac/src/java/properties/WindowApplication.properties
   1.190 +    VM-Arguments:
   1.191 +	
   1.192 +#9# start isac (without UserLogger):
   1.193 +  > rmiregistry 1099 &
   1.194 +  start with the green icon (>)in the second headline in this order:
   1.195 +  	KEStore  >  BridgeMain  > ObejctManager  >  WindowApplication
   1.196 +  	For initial tests take 	<username> x
   1.197 +  							<password> x
   1.198 +  							<login>
   1.199 +  	the console shows "log4j:ERROR" as long as the log4j-logger is not started.
   1.200 +  	
   1.201 +==============================================================================
   1.202 +install and start the log4j-logger:
   1.203 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   1.204 +Browse http://logging.apache.org/chainsaw/index.html
   1.205 +<Click _Download_ link for more information.>
   1.206 +<_Java Web Start_>
   1.207 +<Open with> /usr/local/jdk1.5.0_06/jre/bin/javaws
   1.208 +<Run>
   1.209  
   1.210 -#12# create the 'run configuration' for 'isac.gui.WindowApplication'
   1.211 -    analogously to #5# with _TEMPLATE-WindowApplication.properties      
   1.212 +<New SocketReceiver>
   1.213 +<name>		isac
   1.214 +<port>		4445	(see $cvs$/src/java/log4j.properties)
   1.215  
   1.216 -// LOST DURING MOVE TO DMZ on 070223 ...
   1.217 -// the WindowApplication uses the "log4j" logger for test-output; "isac/scr/java/log4j.properties" 
   1.218 -// calls the program "chainsaw" (contained in llibrary "log4j"); the output becomes visible, if
   1.219 -// "chainsaw" is started --- adapt "isac/scr/java/build.xml" accordingly.
   1.220 -// Further infos at http://jakarta.apache.org/log4j/docs/manual.html
   1.221 +==============================================================================
   1.222 +generate HTML-files for kbase:
   1.223 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   1.224 +make a 'run configuration' (see #7#8#) for isac.util.genhtml.GenHTML
   1.225 +with <Program arguments> $cvs$/src/java/properties/KEStore.properties
   1.226  
   1.227 -The 'run configuration' for BridgeMain and ObjectManager additionally require
   1.228 +For generating the knowledge shown to the user ...
   1.229 +	see $eclipse_workspace$/proto2/www/kbase/README-kbase.txt
   1.230  
   1.231 -   -Djava.rmi.server.codebase=file://$bytecode$
   1.232 -
   1.233 -
   1.234 -generate HTML-files for kbase ---> /proto2/isac/xmldata/README
   1.235 -<Run GenHTML>
   1.236 -
   1.237 -======================================================
   1.238 -
   1.239 +==============================================================================
   1.240  generate isac.jar in eclipse 3.1.2
   1.241 -----------------------------------
   1.242 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   1.243  > File -> Export ... -> Jar File -> Next
   1.244  > select components (e.g. src/java)
   1.245  > select at least 'Export Generated Class files and resources'