org.ops4j.pax.radman.gateway.jmx
Class JMXHost

java.lang.Object
  org.ops4j.pax.radman.gateway.jmx.JMXHost

All Implemented Interfaces:

java.io.Serializable, Host

public final class JMXHost
extends java.lang.Object
implements Host, java.io.Serializable

Since:

0.1.0

Author:

Edward Yakop

See Also:

Serialized Form

Constructor Summary

JMXHost(javax.management.remote.JMXServiceURL aServiceURL, java.lang.String aHostId, java.lang.String aHostIP)

Method Summary

java.lang.String	getDescription() Returns the description of this Host.
java.util.Set<HostGroup>	getHostGroups() Returns all host groups associated with this host.
java.lang.String	getHostIP() Returns the host ip address.
java.lang.String	getId() Returns the id of this host.
OSGiContainer	getOSGiContainer(java.lang.String aContainerName, boolean createWhenNotNull) Returns the container given the container name.
java.util.Set<OSGiContainer>	getOSGiContainers() Returns the osgi container installed on this host.
boolean	removeOSGiContainer(java.lang.String anId) Removes the OSGiContainer given the specified id.
void	setDescription(java.lang.String aDescription) Sets the host description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JMXHost

public JMXHost(javax.management.remote.JMXServiceURL aServiceURL,
               java.lang.String aHostId,
               java.lang.String aHostIP)

Method Detail

getId

public final java.lang.String getId()

Description copied from interface: Host

Returns the id of this host. This must not be null.

Specified by:

getId in interface Host

Returns:

The id of this host.

getHostIP

public final java.lang.String getHostIP()

Description copied from interface: Host

Returns the host ip address. This must not be null.

Specified by:

getHostIP in interface Host

Returns:

The host ip of this host instance.

getDescription

public java.lang.String getDescription()

Description copied from interface: Host

Returns the description of this Host.

Specified by:

getDescription in interface Host

Returns:

The host description.

setDescription

public void setDescription(java.lang.String aDescription)

Description copied from interface: Host

Sets the host description.

Specified by:

setDescription in interface Host

Parameters:

aDescription - The host description.

getHostGroups

public java.util.Set<HostGroup> getHostGroups()

Description copied from interface: Host

Returns all host groups associated with this host. Returns an empty set if there is no host group associated to this host.

Specified by:

getHostGroups in interface Host

Returns:

All host groups associated with this host.

See Also:

HostGroup, Collections.emptySet()

getOSGiContainers

public java.util.Set<OSGiContainer> getOSGiContainers()

Description copied from interface: Host

Returns the osgi container installed on this host.

Specified by:

getOSGiContainers in interface Host

Returns:

The osgi containers installed on this host.

getOSGiContainer

public OSGiContainer getOSGiContainer(java.lang.String aContainerName,
                                      boolean createWhenNotNull)

Description copied from interface: Host

Returns the container given the container name.

Specified by:

getOSGiContainer in interface Host

Parameters:

aContainerName - The container name. This argument must not be null.

createWhenNotNull - A boolean indicator whether to create the requested container when not found.

Returns:

The requested OSGi container.

removeOSGiContainer

public boolean removeOSGiContainer(java.lang.String anId)
                            throws java.lang.IllegalArgumentException

Description copied from interface: Host

Removes the OSGiContainer given the specified id.

Specified by:

removeOSGiContainer in interface Host

Parameters:

anId - The OSGiContainer to remove.

Returns:

true if the specified OSGiContainer is succesfully removed. false otherwise.

Throws:

java.lang.IllegalArgumentException - Thrown if the specified anId argument is null.