Interface horb.orb.HORBAgent
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface horb.orb.HORBAgent

public interface HORBAgent
extends Object
HORB management agent. This object can be used either from server side objects or from management clients. There are three categories, HORB Server management, HORB object mangement, and HORB thread management in this management agent.

Pay attention to security. It is strongly recommended to set up ACL for HORBAgent.


Method Index

 o getClientHostName_Local()
returns hostname of the client for this HORB thread.
 o getClientInetAddress_Local()
returns IP address of the client for this HORB thread.
 o getClientNetAddress_Local()
returns network address of the client for this HORB thread.
 o getObjectID()
returns objectID of the current thread.
 o getObjectStatus()
returns status of HORB objects.
 o getObjectStatus(String)
returns status of a specific HORB object.
 o getPriorityHORBThread(String)
get priority of a HORB thread.
 o getServerStatus()
returns status of all HORB servers.
 o getServerStatus(int)
returns status of a HORB server serving the port.
 o getThreadStatus()
returns status of threads of all HORB object.
 o getThreadStatus(String)
returns status of threads of a HORB object.
 o isHORBServerDebugging()
returns debugging flag of the HORB server for the current thread.
 o isHORBServerDebugging(int)
returns debugging flag of the HORB server for the port.
 o resumeHORBThread(String)
resume a HORB thread.
 o resumeObject(String)
resume acception of connections to an object.
 o setHORBServerDebug(boolean)
set debug switch of the HORB server for the current thread.
 o setHORBServerDebug(int, boolean)
set debug switch of the HORB server for the port.
 o setPriorityHORBThread(String, int)
set priority of a thread.
 o stopHORBServer()
terminate the HORB server that launched the current thread.
 o stopHORBServer(int)
terminate the HORB server for the port.
 o stopHORBThread(String)
terminate a HORB thread.
 o stopObject(String)
stop acceptance of connect requests to an object.
 o suspendHORBThread(String)
suspend a HORB thread.
 o terminateHORB(int)
terminate the HORB process.
 o unRegisterObject(String)
unregister a HORB object registered by registerObject().

Methods

 o getServerStatus
  public abstract ServerStatus[] getServerStatus() throws HORBException
returns status of all HORB servers.
 o getServerStatus
  public abstract ServerStatus getServerStatus(int port) throws HORBException
returns status of a HORB server serving the port. null if no server is active for the port.
Parameters:
port - server port
 o isHORBServerDebugging
  public abstract boolean isHORBServerDebugging() throws HORBException
returns debugging flag of the HORB server for the current thread.
 o isHORBServerDebugging
  public abstract boolean isHORBServerDebugging(int port) throws HORBException
returns debugging flag of the HORB server for the port.
Parameters:
port - server port.
 o setHORBServerDebug
  public abstract void setHORBServerDebug(boolean sw) throws HORBException
set debug switch of the HORB server for the current thread. If this switch is on, all threads launced from the HORB server prints stack dump when an uncaught exception occures. This switch can also be turned on by 'horb -v' option.
Parameters:
sw - true or false
 o setHORBServerDebug
  public abstract void setHORBServerDebug(int port,
                                          boolean sw) throws HORBException
set debug switch of the HORB server for the port. If this switch is on, all threads launced from the HORB server prints stack dump when an uncaught exception occures. This switch can also be turned on by 'horb -v' option.
Parameters:
port - server port.
sw - true or false
 o stopHORBServer
  public abstract void stopHORBServer() throws HORBException
terminate the HORB server that launched the current thread.
 o stopHORBServer
  public abstract void stopHORBServer(int port) throws HORBException
terminate the HORB server for the port.
Parameters:
port - server port.
 o terminateHORB
  public abstract void terminateHORB(int exitCode) throws HORBException
terminate the HORB process.
Parameters:
exitCode - this HORB process exit with exit code.
 o getObjectStatus
  public abstract ObjectStatus[] getObjectStatus() throws HORBException
returns status of HORB objects.
 o getObjectStatus
  public abstract ObjectStatus getObjectStatus(String objectID) throws HORBException
returns status of a specific HORB object.
 o unRegisterObject
  public abstract void unRegisterObject(String objectID) throws NoObjectException, HORBException
unregister a HORB object registered by registerObject().
Parameters:
objectID - object ID of the object to be unregistered.
Throws: NoObjectException
no such object found
 o stopObject
  public abstract void stopObject(String objectID) throws HORBException
stop acceptance of connect requests to an object. If one tries to connect the object, the request will fail.
Parameters:
objectID - object ID to be stopped.
 o resumeObject
  public abstract void resumeObject(String objectID) throws HORBException
resume acception of connections to an object.
Parameters:
objectID - object ID to be resumed.
 o getObjectID
  public abstract String getObjectID() throws HORBException
returns objectID of the current thread. Since one daemon object can have multiple threads for requests, several threads can have the same object name. This method intends to be used from a server object (HORB object). At the client side, you can obtain the objectID of a remote object from the proxy object, by using _getObjectURL().
  How to get objectID at client side:
	  Foo_Proxy remote = new Foo_Proxy(horbURL);
	  HorbURL url = remote._getObjectURL();
	  String objectID = url.getObjectID();
  How to get objectID at server side:
	  HORBAgent agent = new HORBAgent_Impl();
	  String objectID = agent.objectID();
Throws: HORBException
if the current thread is not a HORB thread.
 o getClientNetAddress_Local
  public abstract byte[] getClientNetAddress_Local() throws HORBException
returns network address of the client for this HORB thread. This method intends to be used at server side. So, this does not make sense when this is called remotely.
Throws: HORBException
if the current thread is not a HORB thread.
 o getClientInetAddress_Local
  public abstract InetAddress getClientInetAddress_Local() throws HORBException
returns IP address of the client for this HORB thread. This method intends to be used at server side. So, this does not make sense when this is called remotely.
Throws: HORBException
if the current thread is not a HORB thread.
 o getClientHostName_Local
  public abstract String getClientHostName_Local() throws HORBException
returns hostname of the client for this HORB thread. If hostname lookup fails, this method returns null. This method intends to be used at server side. So, this does not make sense when this is called remotely.
Throws: HORBException
if the current thread is not a HORB thread.
 o stopHORBThread
  public abstract void stopHORBThread(String threadName) throws HORBException
terminate a HORB thread.
Parameters:
threadName - HORB thread to be terminated.
 o suspendHORBThread
  public abstract void suspendHORBThread(String threadName) throws HORBException
suspend a HORB thread.
Parameters:
threadName - HORB thread to be suspended.
 o resumeHORBThread
  public abstract void resumeHORBThread(String threadName) throws HORBException
resume a HORB thread.
Parameters:
threadName - HORB thread to be resumed.
 o setPriorityHORBThread
  public abstract void setPriorityHORBThread(String threadName,
                                             int newPriority) throws IllegalArgumentException, HORBException
set priority of a thread.
Parameters:
newPriority - new priority. Value should be within the range Thread.MIN_PRIORTY, Thread.MAX_PRIORITY.
 o getPriorityHORBThread
  public abstract void getPriorityHORBThread(String threadName) throws HORBException
get priority of a HORB thread.
 o getThreadStatus
  public abstract ThreadStatus[] getThreadStatus() throws HORBException
returns status of threads of all HORB object.
 o getThreadStatus
  public abstract ThreadStatus[] getThreadStatus(String objectID) throws HORBException
returns status of threads of a HORB object.
Parameters:
objectID - return threads' status concerning to objectID.

All Packages  Class Hierarchy  This Package  Previous  Next  Index