Package org.wso2.carbon.application.mgt

Class ApplicationAdmin

java.lang.Object

org.wso2.carbon.core.AbstractAdmin

org.wso2.carbon.application.mgt.ApplicationAdmin

public class ApplicationAdmin
extends org.wso2.carbon.core.AbstractAdmin

Field Summary

Fields inherited from class org.wso2.carbon.core.AbstractAdmin

axisConfig, configurationContext

Constructor Summary

Constructors

Constructor	Description
ApplicationAdmin()

Method Summary

Modifier and Type	Method	Description
void	deleteAllFaultyAppliations()
void	deleteApplication(String appName)	Deletes an entire application by deleting all its artifacts
void	deleteFaultyApplication(String[] faultyAppName)	Deletes an entire application by deleting all its artifacts
DataHandler	downloadCappArchive(String fileName)	Used to download a carbon application archive.
ApplicationMetadata	getAppData(String appName)	Gives an ApplicationMetadata object with axis2 artifacts deployed through the given app.
String	getFaultException(String faultCarbonAppName)	Gives Fault Reason of the given Faulty Carbon Application
String[]	listAllApplications()	Give the names of all applications in the system
String[]	listAllFaultyApplications()	Give the names of all faulty applications in the system
void	redeployApplication(String appName)	Mark an application to be redeployed again in the next deployment pass.

Methods inherited from class org.wso2.carbon.core.AbstractAdmin

getAxisConfig, getConfigContext, getConfigSystemRegistry, getConfigUserRegistry, getGovernanceRegistry, getGovernanceSystemRegistry, getGovernanceUserRegistry, getHttpSession, getLocalRepo, getRegistry, getTenantDomain, getUsername, getUserRealm, setConfigurationContext, setPermissionUpdateTimestamp

Methods inherited from class java.lang.Object

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

Constructor Details

ApplicationAdmin

public ApplicationAdmin()

Method Details

listAllApplications

public String[] listAllApplications()
                             throws Exception

Give the names of all applications in the system

Returns:

- names array

Throws:

Exception - - error on getting carbon app service

listAllFaultyApplications

public String[] listAllFaultyApplications()
                                   throws Exception

Give the names of all faulty applications in the system

Returns:

- names array

Throws:

Exception - - error on getting carbon app service

getFaultException

public String getFaultException(String faultCarbonAppName)
                         throws Exception

Gives Fault Reason of the given Faulty Carbon Application

Parameters:

faultCarbonAppName - - name of the faulty Application

Throws:

Exception - - error on getting carbon app service

deleteApplication

public void deleteApplication(String appName)
                       throws Exception

Deletes an entire application by deleting all its artifacts

Parameters:

appName - - name of the Application to be deleted

Throws:

Exception - - invalid scenarios

deleteFaultyApplication

public void deleteFaultyApplication(String[] faultyAppName)
                             throws Exception

Deletes an entire application by deleting all its artifacts

Parameters:

faultyAppName - - name of the Application to be deleted

Throws:

Exception - - error on getting carbon app service

deleteAllFaultyAppliations

public void deleteAllFaultyAppliations()
                                throws Exception

Throws:

Exception

redeployApplication

public void redeployApplication(String appName)
                         throws Exception

Mark an application to be redeployed again in the next deployment pass.

Parameters:

appPName - - input app name

Throws:

Exception - - error on redeploying app file

getAppData

public ApplicationMetadata getAppData(String appName)
                               throws Exception

Gives an ApplicationMetadata object with axis2 artifacts deployed through the given app.

Parameters:

appName - - input app name

Returns:

- ApplicationMetadata object with found artifact info

Throws:

Exception - - error on retrieving metadata

downloadCappArchive

public DataHandler downloadCappArchive(String fileName)
                                throws Exception

Used to download a carbon application archive.

Parameters:

fileName - the name of the application archive (.car) to be downloaded

Returns:

datahandler corresponding to the .car file to be downloaded

Throws:

Exception - for invalid scenarios