JADE Java Persistence API
1.0

com.jadeworld.jade.rootschema
Class Node

java.lang.Object
  extended by com.jadeworld.jade.rootschema.Object
      extended by com.jadeworld.jade.rootschema.Node

public class Node
extends Object

A JADE runtime Node. The Node class is the class for which an instance exists for each node in a system. A node is a physical workstation participating in a particular application. A node can be a server node or a client node.

One node object exists for each logical workstation connected to the server node workstation. There is one fixed server node and one, none, or many client nodes.

A node represents a workstation that hosts the execution of one or several processes and it contains a dictionary of the processes currently active in the node. A node object is created for each JADE executable program that is running; that is, a workstation that is running two JADE applications has two node objects, or logical workstation connections, to the server.


Field Summary
 
Fields inherited from class com.jadeworld.jade.rootschema.Object
oid
 
Constructor Summary
Node()
           
 
Method Summary
 void beginIndividualRequestsLogging(int samplingHandle, boolean localRequests, boolean remoteRequests, boolean persistentCacheBuffers, boolean transientCacheBuffers, boolean remoteTransientCacheBuffers, int userNumber, java.lang.String userText)
           
 int beginSample(java.lang.String libraryName, java.lang.String initializationParameter)
           
 int downloadCount()
           
 void endIndividualRequestsLogging(int samplingHandle, int userNumber, java.lang.String userText)
           
 void endSample(int samplingHandle)
           
 void getCacheSizes(ByRef<java.lang.Integer> persistentCache, ByRef<java.lang.Integer> transientCache, ByRef<java.lang.Integer> remoteTransientCache)
          All parameters are output.
 int getCharacterSize()
           
 java.lang.String getCommandLine()
           
 java.lang.String getComputerName()
           
 java.lang.String getEnvironmentVariable(java.lang.String name)
           
 java.lang.String getIniFileName()
           
 java.lang.String getJadeInstallDir()
           
 java.lang.String getJadeJadeHomeDir()
           
 java.lang.String getJadeProgramDataDir()
           
 java.lang.String getJadeUserDataDir()
           
 java.lang.String getLineDelimiter()
           
 void getLocks(ByRef<LockArray> locks, int maxEntries)
           
 void getMutexCounts(ByRef<JadeDynamicObject> jdo, boolean includeZeroContentions)
           
 void getNotes(ByRef<NotificationArray> notes, boolean transients, int maxEntries)
           
 void getObjectCaches(ByRef<JadeDynamicObject> jdo, int cacheType)
           
 int getOSPlatform(ByRef<java.lang.String> version, ByRef<java.lang.Integer> architecture)
           
 void getProfiledProcesses(ByRef<ObjectArray> oa)
           
 java.lang.String getProfileString(java.lang.String fileName, java.lang.String section, java.lang.String keyName, java.lang.String defaultValue)
           
 void getQueuedLocks(ByRef<LockArray> locks, int maxEntries)
           
 void getRequestStats(ByRef<JadeDynamicObject> jdo)
           
 void getRpcServerStatistics(ByRef<JadeDynamicObject> jdo, boolean detailed)
           
 void getStatistics(ByRef<JadeDynamicObject> jdo)
           
 java.lang.String getTempPath()
           
 boolean isApplicationServer()
           
 boolean isCacheCoherencyEnabled()
           
 boolean isReadOnlySchema()
           
 boolean isReadOnlySystemSchema()
           
 boolean isServerNode()
           
 boolean isService()
           
 void logObjectCaches(int samplingHandle, boolean persistentCacheStats, boolean persistentCacheBuffers, boolean transientCacheStats, boolean transientCacheBuffers, boolean remoteTransientCacheStats, boolean remoteTransientCacheBuffers, int userNumber, java.lang.String userText)
           
 void logRequestStatistics(int samplingHandle, boolean local, boolean remote, int userNumber, java.lang.String userText)
           
 void logUserCommand(int samplingHandle, java.lang.String command, int userNumber, java.lang.String userText)
           
 java.lang.String name()
           
 java.lang.String networkAddress()
           
 int nodeRole()
           
 int nodeType()
           
 int osID()
           
 int osProcessId()
           
 ProcessDict<Process> processes()
           
 void setCacheSizes(int persistentCache, int transientCache, int remoteTransientCache)
           
 boolean setProfileString(java.lang.String fileName, java.lang.String section, java.lang.String keyName, java.lang.String string)
           
 void setUserExitCode(int userExitCode)
           
 System system()
           
 int userExitCode()
           
 
Methods inherited from class com.jadeworld.jade.rootschema.Object
changeObjectVolatility, creationTime, edition, equals, exclusiveLock, getClassNumberForObject, getInstanceIdForObject, getLockStatus, getName, getObjectStringForObject, getObjectVolatility, getOidString, getOidStringForObject, getPropertyValue, hashCode, hasMembers, isImportedObject, isKindOf, isLockedByMe, isObjectFrozen, isObjectNonSharedTransient, isObjectPersistent, isObjectSharedTransient, isObjectStable, isObjectTransient, isObjectVolatile, isSharedTransient, isSystemObject, isTransient, latestEdition, lock, makeObjectFrozen, makeObjectStable, makeObjectVolatile, reserveLock, sdeCauseEvent, sdsCauseEvent, setPropertyValue, sharedLock, toString, tryLock, unlock, updateObjectEdition
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Node

public Node()
Method Detail

beginIndividualRequestsLogging

public void beginIndividualRequestsLogging(int samplingHandle,
                                           boolean localRequests,
                                           boolean remoteRequests,
                                           boolean persistentCacheBuffers,
                                           boolean transientCacheBuffers,
                                           boolean remoteTransientCacheBuffers,
                                           int userNumber,
                                           java.lang.String userText)

beginSample

public int beginSample(java.lang.String libraryName,
                       java.lang.String initializationParameter)

downloadCount

public int downloadCount()

endIndividualRequestsLogging

public void endIndividualRequestsLogging(int samplingHandle,
                                         int userNumber,
                                         java.lang.String userText)

endSample

public void endSample(int samplingHandle)

getCacheSizes

public void getCacheSizes(ByRef<java.lang.Integer> persistentCache,
                          ByRef<java.lang.Integer> transientCache,
                          ByRef<java.lang.Integer> remoteTransientCache)
All parameters are output. Use persistentCache.out(), for example, to get the integer value.


getCharacterSize

public int getCharacterSize()

getCommandLine

public java.lang.String getCommandLine()

getComputerName

public java.lang.String getComputerName()

getEnvironmentVariable

public java.lang.String getEnvironmentVariable(java.lang.String name)

getIniFileName

public java.lang.String getIniFileName()

getJadeInstallDir

public java.lang.String getJadeInstallDir()

getJadeJadeHomeDir

public java.lang.String getJadeJadeHomeDir()

getJadeProgramDataDir

public java.lang.String getJadeProgramDataDir()

getJadeUserDataDir

public java.lang.String getJadeUserDataDir()

getLineDelimiter

public java.lang.String getLineDelimiter()

getLocks

public void getLocks(ByRef<LockArray> locks,
                     int maxEntries)

getMutexCounts

public void getMutexCounts(ByRef<JadeDynamicObject> jdo,
                           boolean includeZeroContentions)

getNotes

public void getNotes(ByRef<NotificationArray> notes,
                     boolean transients,
                     int maxEntries)

getOSPlatform

public int getOSPlatform(ByRef<java.lang.String> version,
                         ByRef<java.lang.Integer> architecture)

getObjectCaches

public void getObjectCaches(ByRef<JadeDynamicObject> jdo,
                            int cacheType)

getProfileString

public java.lang.String getProfileString(java.lang.String fileName,
                                         java.lang.String section,
                                         java.lang.String keyName,
                                         java.lang.String defaultValue)

getProfiledProcesses

public void getProfiledProcesses(ByRef<ObjectArray> oa)

getQueuedLocks

public void getQueuedLocks(ByRef<LockArray> locks,
                           int maxEntries)

getRequestStats

public void getRequestStats(ByRef<JadeDynamicObject> jdo)

getRpcServerStatistics

public void getRpcServerStatistics(ByRef<JadeDynamicObject> jdo,
                                   boolean detailed)

getStatistics

public void getStatistics(ByRef<JadeDynamicObject> jdo)

getTempPath

public java.lang.String getTempPath()

isApplicationServer

public boolean isApplicationServer()

isCacheCoherencyEnabled

public boolean isCacheCoherencyEnabled()

isReadOnlySchema

public boolean isReadOnlySchema()

isReadOnlySystemSchema

public boolean isReadOnlySystemSchema()

isServerNode

public boolean isServerNode()

isService

public boolean isService()

logObjectCaches

public void logObjectCaches(int samplingHandle,
                            boolean persistentCacheStats,
                            boolean persistentCacheBuffers,
                            boolean transientCacheStats,
                            boolean transientCacheBuffers,
                            boolean remoteTransientCacheStats,
                            boolean remoteTransientCacheBuffers,
                            int userNumber,
                            java.lang.String userText)

logRequestStatistics

public void logRequestStatistics(int samplingHandle,
                                 boolean local,
                                 boolean remote,
                                 int userNumber,
                                 java.lang.String userText)

logUserCommand

public void logUserCommand(int samplingHandle,
                           java.lang.String command,
                           int userNumber,
                           java.lang.String userText)

name

public java.lang.String name()

networkAddress

public java.lang.String networkAddress()

nodeRole

public int nodeRole()

nodeType

public int nodeType()

osID

public int osID()

osProcessId

public int osProcessId()

processes

public ProcessDict<Process> processes()

setCacheSizes

public void setCacheSizes(int persistentCache,
                          int transientCache,
                          int remoteTransientCache)

setProfileString

public boolean setProfileString(java.lang.String fileName,
                                java.lang.String section,
                                java.lang.String keyName,
                                java.lang.String string)

system

public System system()

userExitCode

public int userExitCode()

setUserExitCode

public void setUserExitCode(int userExitCode)

JADE Java Persistence API
1.0

Copyright © 2007 Jade Software Corporation