com.redhat.foreman

Class HostInfo

java.lang.Object

com.redhat.foreman.HostInfo

public class HostInfo
extends Object

Foreman host details. This class is immutable.

Author:

ogondza.

Constructor Summary

Constructors

Constructor and Description
HostInfo(String name, List<com.redhat.foreman.HostInfo.Parameter> parameters)

Method Summary

Modifier and Type	Method and Description
String	getJavaPath() Path to executable to be launched on node side to start the agent.
String	getLabels() String of label tokens.
Set<hudson.model.labels.LabelAtom>	getLabelSet()
String	getName() Name of the host.
String	getRemoteFs() Path to remote Jenkins FS.
String	getReservedFor() Identification of the current owner of the machine.
boolean	isReserved()
boolean	satisfies(hudson.model.Label label) Determine whether this host matches label expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

HostInfo

public HostInfo(String name,
                List<com.redhat.foreman.HostInfo.Parameter> parameters)

Method Detail

getName

public String getName()

Name of the host. It also serves the purpose of hostname/IP address.

Returns:

Name of the host.

getLabels

public String getLabels()

String of label tokens.

Returns:

String of label tokens.

getLabelSet

@Nonnull
public Set<hudson.model.labels.LabelAtom> getLabelSet()

satisfies

public boolean satisfies(@CheckForNull
                         hudson.model.Label label)

Determine whether this host matches label expression. This reverse the semantics of Label.matches(Collection) for convenience of provisioning clients as they have to deal with the label == null.

Parameters:

label - Label for matching.

Returns:

True if matches, False otherwise.

getRemoteFs

public String getRemoteFs()

Path to remote Jenkins FS.

Returns:

Path to remote Jenkins FS.

getJavaPath

@CheckForNull
public String getJavaPath()

Path to executable to be launched on node side to start the agent.

Returns:

Absolute path or null when default should be used.

getReservedFor

@CheckForNull
public String getReservedFor()

Identification of the current owner of the machine.

Returns:

True if it is reserved, False otherwise.

isReserved

public boolean isReserved()