com.splunk

Class Application

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.Application

All Implemented Interfaces:

Map<String,Object>

public class Application
extends Entity

The Application class represents a locally-installed Splunk app.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

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, updated

Method Summary

Modifier and Type	Method and Description
ApplicationArchive	archive() Archives the app on the server file system.
String	getAuthor() Returns the name of the app's author.
boolean	getCheckForUpdates() Indicates whether Splunk checks Splunkbase for updates.
String	getDescription() Returns a short description of the app.
String	getLabel() Returns the app's label (its name).
boolean	getRefresh() Indicates whether to reload objects contained in the locally-installed app.
ApplicationUpdate	getUpdate() Returns any update information that is available for the app.
String	getVersion() Returns the version of the app.
boolean	isConfigured() Indicates whether the app's custom setup has been performed.
boolean	isVisible() Indicates whether the app is visible and navigable from Splunk Web.
void	setAuthor(String author) Sets the name of the app's author.
void	setCheckForUpdates(boolean value) Sets whether Splunk checks Splunkbase for updates to the app.
void	setConfigured(boolean value) Sets whether the app's custom setup has been performed.
void	setDescription(String description) Sets a short description of the application, which is displayed below the app's title on the Splunk Home tab in Splunk Web.
void	setLabel(String label) Sets the app's name, which is displayed in Splunk Web.
ApplicationSetup	setup() Returns the app's setup information.
void	setVersion(String version) Sets the version of the app.
void	setVisible(boolean visible) Sets whether the app is visible and navigable from Splunk Web.
boolean	stateChangeRequiresRestart() Indicates whether a state change requires the app to be restarted.

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, getUpdated, 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

getAuthor

public String getAuthor()

Returns the name of the app's author. For Splunkbase apps, this value is the username of the Splunk.com account. For internal apps, this value is the full name.

Returns:

The author name, or null if not specified.

getCheckForUpdates

public boolean getCheckForUpdates()

Indicates whether Splunk checks Splunkbase for updates.

Returns:

true if Splunk checks Splunkbase for app updates, false if not.

getDescription

public String getDescription()

Returns a short description of the app.

Returns:

The description, or null if not specified.

getLabel

public String getLabel()

Returns the app's label (its name).

Returns:

The label, or null if not specified.

getRefresh

public boolean getRefresh()

Indicates whether to reload objects contained in the locally-installed app.

Returns:

true if objects are reloaded, false if not.

getVersion

public String getVersion()

Returns the version of the app.

Returns:

The version, or null if not specified.

isConfigured

public boolean isConfigured()

Indicates whether the app's custom setup has been performed. This field is available in Splunk version 4.2.4 and later.

Returns:

true if custom setup has been performed, false if not.

isVisible

public boolean isVisible()

Indicates whether the app is visible and navigable from Splunk Web.

Returns:

true if the app is visible and navigable from Splunk Web, false if not.

stateChangeRequiresRestart

public boolean stateChangeRequiresRestart()

Indicates whether a state change requires the app to be restarted.

Returns:

true if state changes require the app to be restarted, false if not.

setAuthor

public void setAuthor(String author)

Sets the name of the app's author. For Splunkbase apps, this value is the username of the Splunk.com account. For internal apps, this value is the full name.

Parameters:

author - The author name.

setCheckForUpdates

public void setCheckForUpdates(boolean value)

Sets whether Splunk checks Splunkbase for updates to the app.

Parameters:

value - true if Splunk checks Splunkbase for app updates, false if not.

setConfigured

public void setConfigured(boolean value)

Sets whether the app's custom setup has been performed. This field is available in Splunk 4.2.4 and later.

Parameters:

value - true if the app has run its custom setup, false if not.

setDescription

public void setDescription(String description)

Sets a short description of the application, which is displayed below the app's title on the Splunk Home tab in Splunk Web.

Parameters:

description - The short description of the app.

setLabel

public void setLabel(String label)

Sets the app's name, which is displayed in Splunk Web. The name should be between 5-80 characters and should not include the prefix "Splunk For".

Parameters:

label - The label (name) of the app.

setVersion

public void setVersion(String version)

Sets the version of the app.

Parameters:

version - The app's version.

setVisible

public void setVisible(boolean visible)

Sets whether the app is visible and navigable from Splunk Web.

Parameters:

visible - true if the app can be visible and navigable from Splunk Web, false if not.

archive

public ApplicationArchive archive()

Archives the app on the server file system.

Returns:

The location of the archived app, as {app_name}.spl.

setup

public ApplicationSetup setup()

Returns the app's setup information.

Returns:

The app's setup information.

getUpdate

public ApplicationUpdate getUpdate()

Returns any update information that is available for the app.

Returns:

Update information for the app.