Interface Jaguar::Management

An interface for managing a running Jaguar CTS Server.

Operation Index

• checkFeatureLicensed
• control
• flushStaticPageCache
• getenv
• getServer
• getServerVersion
• getStatus
• isOEMLicensed
• memory
• refresh
• restart
• setAdmin
• setJagadminPassword
• setReady
• shutdown
• start

Operations

• checkFeatureLicensed

  Check the Licence Type and check for the feature enabling(OTS, Cluster) This returns zero if feature is licensed. Returns non zero if error which includes error code.

      long checkFeatureLicensed
      (
          in string feature
      );
  

• control

  Call a control method on a service component.

      long control
      (
          in string service,
          in string command
      );
  

  This returns a user-defined status (see CtsServices::ControlService). Returns -1 on failure to call the ControlService's control operation.

• flushStaticPageCache

  Flush the entire contents of the static page cache. The 'name' parameter is currently ignored and is provided for future support of flushing multiple named caches.

      void flushStaticPageCache
      (
          in string name
      );
  

• getenv

  Retrieve an environment variable from the server's run time environment.

      string getenv
      (
          in string var
      );
  

  Return "" if variable is not defined.

• getServer

  Return the server's name.

      string getServer
      (
      );
  

• getServerVersion

  Return the server's version.

      string getServerVersion
      (
      );
  

• getStatus

  Return a string describing the server's status. The expected response for a server in a mode of normal operation is "ready".

      string getStatus
      (
      );
  

• isOEMLicensed

  Checks if the license was issued by OEM

      long isOEMLicensed
      (
      );
  

• memory

  Run a memory management command.

      void memory
      (
          in string cmd,
          in string arg
      );
  

  The available commands are:

  • memory("check", "off")
  • memory("check", "on")
  • memory("dump", "")
  • memory("dump", "data")
  • memory("trace", "off")
  • memory("trace", "on")

• refresh

  Refresh a Server, Package, Component or PermCache so that changes to properties or implementations take effect immediately without requiring a server restart.

      void refresh
      (
          in string entityType,
          in string entityName
      );
  

• restart

  Restart the server. Note that a client using this method should be prepared to catch the CORBA::COMM_FAILURE system exception.

      void restart
      (
      );
  

• setAdmin

  Place the server in "admin" mode, for the specified reason. If the server was previously in "ready" mode, you must follow this with a call to restart for the "admin" mode to take effect.

      void setAdmin
      (
          in string reason
      );
  

• setJagadminPassword

  Set the jagadmin password. The current user must be jagadmin. The current jagadmin password must be correct. The new password cannot be blank, and it cannot contain any \t, \b, or \n characters.

      boolean setJagadminPassword
      (
          in string currentPassword,
          in string newPassword,
          in string serverName,
          out string output
      );
  

• setReady

  Place the server in "ready" mode. This operation is used to manually move a server from "admin" mode to "ready" mode.

      void setReady
      (
      );
  

• shutdown

  Shutdown the server. Note that a client using this method should be prepared to catch the CORBA::COMM_FAILURE system exception.

      void shutdown
      (
      );
  

• start

  Start a new thread to execute the 'run' operation on 'thread'. The 'group' parameter is the name of the thread group into which the thread will be placed.

      void start
      (
          in string group,
          in Object thread
      );