com.microsoft.tfs.core.clients.build
Interface IBuildServiceHost


public interface IBuildServiceHost


Method Summary
 void addBuildAgent(IBuildAgent agent)
          Provides a mechanism by which agents may be added to the list during deserialization.
 IBuildAgent createBuildAgent(java.lang.String name, java.lang.String buildDirectory)
          Creates a build agent associated with the current service host and adds it to the list of agents.
 IBuildAgent createBuildAgent(java.lang.String name, java.lang.String buildDirectory, IBuildController buildController)
          Creates a build agent associated with the current service host and adds it to the list of agents.
 IBuildController createBuildController(java.lang.String name)
          Creates a build controller associated with the current service host.
 void delete()
          Deletes the service host along with all associated controllers and agents.
 boolean deleteBuildAgent(IBuildAgent agent)
          Delete BuildAgent
 void deleteBuildController()
          Delete BuildController
 IBuildAgent findBuildAgent(java.lang.String controller, java.lang.String name)
          Find BuildAgent
 IBuildAgent[] getAgents()
          Gets the list of agents associated with this service host
 java.lang.String getBaseURL()
          Gets or sets the base URL for this service host
 IBuildServer getBuildServer()
          The build server for this service host.
 IBuildController getController()
          Gets the build controller associated with this service host
 java.lang.String getMessageQueueURL()
          Gets the message queue address.
 java.lang.String getName()
          Gets or sets the name for this service host
 java.lang.String getURI()
          Gets the URI for this service host
 boolean isRequireClientCertificates()
          Gets or sets a value indicating if the service host requires client certificates for incoming calls.
 boolean isVirtual()
          Gets a value indicating whether or not this service host is virtual.
 void releaseOwnership()
          Releases ownership of the service host.
 void save()
          Saves any changes made since the last time the save method was called.
 void setBaseURL(java.lang.String value)
           
 void setBuildAgentStatus(IBuildAgent agent, AgentStatus status, java.lang.String message)
          Set build agent status
 void setBuildController(IBuildController controller)
          Provides a mechanism by which a controller may be added to this service host during deserialization.
 void setBuildControllerStatus(ControllerStatus status, java.lang.String message)
          Set build controller status
 void setName(java.lang.String value)
           
 void setRequireClientCertificates(boolean value)
           
 void takeOwnership()
          Takes ownership of the service host.
 

Method Detail

getBuildServer

IBuildServer getBuildServer()
The build server for this service host.

Returns:

isVirtual

boolean isVirtual()
Gets a value indicating whether or not this service host is virtual. A virtual service host is dynamically allocated to machines on demand rather than statically at install time.

Returns:

getURI

java.lang.String getURI()
Gets the URI for this service host

Returns:

getName

java.lang.String getName()
Gets or sets the name for this service host

Returns:

setName

void setName(java.lang.String value)

getBaseURL

java.lang.String getBaseURL()
Gets or sets the base URL for this service host

Returns:

setBaseURL

void setBaseURL(java.lang.String value)

getMessageQueueURL

java.lang.String getMessageQueueURL()
Gets the message queue address. This field is for system use only.

Returns:

isRequireClientCertificates

boolean isRequireClientCertificates()
Gets or sets a value indicating if the service host requires client certificates for incoming calls.

Returns:

setRequireClientCertificates

void setRequireClientCertificates(boolean value)

getController

IBuildController getController()
Gets the build controller associated with this service host

Returns:

getAgents

IBuildAgent[] getAgents()
Gets the list of agents associated with this service host

Returns:

createBuildController

IBuildController createBuildController(java.lang.String name)
Creates a build controller associated with the current service host. Only one build controller may be associated with a given service host.

Parameters:
name - The name by which the controller should be referenced
Returns:
An IBuildController implementation

createBuildAgent

IBuildAgent createBuildAgent(java.lang.String name,
                             java.lang.String buildDirectory)
Creates a build agent associated with the current service host and adds it to the list of agents.

Parameters:
name - The name by which the agent should be referenced
buildDirectory -
Returns:
An IBuildAgent implementation

createBuildAgent

IBuildAgent createBuildAgent(java.lang.String name,
                             java.lang.String buildDirectory,
                             IBuildController buildController)
Creates a build agent associated with the current service host and adds it to the list of agents.

Parameters:
name - The name by which the agent should be referenced
buildDirectory - The build directory to use when running builds on the agent
buildController - The build controller to associate the agent with
Returns:
An IBuildAgent implementation

delete

void delete()
Deletes the service host along with all associated controllers and agents.


save

void save()
Saves any changes made since the last time the save method was called.


deleteBuildController

void deleteBuildController()
Delete BuildController


deleteBuildAgent

boolean deleteBuildAgent(IBuildAgent agent)
Delete BuildAgent

Parameters:
agent -
Returns:

findBuildAgent

IBuildAgent findBuildAgent(java.lang.String controller,
                           java.lang.String name)
Find BuildAgent

Parameters:
controller -
name -
Returns:

takeOwnership

void takeOwnership()
Takes ownership of the service host.


releaseOwnership

void releaseOwnership()
Releases ownership of the service host.


setBuildControllerStatus

void setBuildControllerStatus(ControllerStatus status,
                              java.lang.String message)
Set build controller status

Parameters:
status -
message -

setBuildAgentStatus

void setBuildAgentStatus(IBuildAgent agent,
                         AgentStatus status,
                         java.lang.String message)
Set build agent status

Parameters:
agent -
status -
message -

addBuildAgent

void addBuildAgent(IBuildAgent agent)
Provides a mechanism by which agents may be added to the list during deserialization.

Parameters:
agent -

setBuildController

void setBuildController(IBuildController controller)
Provides a mechanism by which a controller may be added to this service host during deserialization.

Parameters:
controller -


© 2015 Microsoft. All rights reserved.