Package org.azd.extensionmanagement

Class ExtensionManagementApi

java.lang.Object

org.azd.utils.AzDAsyncApi<ExtensionManagementApi>

org.azd.extensionmanagement.ExtensionManagementApi

All Implemented Interfaces:

ExtensionManagementDetails

public class ExtensionManagementApi
extends AzDAsyncApi<ExtensionManagementApi>
implements ExtensionManagementDetails

ExtensionManagementApi class to manage installed extensions API

Constructor Summary

Constructors

Constructor	Description
ExtensionManagementApi(Connection connection)	Pass the connection object to work with Member Entitlement Management Api

Method Summary

Modifier and Type	Method	Description
InstalledExtension	getExtension(String extensionId, String publisherId)	Get an installed extension by its publisher and extension id.
InstalledExtension	getExtension(String extensionId, String publisherId, String[] assetTypes)	Get an installed extension by its publisher and extension id.
InstalledExtensions	getExtensions()	List the installed extensions
InstalledExtension	installExtension(String publisherId, String extensionId, String version)	Install the specified extension
Void	uninstallExtension(String publisherId, String extensionId)	Uninstall the specified extension
Void	uninstallExtension(String publisherId, String extensionId, String reason, String reasonCode)	Uninstall the specified extension
InstalledExtension	updateExtension(String publisherId, String extensionId, ExtensionStateFlags extensionState)	Enable/disable an extension

Methods inherited from class org.azd.utils.AzDAsyncApi

createAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExtensionManagementApi

public ExtensionManagementApi(Connection connection)

Pass the connection object to work with Member Entitlement Management Api

Parameters:

connection - Connection object

Method Details

getExtension

public InstalledExtension getExtension(String extensionId,
 String publisherId)
                                throws AzDException

Get an installed extension by its publisher and extension id.

Specified by:

getExtension in interface ExtensionManagementDetails

Parameters:

extensionId - Id of the extension. Example: "sonarqube".

publisherId - Id of the publisher. Example: "sonarsource".

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.

getExtension

public InstalledExtension getExtension(String extensionId,
 String publisherId,
 String[] assetTypes)
                                throws AzDException

Get an installed extension by its publisher and extension id.

Specified by:

getExtension in interface ExtensionManagementDetails

Parameters:

extensionId - Id of the extension. Example: "sonarqube".

publisherId - Id of the publisher. Example: "sonarsource".

assetTypes - type of asset

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.

getExtensions

public InstalledExtensions getExtensions()
                                  throws AzDException

List the installed extensions

Specified by:

getExtensions in interface ExtensionManagementDetails

Returns:

InstalledExtensions InstalledExtensions

Throws:

AzDException - Default Api Exception handler.

installExtension

public InstalledExtension installExtension(String publisherId,
 String extensionId,
 String version)
                                    throws AzDException

Install the specified extension

Specified by:

installExtension in interface ExtensionManagementDetails

Parameters:

publisherId - Id of the publisher. Example: "sonarsource".

extensionId - Id of the extension. Example: "sonarqube".

version - if null latest version will be selected

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.

uninstallExtension

public Void uninstallExtension(String publisherId,
 String extensionId)
                        throws AzDException

Uninstall the specified extension

Specified by:

uninstallExtension in interface ExtensionManagementDetails

Parameters:

publisherId - Id of the publisher. Example: "sonarsource".

extensionId - Id of the extension. Example: "sonarqube".

Throws:

AzDException - Default Api Exception handler.

uninstallExtension

public Void uninstallExtension(String publisherId,
 String extensionId,
 String reason,
 String reasonCode)
                        throws AzDException

Uninstall the specified extension

Specified by:

uninstallExtension in interface ExtensionManagementDetails

Parameters:

publisherId - Id of the publisher. Example: "sonarsource".

extensionId - Id of the extension. Example: "sonarqube".

reason - reason for uninstall

reasonCode - reason code for uninstall

Throws:

AzDException - Default Api Exception handler.

updateExtension

public InstalledExtension updateExtension(String publisherId,
 String extensionId,
 ExtensionStateFlags extensionState)
                                   throws AzDException

Enable/disable an extension

Specified by:

updateExtension in interface ExtensionManagementDetails

Parameters:

publisherId - Id of the publisher. Example: "sonarsource".

extensionId - Id of the extension. Example: "sonarqube".

extensionState - If none extension will be enabled. ExtensionStateFlags

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.