OpenJDK 1.23 · sun.jvmstat.monitor.MonitoredHost · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected HostIdentifier	hostId The HostIdentifier for this MonitoredHost instance.
protected int	interval The polling interval, in milliseconds, for this MonitoredHost instance.
protected Exception	lastException The last Exception encountered while polling this MonitoredHost.
private static final String	LOCAL_PROTOCOL
private static final String	LOCAL_PROTOCOL_PROP_NAME
private static final Map<HostIdentifier, MonitoredHost>	monitoredHosts
private static final String	REMOTE_PROTOCOL
private static final String	REMOTE_PROTOCOL_PROP_NAME

Access	Constructor and Description
public	MonitoredHost()

Method Summary

Modifier and Type	Method and Description
public abstract Set<Integer>	Returns: Set - the current set of active Java Virtual Machines associated with this MonitoredHost, or the empty set of none. activeVms() Return the current set of active Java Virtual Machines for this MonitoredHost.
public abstract void	addHostListener(HostListener the HostListener to add. listener) Add a HostListener.
public void	clearLastException() Clear the last exception.
public abstract void	detach(MonitoredVm the monitored Java Virtual Machine. vm) Detach from the indicated MonitoredVm.
public HostIdentifier	Returns: HostIdentifier - the resolved HostIdentifier. getHostIdentifier() Return the resolved HostIdentifier for this MonitoredHost.
public int	Returns: int - the polling interval in milliseconds for this MonitoredHost getInterval() Get the polling interval.
public Exception	Returns: Exception - the last exception occurred while polling this MonitoredHost, or `null` if no exception has occurred or the exception has been cleared, getLastException() Get the last exception encountered while polling this MonitoredHost.
public static MonitoredHost	Returns: MonitoredHost - the MonitoredHost instance for communicating with the indicated host using the protocol specified in hostIdString. getMonitoredHost(String a String representation of a `HostIdentifier` hostIdString) Factory method to construct MonitoredHost instances to manage connections to the host indicated by `hostIdString`
public static MonitoredHost	Returns: MonitoredHost - The MonitoredHost object needed to attach to the target Java Virtual Machine. getMonitoredHost(VmIdentifier The identifier for the target Java Virtual Machine. vmid) Factory method to construct a MonitoredHost instance to manage the connection to the Java Virtual Machine indicated by `vmid`.
public static MonitoredHost	Returns: MonitoredHost - The MonitoredHost object needed to attach to the target host. getMonitoredHost(HostIdentifier the identifier for the target host. hostId) Factory method to construct a MonitoredHost instance to manage the connection to the host indicated by `hostId`.
public abstract MonitoredVm	Returns: MonitoredVm - the MonitoredVm instance for the target Java Virtual Machine. getMonitoredVm(VmIdentifier the VmIdentifier specifying the target Java Virtual Machine. id) Get the MonitoredVm for the given Java Virtual Machine.
public abstract MonitoredVm	Returns: MonitoredVm - the MonitoredVm instance for the target Java Virtual Machine. getMonitoredVm(VmIdentifier the VmIdentifier specifying the target Java Virtual Machine. id, int the sampling interval for the target Java Virtual Machine. interval) Get the MonitoredVm for the given Java Virtual Machine.
public boolean	Returns: boolean - true if the MonitoredHost instance has experienced an error, or false if it hasn't or if any past error has been cleared. isErrored() Test if this MonitoredHost is in the errored state.
public abstract void	removeHostListener(HostListener the HostListener to add. listener) Remove a HostListener.
protected static HostIdentifier	Returns: HostIdentifier - a resolved HostIdentifier. resolveHostId(HostIdentifier the unresolved HostIdentifier. hostId) Method to resolve unspecified components of the given HostIdentifier by constructing a new HostIdentifier that replaces the unspecified components with the default values.
public void	setInterval(int the polling interval, in milliseconds interval) Set the polling interval for this MonitoredHost.
public void	setLastException(Exception the last exception encountered; lastException) Set the last exception encountered while polling this MonitoredHost.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

hostId	back to summary
protected HostIdentifier hostId The HostIdentifier for this MonitoredHost instance.

interval	back to summary
protected int interval The polling interval, in milliseconds, for this MonitoredHost instance.

lastException	back to summary
protected Exception lastException The last Exception encountered while polling this MonitoredHost.

LOCAL_PROTOCOL	back to summary
private static final String LOCAL_PROTOCOL

LOCAL_PROTOCOL_PROP_NAME	back to summary
private static final String LOCAL_PROTOCOL_PROP_NAME

monitoredHosts	back to summary
private static final Map<HostIdentifier, MonitoredHost> monitoredHosts

REMOTE_PROTOCOL	back to summary
private static final String REMOTE_PROTOCOL

REMOTE_PROTOCOL_PROP_NAME	back to summary
private static final String REMOTE_PROTOCOL_PROP_NAME

MonitoredHost	back to summary
public MonitoredHost()

Method Detail

activeVms back to summary

activeVms	back to summary
public abstract Set<Integer> activeVms() throws MonitorException Return the current set of active Java Virtual Machines for this MonitoredHost. The returned Set contains `Integer` instances holding the local virtual machine identifier, or lvmid for each instrumented Java Virtual Machine currently available. Returns:Set<Integer> Set - the current set of active Java Virtual Machines associated with this MonitoredHost, or the empty set of none. Exceptions MonitorException: Thrown if monitoring errors occur.

public abstract Set<Integer> activeVms() throws MonitorException

Return the current set of active Java Virtual Machines for this MonitoredHost. The returned Set contains Integer instances holding the local virtual machine identifier, or lvmid for each instrumented Java Virtual Machine currently available.

Returns:Set<Integer>

Set - the current set of active Java Virtual Machines associated with this MonitoredHost, or the empty set of none.

Exceptions

MonitorException:: Thrown if monitoring errors occur.

addHostListener	back to summary
public abstract void addHostListener(HostListener listener) throws MonitorException Add a HostListener. The given listener is added to the list of HostListener objects to be notified of MonitoredHost related events. Parameters listener:HostListener the HostListener to add. Exceptions MonitorException: Thrown if monitoring errors occur.

addHostListener

back to summary

public abstract void addHostListener(HostListener listener) throws MonitorException

Add a HostListener. The given listener is added to the list of HostListener objects to be notified of MonitoredHost related events.

Parameters

listener:HostListener: the HostListener to add.

Exceptions

MonitorException:: Thrown if monitoring errors occur.

clearLastException	back to summary
public void clearLastException() Clear the last exception.

detach	back to summary
public abstract void detach(MonitoredVm vm) throws MonitorException Detach from the indicated MonitoredVm. Parameters vm:MonitoredVm the monitored Java Virtual Machine. Exceptions MonitorException: Thrown if monitoring errors occur.

detach

back to summary

public abstract void detach(MonitoredVm vm) throws MonitorException

Detach from the indicated MonitoredVm.

Parameters

vm:MonitoredVm: the monitored Java Virtual Machine.

Exceptions

MonitorException:: Thrown if monitoring errors occur.

getHostIdentifier	back to summary
public HostIdentifier getHostIdentifier() Return the resolved HostIdentifier for this MonitoredHost. Returns:HostIdentifier HostIdentifier - the resolved HostIdentifier.

getHostIdentifier

back to summary

public HostIdentifier getHostIdentifier()

Return the resolved HostIdentifier for this MonitoredHost.

Returns:HostIdentifier: HostIdentifier - the resolved HostIdentifier.

getInterval	back to summary
public int getInterval() Get the polling interval. Returns:int int - the polling interval in milliseconds for this MonitoredHost

getInterval

back to summary

public int getInterval()

Get the polling interval.

Returns:int: int - the polling interval in milliseconds for this MonitoredHost

getLastException back to summary

getLastException	back to summary
public Exception getLastException() Get the last exception encountered while polling this MonitoredHost. Returns:Exception Exception - the last exception occurred while polling this MonitoredHost, or `null` if no exception has occurred or the exception has been cleared,

public Exception getLastException()

Get the last exception encountered while polling this MonitoredHost.

Returns:Exception: Exception - the last exception occurred while polling this MonitoredHost, or null if no exception has occurred or the exception has been cleared,

getMonitoredHost back to summary

getMonitoredHost	back to summary
public static MonitoredHost getMonitoredHost(String hostIdString) throws MonitorException, URISyntaxException Factory method to construct MonitoredHost instances to manage connections to the host indicated by `hostIdString` Parameters hostIdString:String a String representation of a `HostIdentifier` Returns:MonitoredHost MonitoredHost - the MonitoredHost instance for communicating with the indicated host using the protocol specified in hostIdString. Exceptions MonitorException: Thrown if monitoring errors occur. URISyntaxException: Thrown when the hostIdString is poorly formed. This exception may get encapsulated into MonitorException in a future revision.

public static MonitoredHost getMonitoredHost(String hostIdString) throws MonitorException, URISyntaxException

Factory method to construct MonitoredHost instances to manage connections to the host indicated by hostIdString

Parameters

hostIdString:String: a String representation of a HostIdentifier

Returns:MonitoredHost

MonitoredHost - the MonitoredHost instance for communicating with the indicated host using the protocol specified in hostIdString.

Exceptions

MonitorException:: Thrown if monitoring errors occur.
URISyntaxException:: Thrown when the hostIdString is poorly formed. This exception may get encapsulated into MonitorException in a future revision.

getMonitoredHost back to summary

getMonitoredHost	back to summary
public static MonitoredHost getMonitoredHost(VmIdentifier vmid) throws MonitorException Factory method to construct a MonitoredHost instance to manage the connection to the Java Virtual Machine indicated by `vmid`. This method provide a convenient short cut for attaching to a specific instrumented Java Virtual Machine. The information in the VmIdentifier is used to construct a corresponding HostIdentifier, which in turn is used to create the MonitoredHost instance. Parameters vmid:VmIdentifier The identifier for the target Java Virtual Machine. Returns:MonitoredHost MonitoredHost - The MonitoredHost object needed to attach to the target Java Virtual Machine. Exceptions MonitorException: Thrown if monitoring errors occur.

public static MonitoredHost getMonitoredHost(VmIdentifier vmid) throws MonitorException

Factory method to construct a MonitoredHost instance to manage the connection to the Java Virtual Machine indicated by vmid. This method provide a convenient short cut for attaching to a specific instrumented Java Virtual Machine. The information in the VmIdentifier is used to construct a corresponding HostIdentifier, which in turn is used to create the MonitoredHost instance.

Parameters

vmid:VmIdentifier: The identifier for the target Java Virtual Machine.

Returns:MonitoredHost

MonitoredHost - The MonitoredHost object needed to attach to the target Java Virtual Machine.

Exceptions

MonitorException:: Thrown if monitoring errors occur.

getMonitoredHost back to summary

getMonitoredHost	back to summary
public static MonitoredHost getMonitoredHost(HostIdentifier hostId) throws MonitorException Factory method to construct a MonitoredHost instance to manage the connection to the host indicated by `hostId`. Parameters hostId:HostIdentifier the identifier for the target host. Returns:MonitoredHost MonitoredHost - The MonitoredHost object needed to attach to the target host. Exceptions MonitorException: Thrown if monitoring errors occur.

public static MonitoredHost getMonitoredHost(HostIdentifier hostId) throws MonitorException

Factory method to construct a MonitoredHost instance to manage the connection to the host indicated by hostId.

Parameters

hostId:HostIdentifier: the identifier for the target host.

Returns:MonitoredHost

MonitoredHost - The MonitoredHost object needed to attach to the target host.

Exceptions

MonitorException:: Thrown if monitoring errors occur.

getMonitoredVm	back to summary
public abstract MonitoredVm getMonitoredVm(VmIdentifier id) throws MonitorException Get the MonitoredVm for the given Java Virtual Machine. The default sampling interval is used for the MonitoredVm instance. Parameters id:VmIdentifier the VmIdentifier specifying the target Java Virtual Machine. Returns:MonitoredVm MonitoredVm - the MonitoredVm instance for the target Java Virtual Machine. Exceptions MonitorException: Thrown if monitoring errors occur.

getMonitoredVm

back to summary

public abstract MonitoredVm getMonitoredVm(VmIdentifier id) throws MonitorException

Get the MonitoredVm for the given Java Virtual Machine. The default sampling interval is used for the MonitoredVm instance.

Parameters

id:VmIdentifier: the VmIdentifier specifying the target Java Virtual Machine.

Returns:MonitoredVm

MonitoredVm - the MonitoredVm instance for the target Java Virtual Machine.

Exceptions

MonitorException:: Thrown if monitoring errors occur.

getMonitoredVm	back to summary
public abstract MonitoredVm getMonitoredVm(VmIdentifier id, int interval) throws MonitorException Get the MonitoredVm for the given Java Virtual Machine. The sampling interval is set to the given interval. Parameters id:VmIdentifier the VmIdentifier specifying the target Java Virtual Machine. interval:int the sampling interval for the target Java Virtual Machine. Returns:MonitoredVm MonitoredVm - the MonitoredVm instance for the target Java Virtual Machine. Exceptions MonitorException: Thrown if monitoring errors occur.

getMonitoredVm

back to summary

public abstract MonitoredVm getMonitoredVm(VmIdentifier id, int interval) throws MonitorException

Get the MonitoredVm for the given Java Virtual Machine. The sampling interval is set to the given interval.

Parameters

id:VmIdentifier: the VmIdentifier specifying the target Java Virtual Machine.
interval:int: the sampling interval for the target Java Virtual Machine.

Returns:MonitoredVm

MonitoredVm - the MonitoredVm instance for the target Java Virtual Machine.

Exceptions

MonitorException:: Thrown if monitoring errors occur.

isErrored	back to summary
public boolean isErrored() Test if this MonitoredHost is in the errored state. If this method returns true, then the Exception returned by getLastException() indicates the Exception that caused the error condition. Returns:boolean boolean - true if the MonitoredHost instance has experienced an error, or false if it hasn't or if any past error has been cleared.

isErrored

back to summary

public boolean isErrored()

Test if this MonitoredHost is in the errored state. If this method returns true, then the Exception returned by getLastException() indicates the Exception that caused the error condition.

Returns:boolean: boolean - true if the MonitoredHost instance has experienced an error, or false if it hasn't or if any past error has been cleared.

removeHostListener	back to summary
public abstract void removeHostListener(HostListener listener) throws MonitorException Remove a HostListener. The given listener is removed from the list of HostListener objects to be notified of MonitoredHost related events. Parameters listener:HostListener the HostListener to add. Exceptions MonitorException: Thrown if monitoring errors occur.

removeHostListener

back to summary

public abstract void removeHostListener(HostListener listener) throws MonitorException

Remove a HostListener. The given listener is removed from the list of HostListener objects to be notified of MonitoredHost related events.

Parameters

listener:HostListener: the HostListener to add.

Exceptions

MonitorException:: Thrown if monitoring errors occur.

resolveHostId	back to summary
protected static HostIdentifier resolveHostId(HostIdentifier hostId) throws MonitorException Method to resolve unspecified components of the given HostIdentifier by constructing a new HostIdentifier that replaces the unspecified components with the default values. Parameters hostId:HostIdentifier the unresolved HostIdentifier. Returns:HostIdentifier HostIdentifier - a resolved HostIdentifier. Exceptions MonitorException: Thrown if monitoring errors occur.

resolveHostId

back to summary

protected static HostIdentifier resolveHostId(HostIdentifier hostId) throws MonitorException

Method to resolve unspecified components of the given HostIdentifier by constructing a new HostIdentifier that replaces the unspecified components with the default values.

Parameters

hostId:HostIdentifier: the unresolved HostIdentifier.

Returns:HostIdentifier

HostIdentifier - a resolved HostIdentifier.

Exceptions

MonitorException:: Thrown if monitoring errors occur.

setInterval	back to summary
public void setInterval(int interval) Set the polling interval for this MonitoredHost. Parameters interval:int the polling interval, in milliseconds

setInterval

back to summary

public void setInterval(int interval)

Set the polling interval for this MonitoredHost.

Parameters

interval:int: the polling interval, in milliseconds

setLastException	back to summary
public void setLastException(Exception lastException) Set the last exception encountered while polling this MonitoredHost. Parameters lastException:Exception the last exception encountered;

setLastException

back to summary

public void setLastException(Exception lastException)

Set the last exception encountered while polling this MonitoredHost.

Parameters

lastException:Exception: the last exception encountered;

public abstract Class MonitoredHost

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail