@PublicSpi public interface

PluginBackedService

com.atlassian.jira.service.PluginBackedService

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

Optional interface for JIRA services that are backed by plugins. Due to the nature of the plugin system, a service that is backed by a plugin may become unavailable at any time if the plugin is disabled or uninstalled.

Summary

Public Methods
boolean isAvailable()
Returns true if this service is usable.

Public Methods

public boolean isAvailable ()

Returns true if this service is usable. By default a service is always usable, but services that are backed by plugin jobs, for example, may become unusable when the plugin is uninstalled or disabled.

Returns
  • a boolean indicating whether the underlying service is usable