org.ops4j.pax.radman.gateway
Interface Host

All Known Implementing Classes:

JMXHost

public interface Host

Host represent a machine that may be deployed with many OSGiContainer.

Since:

0.1.0

Author:

Edward Yakop

See Also:

OSGiContainer

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.

Method Detail

getId

java.lang.String getId()

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

Returns:

The id of this host.

Since:

0.1.0

getHostIP

java.lang.String getHostIP()

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

Returns:

The host ip of this host instance.

Since:

0.1.0

getHostGroups

java.util.Set<HostGroup> getHostGroups()

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

Returns:

All host groups associated with this host.

Since:

0.1.0

See Also:

HostGroup, Collections.emptySet()

getOSGiContainers

java.util.Set<OSGiContainer> getOSGiContainers()

Returns the osgi container installed on this host.

Returns:

The osgi containers installed on this host.

Since:

0.1.0

getOSGiContainer

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

Returns the container given the container name.

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.

Since:

0.1.0

removeOSGiContainer

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

Removes the OSGiContainer given the specified id.

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.

Since:

0.1.0

getDescription

java.lang.String getDescription()

Returns the description of this Host.

Returns:

The host description.

Since:

0.1.0

setDescription

void setDescription(java.lang.String aDescription)

Sets the host description.

Parameters:

aDescription - The host description.

Since:

0.1.0