The Provisioning interface allows you to define and manage your Guided Search applications programmatically.
It contains the following methods:
defineApplication(ApplicationType application)
Defines an application.
ApplicationType parameters:
applicationID identifies the application to use.
hosts is a collection of HostType objects, representing the hosts to define.
components is a collection of ComponentType objects (such as ForgeComponentType, DgraphComponentType, and so on) representing the components to define.
scripts is a collection of ScriptType objects.
Throws:
EACFault is the error message returned by the Application Controller when the method fails.
ProvisioningFault is a list of provisioning errors and a list of provisioning warnings thrown when there are fatal errors during provisioning.
Returns:
getApplication(IDType getApplicationInput)
Gets an application, which is composed of hosts, components, and scripts and identified by an application ID.
IDType parameter:
Throws:
Returns:
getCanonicalApplication(IDType getCanonicalApplicationInput)
The getCanonicalApplication() method returns the provisioning just as getApplication() does, but with all paths canonicalized.
This process ensures that all paths are absolute, and that the working directory and log path settings are provided. It also prevents .. from being used in a path name.
IDType parameter:
Throws:
Returns:
listApplicationIDs(listApplicationIDsInput)
Lists the applications that are defined.
Returns:
Throws:
removeApplication(RemoveApplicationType removeApplicationInput)
Removes the named application.
RemoveApplicationType parameter:
Throws:
EACFault is the error message returned by the Application Controller when the method fails.
ProvisioningFault is a list of provisioning errors and a list of provisioning warnings thrown when there are fatal errors during provisioning.
Returns:
addComponent(AddComponentType addComponentInput)
Adds a single component to an application.
AddComponentType parameters:
applicationID identifies
the application to use.
component is one of the
following: Forge, Dgidx, Dgraph, LogServer, ReportGenerator
Throws:
EACFault is the error
message returned by the Application Controller when the method fails.
ProvisioningFault is a
list of provisioning errors and a list of provisioning warnings thrown when
there are fatal errors during provisioning.
Returns:
removeComponent(RemoveComponentType removeComponentInput)
Removes a single component from an application.
RemoveComponentType parameters:
applicationID identifies the application to use.
componentID identifies the component to use.
forceRemove indicates whether or not a remove operation should force the component to stop before attempting the remove. If the component is running, and forceRemove is not set to true, then the remove call will fail.
Throws:
EACFault is the error message returned by the Application Controller when the method fails.
ProvisioningFault is a list of provisioning errors and a list of provisioning warnings thrown when there are fatal errors during provisioning.
Returns:
updateComponent(UpdateComponentType updateComponentInput)
Updates a running component.
UpdateComponentType parameters:
applicationID identifies
the application to use.
component is one of the
following: Forge, Dgidx, Dgraph, LogServer, ReportGenerator.
forceUpdate indicates that
the Application Controller will attempt to force the conditions under which the
update can take place, by stopping running components.
Throws:
EACFault is the error
message returned by the Application Controller when the method fails.
ProvisioningFault is a
list of provisioning errors and a list of provisioning warnings thrown when
there are fatal errors during provisioning.
Returns:
addHost(AddHostType addHostInput)
Adds a host to an application.
AddHostType parameters:
applicationID identifies the application to use.
host is a HostType object specifying the host to add.
directories allows you to specify directories using a full path and a name. These directories are associated with hosts and created when the host is provisioned.
Throws:
EACFault is the error message returned by the Application Controller when the method fails.
ProvisioningFault is a list of provisioning errors and a list of provisioning warnings thrown when there are fatal errors during provisioning.
Returns:
updateScript(UpdateScriptType updateScriptInput)
Updates a running script.
UpdateScriptType parameters:
applicationID identifies the application to use.
script is a ScriptType object specifying the script to be updated.
forceUpdate is a Boolean that indicates whether the Application Controller should force a running script to stop before attempting the update.
Throws:
EACFault is the error message returned by the Application Controller when the method fails.
ProvisioningFault is a list of provisioning errors and a list of provisioning warnings thrown when there are fatal errors during provisioning.
Returns:
removeHost(RemoveHostType removeHostInput)
Removes a single host from an application.
RemoveHostType parameters:
applicationID identifies the application to use.
hostID is a unique string identifier for this host.
forceRemove indicates whether or not the Application Controller should force any running components or services to stop before attempting the remove. If a component or service is running, and forceRemove is not set to true, then the remove call will fail.
Throws:
EACFault is the error message returned by the Application Controller when the method fails.
ProvisioningFault is a list of provisioning errors and a list of provisioning warnings thrown when there are fatal errors during provisioning.
Returns:
updateHost(UpdateHostType updateHostInput)
Updates a running host.
UpdateHostType parameters:
applicationID identifies the application to use.
host is a HostType object specifying the host to add.
directories allows you to specify directories using a full path and a name. These directories are associated with hosts and created when the host is provisioned.
forceUpdate indicates that the Application Controller will attempt to force the conditions under which the update can take place, by stopping running components or services.
Throws:
EACFault is the error message returned by the Application Controller when the method fails.
ProvisioningFault is a list of provisioning errors and a list of provisioning warnings thrown when there are fatal errors during provisioning.
Returns:
addScript(AddScriptType addScriptInput)
Adds a script to an application.
AddScriptType parameters:
Throws:
EACFault is the error message returned by the Application Controller when the method fails.
ProvisioningFault is a list of provisioning errors and a list of provisioning warnings thrown when there are fatal errors during provisioning.
Returns:
removeScript(RemoveScriptType removeScriptInput)
Removes a script from an application.
RemoveScriptType parameters:
applicationID identifies the application to use.
scriptID is a unique string identifier for this host.
forceRemove indicates that the Application Controller will attempt to force the conditions under which the remove can take place.
Throws:
EACFault is the error message returned by the Application Controller when the method fails.
ProvisioningFault is a list of provisioning errors and a list of provisioning warnings thrown when there are fatal errors during provisioning.
Returns:
