MInstance (Project Wonder Reference Documentation)

java.lang.Object
- com.webobjects.monitor._private.MObject
- - com.webobjects.monitor._private.MInstance

All Implemented Interfaces:

NSKeyValueCoding
```
public class MInstance
extends MObject
```

Field Summary

Fields
Modifier and Type	Field and Description
`static ERXKey<MHost>`	`HOST`
`static ERXKey<String>`	`HOST_NAME`
`boolean`	`isActivelyBeingScheduled`
`int`	`state`
`static long`	`TIME_FOR_STARTUP` Startup Calculations *********

Fields inherited from class com.webobjects.monitor._private.MObject
_emptyString, _GET, _HTTP1, _POST, _zeroInteger, adaptorValues, adminActionStringPostfix, adminActionStringPrefix, ALIVE, CRASHING, DEAD, directActionString, halfHourAsSeconds, hostTypeArray, loadSchedulerArray, loadSchedulerArrayValues, schedulingIntervalArray, schedulingIntervals, schedulingTypeArray, STARTING, stateArray, STOPPING, timeOfDayArray, timesOfDay, UNKNOWN, urlVersionArray, values, weekArray, weekNames

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding
_CLASS, NullValue

Constructor Summary

Constructors
Constructor and Description
`MInstance(MHost aHost, MApplication anApplication, Integer anID, MSiteConfig aConfig)` Constructors *********
`MInstance(NSDictionary aDict, MSiteConfig aConfig)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`_takeNameFromApplication()`
`void`	`_takeOutputPathFromApplication()`
`void`	`_takePathFromApplication()`
`void`	`_takePortFromApplication()`
`void`	`_takeValueFromApplication(String valueName)`
`String`	`activeSessions()`
`int`	`activeSessionsValue()`
`void`	`addDeath()`
`String`	`additionalArgs()`
`NSArray`	`additionalArgumentsAsArray()` Command Line Arguments *********
`MApplication`	`application()`
`String`	`applicationName()`
`Boolean`	`autoOpenInBrowser()`
`Boolean`	`autoRecover()`
`String`	`averageIdlePeriod()`
`float`	`avgIdleTimeValue()`
`String`	`avgTransactionTime()`
`float`	`avgTransactionTimeValue()`
`Boolean`	`cachingEnabled()`
`void`	`calculateNextScheduledShutdown()`
`void`	`cancelForceQuitTask()` Cancel the forceQuit task if any
`Integer`	`cnctTimeout()`
`String`	`commandLineArguments()`
`NSArray`	`commandLineArgumentsAsArray()`
`int`	`deathCount()`
`NSMutableArray`	`deaths()` Deaths *********
`Boolean`	`debuggingEnabled()`
`NSDictionary`	`dictionaryForArchive()` Archiving Support *********
`String`	`displayHostAndPort()`
`String`	`displayName()` Display Name Strings *********
`boolean`	`equals(Object obj)`
`void`	`extractAdaptorValuesFromApplication()`
`void`	`failedToConnect()`
`protected float`	`floatStatisticsValueForKey(String key, float defaultValue)`
`TimerTask`	`forceQuitTask()`
`String`	`generateOutputPath(String pathEndingWithSeperator)`
`Boolean`	`gracefulScheduling()`
`int`	`hashCode()`
`MHost`	`host()`
`String`	`hostName()` 'values' accessors *********
`Integer`	`id()`
`protected int`	`intStatisticsValueForKey(String key, int defaultValue)`
`boolean`	`isAutoRecovering()`
`boolean`	`isGracefullyScheduled()`
`boolean`	`isLocal_W()`
`boolean`	`isRefusingNewSessions()`
`boolean`	`isRunning_M()`
`boolean`	`isRunning_W()`
`boolean`	`isScheduled()`
`NSTimestamp`	`lastRegistration()` Registration and Lifebeats *********
`int`	`lifebeatCheckInterval()`
`Integer`	`lifebeatInterval()`
`Integer`	`minimumActiveSessionsCount()`
`boolean`	`nearNextScheduledShutdown(NSTimestamp rightNow)`
`NSTimestamp`	`nextScheduledShutdown()`
`String`	`nextScheduledShutdownString()`
`Integer`	`oldport()` Don't use this **********
`String`	`outputPath()`
`String`	`path()`
`Integer`	`port()`
`Integer`	`recvBufSize()`
`Integer`	`recvTimeout()`
`void`	`registerCrash(NSTimestamp registrationDate)`
`void`	`registerStop(NSTimestamp registrationDate)`
`void`	`removeAllDeaths()`
`void`	`resetStatisticsError()`
`void`	`scheduleForceQuit(TimerTask task, int delay)` only one force quit task can be scheduled
`void`	`scheduleRefuseTask(TimerTask task, int delay, int period)` Schedule a task to repeatedly run
`Integer`	`schedulingDailyStartTime()`
`Boolean`	`schedulingEnabled()`
`Integer`	`schedulingHourlyStartTime()`
`Integer`	`schedulingInterval()`
`Integer`	`schedulingStartDay()`
`String`	`schedulingType()`
`Integer`	`schedulingWeeklyStartTime()`
`Integer`	`sendBufSize()`
`void`	`sendDeathNotificationEmail()`
`Integer`	`sendTimeout()`
`void`	`setAdditionalArgs(String value)`
`void`	`setApplicationName(String value)`
`void`	`setAutoOpenInBrowser(Boolean value)`
`void`	`setAutoRecover(Boolean value)`
`void`	`setCachingEnabled(Boolean value)`
`void`	`setCnctTimeout(Integer value)`
`void`	`setDeaths(NSMutableArray values)`
`void`	`setDebuggingEnabled(Boolean value)`
`void`	`setForceQuitTask(TimerTask task)`
`void`	`setGracefulScheduling(Boolean value)`
`void`	`setHostName(String value)`
`void`	`setId(Integer value)`
`void`	`setLifebeatInterval(Integer value)`
`void`	`setMinimumActiveSessionsCount(Integer value)`
`void`	`setNextScheduledShutdown(NSTimestamp newtime)`
`void`	`setNextScheduledShutdownString_M(String newtime)`
`void`	`setOldport(Integer value)`
`void`	`setOutputPath(String value)`
`void`	`setPath(String value)`
`void`	`setPort(Integer value)`
`void`	`setRecvBufSize(Integer value)`
`void`	`setRecvTimeout(Integer value)`
`void`	`setRefusingNewSessions(boolean isRefusingNewSessions)`
`void`	`setSchedulingDailyStartTime(Integer value)`
`void`	`setSchedulingEnabled(Boolean value)`
`void`	`setSchedulingHourlyStartTime(Integer value)`
`void`	`setSchedulingInterval(Integer value)`
`void`	`setSchedulingStartDay(Integer value)`
`void`	`setSchedulingType(String value)`
`void`	`setSchedulingWeeklyStartTime(Integer value)`
`void`	`setSendBufSize(Integer value)`
`void`	`setSendTimeout(Integer value)`
`void`	`setShouldDie(boolean b)`
`void`	`setStatistics(NSDictionary newStatistics)`
`void`	`setStatisticsError(String errorString)`
`void`	`setValues(NSMutableDictionary newValues)` Overridden Methods for Scheduling *********
`boolean`	`shouldDie()`
`boolean`	`shouldDieAndReset()`
`void`	`startRegistration(NSTimestamp registrationDate)`
`NSDictionary`	`statistics()`
`String`	`statisticsError()`
`void`	`succeededInConnection()`
`void`	`takeValuesFromApplication()`
`Timer`	`taskTimer()`
`String`	`toString()`
`String`	`transactions()`
`int`	`transactionsValue()`
`void`	`updateRegistration(NSTimestamp registrationDate)`
`void`	`updateValues(NSDictionary aDict)`
`void`	`willAttemptToStart()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HOST
```
public static final ERXKey<MHost> HOST
```

HOST_NAME

public static final ERXKey<String> HOST_NAME

state
```
public int state
```

TIME_FOR_STARTUP
```
public static long TIME_FOR_STARTUP
```
Startup Calculations *********

isActivelyBeingScheduled

public boolean isActivelyBeingScheduled

Constructor Detail

MInstance

public MInstance(MHost aHost,
                 MApplication anApplication,
                 Integer anID,
                 MSiteConfig aConfig)

Constructors *********

MInstance

public MInstance(NSDictionary aDict,
                 MSiteConfig aConfig)

Method Detail

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

hostName
```
public String hostName()
```
'values' accessors *********

setHostName

public void setHostName(String value)

id
```
public Integer id()
```

setId
```
public void setId(Integer value)
```

port
```
public Integer port()
```

setPort
```
public void setPort(Integer value)
```

applicationName
```
public String applicationName()
```

setApplicationName

public void setApplicationName(String value)

autoRecover
```
public Boolean autoRecover()
```

setAutoRecover

public void setAutoRecover(Boolean value)

minimumActiveSessionsCount

public Integer minimumActiveSessionsCount()

setMinimumActiveSessionsCount

public void setMinimumActiveSessionsCount(Integer value)

path
```
public String path()
```

setPath
```
public void setPath(String value)
```

cachingEnabled
```
public Boolean cachingEnabled()
```

setCachingEnabled

public void setCachingEnabled(Boolean value)

debuggingEnabled
```
public Boolean debuggingEnabled()
```

setDebuggingEnabled

public void setDebuggingEnabled(Boolean value)

outputPath
```
public String outputPath()
```

setOutputPath

public void setOutputPath(String value)

autoOpenInBrowser
```
public Boolean autoOpenInBrowser()
```

setAutoOpenInBrowser

public void setAutoOpenInBrowser(Boolean value)

lifebeatInterval
```
public Integer lifebeatInterval()
```

setLifebeatInterval

public void setLifebeatInterval(Integer value)

additionalArgs
```
public String additionalArgs()
```

setAdditionalArgs

public void setAdditionalArgs(String value)

schedulingEnabled
```
public Boolean schedulingEnabled()
```

setSchedulingEnabled

public void setSchedulingEnabled(Boolean value)

schedulingType
```
public String schedulingType()
```

setSchedulingType

public void setSchedulingType(String value)

schedulingHourlyStartTime

public Integer schedulingHourlyStartTime()

setSchedulingHourlyStartTime

public void setSchedulingHourlyStartTime(Integer value)

schedulingDailyStartTime

public Integer schedulingDailyStartTime()

setSchedulingDailyStartTime

public void setSchedulingDailyStartTime(Integer value)

schedulingWeeklyStartTime

public Integer schedulingWeeklyStartTime()

setSchedulingWeeklyStartTime

public void setSchedulingWeeklyStartTime(Integer value)

schedulingStartDay
```
public Integer schedulingStartDay()
```

setSchedulingStartDay

public void setSchedulingStartDay(Integer value)

schedulingInterval
```
public Integer schedulingInterval()
```

setSchedulingInterval

public void setSchedulingInterval(Integer value)

gracefulScheduling
```
public Boolean gracefulScheduling()
```

setGracefulScheduling

public void setGracefulScheduling(Boolean value)

sendTimeout
```
public Integer sendTimeout()
```

setSendTimeout

public void setSendTimeout(Integer value)

recvTimeout
```
public Integer recvTimeout()
```

setRecvTimeout

public void setRecvTimeout(Integer value)

cnctTimeout
```
public Integer cnctTimeout()
```

setCnctTimeout

public void setCnctTimeout(Integer value)

sendBufSize
```
public Integer sendBufSize()
```

setSendBufSize

public void setSendBufSize(Integer value)

recvBufSize
```
public Integer recvBufSize()
```

setRecvBufSize

public void setRecvBufSize(Integer value)

oldport
```
public Integer oldport()
```
Don't use this **********

setOldport

public void setOldport(Integer value)

host
```
public MHost host()
```

application
```
public MApplication application()
```

_takeNameFromApplication

public void _takeNameFromApplication()

_takePortFromApplication

public void _takePortFromApplication()

_takePathFromApplication

public void _takePathFromApplication()

_takeOutputPathFromApplication

public void _takeOutputPathFromApplication()

_takeValueFromApplication

public void _takeValueFromApplication(String valueName)

takeValuesFromApplication

public void takeValuesFromApplication()

generateOutputPath

public String generateOutputPath(String pathEndingWithSeperator)

dictionaryForArchive

public NSDictionary dictionaryForArchive()

Archiving Support *********

toString
```
public String toString()
```
Overrides:

toString in class Object

extractAdaptorValuesFromApplication

public void extractAdaptorValuesFromApplication()

displayName
```
public String displayName()
```
Display Name Strings *********

displayHostAndPort
```
public String displayHostAndPort()
```

statistics
```
public NSDictionary statistics()
```

setStatistics

public void setStatistics(NSDictionary newStatistics)

transactions
```
public String transactions()
```

activeSessions
```
public String activeSessions()
```

avgTransactionTime
```
public String avgTransactionTime()
```

averageIdlePeriod
```
public String averageIdlePeriod()
```

setStatisticsError

public void setStatisticsError(String errorString)

statisticsError
```
public String statisticsError()
```

resetStatisticsError
```
public void resetStatisticsError()
```

willAttemptToStart
```
public void willAttemptToStart()
```

failedToConnect
```
public void failedToConnect()
```

succeededInConnection
```
public void succeededInConnection()
```

isRunning_M
```
public boolean isRunning_M()
```

lifebeatCheckInterval
```
public int lifebeatCheckInterval()
```

isRunning_W
```
public boolean isRunning_W()
```

isAutoRecovering
```
public boolean isAutoRecovering()
```

isLocal_W
```
public boolean isLocal_W()
```

setShouldDie
```
public void setShouldDie(boolean b)
```

shouldDie
```
public boolean shouldDie()
```

shouldDieAndReset
```
public boolean shouldDieAndReset()
```

lastRegistration
```
public NSTimestamp lastRegistration()
```
Registration and Lifebeats *********

startRegistration

public void startRegistration(NSTimestamp registrationDate)

updateRegistration

public void updateRegistration(NSTimestamp registrationDate)

registerStop

public void registerStop(NSTimestamp registrationDate)

registerCrash

public void registerCrash(NSTimestamp registrationDate)

sendDeathNotificationEmail

public void sendDeathNotificationEmail()

deaths
```
public NSMutableArray deaths()
```
Deaths *********

setDeaths

public void setDeaths(NSMutableArray values)

deathCount
```
public int deathCount()
```

addDeath
```
public void addDeath()
```

removeAllDeaths
```
public void removeAllDeaths()
```

additionalArgumentsAsArray
```
public NSArray additionalArgumentsAsArray()
```
Command Line Arguments *********

commandLineArgumentsAsArray

public NSArray commandLineArgumentsAsArray()

commandLineArguments
```
public String commandLineArguments()
```

setValues
```
public void setValues(NSMutableDictionary newValues)
```
Overridden Methods for Scheduling *********

Overrides:

setValues in class MObject

updateValues

public void updateValues(NSDictionary aDict)

Overrides:: updateValues in class MObject

isScheduled
```
public boolean isScheduled()
```

isGracefullyScheduled

public boolean isGracefullyScheduled()

nextScheduledShutdown

public NSTimestamp nextScheduledShutdown()

setNextScheduledShutdown

public void setNextScheduledShutdown(NSTimestamp newtime)

nextScheduledShutdownString

public String nextScheduledShutdownString()

setNextScheduledShutdownString_M

public void setNextScheduledShutdownString_M(String newtime)

nearNextScheduledShutdown

public boolean nearNextScheduledShutdown(NSTimestamp rightNow)

calculateNextScheduledShutdown

public void calculateNextScheduledShutdown()

setRefusingNewSessions

public void setRefusingNewSessions(boolean isRefusingNewSessions)

isRefusingNewSessions

public boolean isRefusingNewSessions()

intStatisticsValueForKey

protected int intStatisticsValueForKey(String key,
                                       int defaultValue)

floatStatisticsValueForKey

protected float floatStatisticsValueForKey(String key,
                                           float defaultValue)

transactionsValue
```
public int transactionsValue()
```

activeSessionsValue
```
public int activeSessionsValue()
```

avgIdleTimeValue
```
public float avgIdleTimeValue()
```

avgTransactionTimeValue

public float avgTransactionTimeValue()

taskTimer
```
public Timer taskTimer()
```

cancelForceQuitTask
```
public void cancelForceQuitTask()
```
Cancel the forceQuit task if any

setForceQuitTask

public void setForceQuitTask(TimerTask task)

forceQuitTask
```
public TimerTask forceQuitTask()
```

scheduleForceQuit
```
public void scheduleForceQuit(TimerTask task,
                              int delay)
```
only one force quit task can be scheduled

Parameters:

task - - task to schedule

delay - - delay before the task is fired (milliseconds)

scheduleRefuseTask
```
public void scheduleRefuseTask(TimerTask task,
                               int delay,
                               int period)
```
Schedule a task to repeatedly run

Parameters:

task - - task to schedule

delay - - delay before the task runs (milliseconds)

period - - interval when the task is ran (milliseconds)

Class MInstance

Nested Class Summary

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

Field Summary

Fields inherited from class com.webobjects.monitor._private.MObject

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

Constructor Summary

Method Summary

Methods inherited from class com.webobjects.monitor._private.MObject

Methods inherited from class java.lang.Object

Field Detail

HOST

HOST_NAME

state

TIME_FOR_STARTUP

isActivelyBeingScheduled

Constructor Detail

MInstance

MInstance

Method Detail

hashCode

equals

hostName

setHostName

id

setId

port

setPort

applicationName

setApplicationName

autoRecover

setAutoRecover

minimumActiveSessionsCount

setMinimumActiveSessionsCount

path

setPath

cachingEnabled

setCachingEnabled

debuggingEnabled

setDebuggingEnabled

outputPath

setOutputPath

autoOpenInBrowser

setAutoOpenInBrowser

lifebeatInterval

setLifebeatInterval

additionalArgs

setAdditionalArgs

schedulingEnabled

setSchedulingEnabled

schedulingType

setSchedulingType

schedulingHourlyStartTime

setSchedulingHourlyStartTime

schedulingDailyStartTime

setSchedulingDailyStartTime

schedulingWeeklyStartTime

setSchedulingWeeklyStartTime

schedulingStartDay

setSchedulingStartDay

schedulingInterval

setSchedulingInterval

gracefulScheduling

setGracefulScheduling

sendTimeout

setSendTimeout

recvTimeout

setRecvTimeout

cnctTimeout

setCnctTimeout

sendBufSize

setSendBufSize

recvBufSize

setRecvBufSize

oldport

setOldport

host

application

_takeNameFromApplication

_takePortFromApplication