com.splunk
Class DeploymentClient

java.lang.Object
  extended by com.splunk.Resource
      extended by com.splunk.Entity
          extended by com.splunk.DeploymentClient
All Implemented Interfaces:
java.util.Map<java.lang.String,java.lang.Object>

public class DeploymentClient
extends Entity

The DeploymentClient class represents a Splunk deployment client, providing access to deployment client configuration and status.


Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Field Summary
 
Fields inherited from class com.splunk.Resource
actions, path, service, title
 
Method Summary
protected  java.lang.String actionPath(java.lang.String action)
          Displays the action path.
 void disable()
          Disables the deployment client.
 void enable()
          Enables the deployment client.
 java.lang.String[] getServerClasses()
          Returns the list of server classes.
 java.lang.String getTargetUri()
          Returns the target URI of the deployment server for this deployment client.
 void reload()
          Reloads the deployment client from the configuration file.
 
Methods inherited from class com.splunk.Entity
clear, containsKey, containsValue, entrySet, get, getMetadata, isDisabled, isEmpty, keySet, put, putAll, refresh, remove, remove, size, update, validate, values
 
Methods inherited from class com.splunk.Resource
getActions, getName, getPath, getService, getTitle, invalidate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Method Detail

actionPath

protected java.lang.String actionPath(java.lang.String action)
Displays the action path.

Overrides:
actionPath in class Entity
Parameters:
action - The requested action.
Returns:
The action path.

disable

public void disable()
Disables the deployment client.

Overrides:
disable in class Entity

enable

public void enable()
Enables the deployment client.

Overrides:
enable in class Entity

getServerClasses

public java.lang.String[] getServerClasses()
Returns the list of server classes.

Returns:
The list of server classes, or null if not specified.

getTargetUri

public java.lang.String getTargetUri()
Returns the target URI of the deployment server for this deployment client.

Returns:
The target URI of the deployment server in the format "server:port", or null if not specified.

reload

public void reload()
Reloads the deployment client from the configuration file.

Overrides:
reload in class Entity