com.atlassian.application.api

Interface ApplicationManager

public interface ApplicationManager

Interface into the Applications (e.g. Service Desk) installed on the underlying platform (e.g. JIRA). Unless otherwise noted none of the parameters or return values can be null.

Since:

v1.0

Method Summary

Modifier and Type	Method and Description
io.atlassian.fugue.Option<ApplicationAccess>	getAccess(ApplicationKey key) Get the ApplicationAccess associated with the passed application, or Option.none() if there is no Application installed with the passed key.
io.atlassian.fugue.Option<Application>	getApplication(ApplicationKey key) Return the installed Application with the passed key.
<A extends Application> io.atlassian.fugue.Option<A>	getApplication(ApplicationKey key, Class<A> type) Return the installed Application associated with the passed ApplicationKey if it is of the correct type.
Iterable<Application>	getApplications() Return all the Applications installed on the platform.
PlatformApplication	getPlatform() Return the PlatformApplication that represents the Platform.

Method Detail

getPlatform

PlatformApplication getPlatform()

Return the PlatformApplication that represents the Platform.

Returns:

the PlatformApplication that represents the Platform.

getApplications

Iterable<Application> getApplications()

Return all the Applications installed on the platform. This will include the PlatformApplication. An application may or may not be licensed.

Returns:

all the Applications installed on the platform.

getApplication

io.atlassian.fugue.Option<Application> getApplication(ApplicationKey key)

Return the installed Application with the passed key. Option.none() is returned to indicate that the Application is not installed.

Parameters:

key - the key to search for.

Returns:

the Application with the passed key or Option.none() if no such Application exists.

getApplication

<A extends Application> io.atlassian.fugue.Option<A> getApplication(ApplicationKey key,
                                                                    Class<A> type)

Return the installed Application associated with the passed ApplicationKey if it is of the correct type. Option.none() is returned to indicate no match.

Type Parameters:

A - the type of Application to return.

Parameters:

key - the key to search for.

type - the type of Application to return.

Returns:

the Application with the passed key and type or Option.none() if no such Application exists.

getAccess

io.atlassian.fugue.Option<ApplicationAccess> getAccess(ApplicationKey key)

Get the ApplicationAccess associated with the passed application, or Option.none() if there is no Application installed with the passed key.

Parameters:

key - the key to search for.

Returns:

the ApplicationAccess associated with the passed key.