com.splunk
Class Application

java.lang.Object
  com.splunk.Resource
      com.splunk.Entity
          com.splunk.Application

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.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

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class com.splunk.Resource

actions, path, service, title

Method Summary

ApplicationArchive	archive() Archives the app on the server file system.
java.lang.String	getAuthor() Returns the name of the app's author.
boolean	getCheckForUpdates() Indicates whether Splunk checks Splunkbase for updates.
java.lang.String	getDescription() Returns a short description of the app.
java.lang.String	getLabel() Returns the app's label (its name).
java.lang.String	getVersion() Returns the version of the app.
boolean	isConfigured() Indicates whether the app's custom setup has been performed.
boolean	isManageable() Indicates whether the app can be managed by Splunk Manager.
boolean	isVisible() Indicates whether an app is visible and navigable from Splunk Web.
ApplicationSetup	setup() Returns the app's setup information.
boolean	stateChangeRequiresRestart() Indicates whether a state change requires the app to be restarted.
ApplicationUpdate	update() Returns any update information that is available for the app.

Methods inherited from class com.splunk.Entity

actionPath, clear, containsKey, containsValue, disable, enable, entrySet, get, getMetadata, isDisabled, isEmpty, keySet, put, putAll, refresh, reload, 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

getAuthor

public java.lang.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 updates, false if not.

getDescription

public java.lang.String getDescription()

Returns a short description of the app.

Returns:

The description, or null if not specified.

getLabel

public java.lang.String getLabel()

Returns the app's label (its name).

Returns:

The label, or null if not specified.

getVersion

public java.lang.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.

isManageable

public boolean isManageable()

Indicates whether the app can be managed by Splunk Manager.

Returns:

true if the app can be managed by Splunk Manager, false if not.

isVisible

public boolean isVisible()

Indicates whether an 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.

archive

public ApplicationArchive archive()

Archives the app on the server file system.

Returns:

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.

update

public ApplicationUpdate update()

Returns any update information that is available for the app.

Returns:

Update information for the app.