com.splunk

Class DeploymentServerClass

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.DeploymentServerClass

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.Object>

public class DeploymentServerClass
extends Entity

The DeploymentServerClass class represents a Splunk deployment server class, providing access to the configuration of a server class.

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.Entity

content, toUpdate

Fields inherited from class com.splunk.Resource

actions, path, refreshArgs, service, title

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBlacklist() Returns a list of the hosts that are excluded from this server class.
java.lang.String	getBlacklistByIndex(int index) Returns a list of excluded client addresses, by index.
boolean	getContinueMatching() Indicates whether look-ups halt on the first server match or continue to match against multiple servers.
java.lang.String	getEndpoint() Returns the URL template string, which specifies the endpoint from which content can be downloaded by a deployment client.
java.lang.String	getFilterType() Returns the filter type that is applied first.
java.lang.String	getRepositoryLocation() Returns the location on the deployment server to store the content that is to be deployed for this server class.
java.lang.String	getTargetRepositoryLocation() Returns the location on the deployment client where the content to be deployed for this server class should be installed.
java.lang.String	getTmpFolder() Returns the location of the working folder used by the deployment server.
java.lang.String	getWhitelist() Returns a list of hosts included for this server class.
java.lang.String	getWhitelistByIndex(int index) Returns a list of included client addresses, by index.
void	setBlacklistByIndex(int index, java.lang.String blacklist) Sets a specific blacklist entry.
void	setContinueMatching(boolean matching) Sets how this deployment server class controls its configurations across classes and server-specific settings.
void	setEndPoint(java.lang.String endPoint) Sets a URL template string that specifies the endpoint from which content can be downloaded by a deployment client.
void	setFilterType(java.lang.String filterType) Sets the order to apply filters: "whitelist" applies the whitelist filters first, followed by blacklist filters. "blacklist" applies the blacklist filters first, followed by whitelist filters.
void	setRepositoryLocation(java.lang.String location) Sets the location on the deployment server to store the content that is to be deployed for this server class.
void	setWhitelistByIndex(int index, java.lang.String whitelist) Sets a specific whitelist entry.

Methods inherited from class com.splunk.Entity

actionPath, clear, containsKey, containsValue, disable, enable, entrySet, get, getContent, getMetadata, isDisabled, isEmpty, isNameChangeAllowed, keySet, put, putAll, refresh, remove, remove, size, update, update, validate, values

Methods inherited from class com.splunk.Resource

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

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

getBlacklist

public java.lang.String getBlacklist()

Returns a list of the hosts that are excluded from this server class.

Returns:

A comma-separated list of excluded hosts, or null if not specified.

getBlacklistByIndex

public java.lang.String getBlacklistByIndex(int index)

Returns a list of excluded client addresses, by index.

Parameters:

index - The index of the blacklist entry to return. The only valid index is 0.

Returns:

A list of excluded client addresses, or null if not specified.

getContinueMatching

public boolean getContinueMatching()

Indicates whether look-ups halt on the first server match or continue to match against multiple servers. Matching is done in the order that server classes are defined.

Returns:

true if configuration look-ups continue matching server classes, beyond the first match. false if only the first match is used.

getEndpoint

public java.lang.String getEndpoint()

Returns the URL template string, which specifies the endpoint from which content can be downloaded by a deployment client.

Returns:

The URL template string for deployment client downloads, or null if not specified.

getFilterType

public java.lang.String getFilterType()

Returns the filter type that is applied first. If filterType is "whitelist", all whitelist filters are applied first, followed by blacklist filters. If filterType is "blacklist", all blacklist filters are applied first, followed by whitelist filters.

Returns:

The filter type.

getRepositoryLocation

public java.lang.String getRepositoryLocation()

Returns the location on the deployment server to store the content that is to be deployed for this server class.

Note: The path may contain macro expansions or substitutions.

Returns:

The file path for content storage on the deployment server.

getTargetRepositoryLocation

public java.lang.String getTargetRepositoryLocation()

Returns the location on the deployment client where the content to be deployed for this server class should be installed.

Note: The path may contain macro expansions or substitutions.

Returns:

The file path for content storage on the deployment client.

getTmpFolder

public java.lang.String getTmpFolder()

Returns the location of the working folder used by the deployment server.

Note: The path may contain macro expansions or substitutions.

Returns:

The path to the deployment server's working folder, or null if not specified.

getWhitelist

public java.lang.String getWhitelist()

Returns a list of hosts included for this server class.

Returns:

A comma-separated list of included hosts, or null if not specified.

getWhitelistByIndex

public java.lang.String getWhitelistByIndex(int index)

Returns a list of included client addresses, by index.

Parameters:

index - The index of the whitelist entry to return. Valid indexes are 0 and 1.

Returns:

A list of included client addresses, or null if not specified.

setBlacklistByIndex

public void setBlacklistByIndex(int index,
                                java.lang.String blacklist)

Sets a specific blacklist entry.

Parameters:

index - The index of the blacklist entry to set.

blacklist - The blacklist entry.

setContinueMatching

public void setContinueMatching(boolean matching)

Sets how this deployment server class controls its configurations across classes and server-specific settings. If set to true, configuration look-ups continue matching server classes after the first match. If set to false, only the first match is used. Matching is done in the order that server classes are defined.

Parameters:

matching - true to continue matching, false to use the first match.

setEndPoint

public void setEndPoint(java.lang.String endPoint)

Sets a URL template string that specifies the endpoint from which content can be downloaded by a deployment client. The deployment client knows how to substitute the values of the variables in the URL. Any custom URL can be provided here as long as it uses the specified variables. You don't have to set this URL template string unless you have a very specific need--for example, you need to acquire deployment application files from a third-party httpd for extremely large environments.

Parameters:

endPoint - The endpoint URL.

setFilterType

public void setFilterType(java.lang.String filterType)

Sets the order to apply filters:

• "whitelist" applies the whitelist filters first, followed by blacklist filters.
• "blacklist" applies the blacklist filters first, followed by whitelist filters.

Parameters:

filterType - The filter type to apply first.

setRepositoryLocation

public void setRepositoryLocation(java.lang.String location)

Sets the location on the deployment server to store the content that is to be deployed for this server class.

Parameters:

location - The location (path) for storing content.

setWhitelistByIndex

public void setWhitelistByIndex(int index,
                                java.lang.String whitelist)

Sets a specific whitelist entry.

Parameters:

index - The index of the whitelist entry to set.

whitelist - The whitelist entry.