[jboss-cvs] JBossRemoting/docs/guide/en ...

[Tom Elrod]

  User: telrod  
  Date: 06/07/25 17:57:50

  Modified:    docs/guide/en  master.xml
  Log:
  JBREM-423 - documented how identiy works within remoting.
  
  Revision  Changes    Path
  1.28      +22 -3     JBossRemoting/docs/guide/en/master.xml
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: master.xml
  ===================================================================
  RCS file: /cvsroot/jboss/JBossRemoting/docs/guide/en/master.xml,v
  retrieving revision 1.27
  retrieving revision 1.28
  diff -u -b -r1.27 -r1.28
  --- master.xml	25 Jul 2006 21:39:58 -0000	1.27
  +++ master.xml	25 Jul 2006 21:57:50 -0000	1.28
  @@ -392,9 +392,28 @@
       remoting server’s identity.</para>
   
       <para><emphasis role="bold">org.jboss.remoting.ident.Identity</emphasis> –
  -    the identity is what uniquely identifies a remoting server instance.
  -    Typically, there is only one identity per JVM in which a remoting server
  -    is running.</para>
  +    is one of the main components remoting uses during discovery to identify
  +    remoting server instances (is actually the way it guarantees uniqueness).
  +    If have two remoting servers running on the same server, they can be
  +    uniquely identified. The reason the identity is persisted (currently only
  +    able to do this to the file system) is so if a server crashes and then
  +    restarts, can identify it when it restarts as the one that crashed
  +    (instead of being a completely new instance that is being started). This
  +    may be important from a monitoring point as would want to know that the
  +    crashed server is back online.</para>
  +
  +    <para>When creating the identity to be presisted, remoting will first look
  +    to see if a system property for 'jboss.identity' has been set already. If
  +    it has, will use that one. If not, will get the value for the
  +    'ServerDataDir' attribute of the 'jboss.system:type=ServerConfig' mbean.
  +    If can retrieve this value, will just this as the directory to write out
  +    the 'jboss.identity' file. If not, will look to see if a system property
  +    has been set for 'jboss.identity.dir'. If it has, will use this as the
  +    directory to write the 'jboss.identity' file to, otherwise, will default
  +    to '.'. If for some reason the file can not be written to, will throw a
  +    RuntimeException, which will cause the detector to error during startup.
  +    For more details on how and where the identity is persisted, can refer to
  +    org.jboss.remoting.ident.Identity.createId().</para>
   
       <para><emphasis
       role="bold">org.jboss.remoting.detection.multicast.MulticastDetector</emphasis>