org.ops4j.pax.radman.gateway
Interface HostGroup

public interface HostGroup

Since:

0.1.0

Author:

Edward Yakop

Method Summary

void	addHost(Host aHost) Add the specified host to this host group.
java.lang.String	getDescription() Returns the description of this HostGroup.
java.lang.String	getHostGroupName() Returns the host group name.
java.util.Set<Host>	getHosts() Returns all host associated with this host zone.
java.lang.String	getId() Returns the host zone id.
boolean	removeHost(java.lang.String aHostId) Remove the specified host to this host group.
void	setDescription(java.lang.String aDescription) Sets the aDescription of this HostGroup.

Method Detail

getId

java.lang.String getId()

Returns the host zone id.

Returns:

The host zone id.

Since:

0.1.0

getHostGroupName

java.lang.String getHostGroupName()

Returns the host group name.

Returns:

The host group name.

Since:

0.1.0

getHosts

java.util.Set<Host> getHosts()

Returns all host associated with this host zone. Returns an empty set if there is no hosts associated with this host group.

Returns:

All host associated with this host zone.

Since:

0.1.0

See Also:

Host, Collections.emptySet()

addHost

void addHost(Host aHost)
             throws java.lang.IllegalArgumentException

Add the specified host to this host group.

Parameters:

aHost - The host to add. This argument must not be null.

Throws:

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

Since:

0.1.0

removeHost

boolean removeHost(java.lang.String aHostId)
                   throws java.lang.IllegalArgumentException

Remove the specified host to this host group.

Parameters:

aHostId - The host to remove. This argument must not be null.

Returns:

true if the specified host is succesfully removed, false otherwise.

Throws:

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

Since:

0.1.0

getDescription

java.lang.String getDescription()

Returns the description of this HostGroup.

Returns:

The description of this host zone.

Since:

0.1.0

setDescription

void setDescription(java.lang.String aDescription)

Sets the aDescription of this HostGroup.

Parameters:

aDescription - The description of this host group.

Since:

0.1.0