public class ModuleAdminService
extends org.wso2.carbon.core.AbstractAdmin
Modifier and Type | Field and Description |
---|---|
static String |
ADDRESSING_MODULE |
static String |
CACHING_MODULE |
static String |
THROTTLE_MODULE |
Constructor and Description |
---|
ModuleAdminService() |
ModuleAdminService(org.apache.axis2.engine.AxisConfiguration ac) |
Modifier and Type | Method and Description |
---|---|
boolean |
disengageModuleForOperation(String moduleId,
String serviceName,
String operationName) |
boolean |
disengageModuleForService(String moduleId,
String serviceName) |
boolean |
disengageModuleForServiceGroup(String moduleId,
String serviceGroupName) |
boolean |
disengageModuleFromSystem(String moduleId) |
boolean |
engageModuleForOperation(String moduleId,
String serviceName,
String operationName) |
boolean |
engageModuleForService(String moduleId,
String serviceName) |
boolean |
engageModuleForServiceGroup(String moduleID,
String serviceGroupName) |
ModuleMetaData |
getModuleInfo(String moduleName,
String moduleVersion)
Return all available module meta-data (not counts)
|
String[] |
getModuleParameters(String moduleName,
String moduleVersion)
return all parameters for this module (including inherited ones), where
each parameter is an XML fragment representing the "parameter" element
|
boolean |
globallyDisengageModule(String moduleId) |
boolean |
globallyEngageModule(String moduleId) |
ModuleMetaData[] |
listGloballyEngagedModules()
List all the globally engaged modules
|
ModuleMetaData[] |
listModules()
List all the available modules
|
ModuleMetaData[] |
listModulesForOperation(String serviceName,
String operationName)
List modules medatadata about given operation
|
ModuleMetaData[] |
listModulesForService(String serviceName) |
ModuleMetaData[] |
listModulesForServiceGroup(String serviceGroupName) |
String |
removeModule(String moduleId)
Delete a module
|
String |
removeModuleParameter(String moduleName,
String moduleVersion,
String parameterName) |
void |
setModuleParameters(String moduleName,
String moduleVersion,
String[] parameters) |
String |
uploadModule(ModuleUploadData[] moduleUploadData) |
getAxisConfig, getConfigContext, getConfigSystemRegistry, getConfigUserRegistry, getGovernanceRegistry, getGovernanceSystemRegistry, getGovernanceUserRegistry, getHttpSession, getLocalRepo, getRegistry, getTenantDomain, getUsername, getUserRealm, setConfigurationContext, setPermissionUpdateTimestamp
public static final String THROTTLE_MODULE
public static final String CACHING_MODULE
public static final String ADDRESSING_MODULE
public ModuleMetaData[] listModules()
public ModuleMetaData[] listGloballyEngagedModules()
public ModuleMetaData[] listModulesForOperation(String serviceName, String operationName) throws ModuleMgtException
serviceName
- Axis serviceoperationName
- Axis OperationModuleMgtException
- when we can't get module metadatapublic ModuleMetaData[] listModulesForService(String serviceName) throws ModuleMgtException
ModuleMgtException
public ModuleMetaData[] listModulesForServiceGroup(String serviceGroupName) throws ModuleMgtException
ModuleMgtException
public ModuleMetaData getModuleInfo(String moduleName, String moduleVersion) throws ModuleMgtException
moduleName
- -
moduleNamemoduleVersion
- -
moduleVersionModuleMgtException
- -
error accessing axis configpublic boolean globallyEngageModule(String moduleId) throws ModuleMgtException
ModuleMgtException
public boolean engageModuleForServiceGroup(String moduleID, String serviceGroupName) throws ModuleMgtException
ModuleMgtException
public boolean disengageModuleForServiceGroup(String moduleId, String serviceGroupName) throws ModuleMgtException
ModuleMgtException
public boolean engageModuleForService(String moduleId, String serviceName) throws ModuleMgtException
ModuleMgtException
public boolean disengageModuleForService(String moduleId, String serviceName) throws ModuleMgtException
ModuleMgtException
public boolean engageModuleForOperation(String moduleId, String serviceName, String operationName) throws ModuleMgtException
ModuleMgtException
public boolean disengageModuleForOperation(String moduleId, String serviceName, String operationName) throws ModuleMgtException
ModuleMgtException
public boolean globallyDisengageModule(String moduleId) throws ModuleMgtException
ModuleMgtException
public String uploadModule(ModuleUploadData[] moduleUploadData) throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public String[] getModuleParameters(String moduleName, String moduleVersion) throws ModuleMgtException
moduleName
- module name of the module of which parameters are requiredmoduleVersion
- module version of the module of which parameters are requiredModuleMgtException
- is thrown in case of errorpublic void setModuleParameters(String moduleName, String moduleVersion, String[] parameters) throws ModuleMgtException
ModuleMgtException
public String removeModuleParameter(String moduleName, String moduleVersion, String parameterName) throws ModuleMgtException
ModuleMgtException
public String removeModule(String moduleId) throws ModuleMgtException
moduleId
- module id of the module to be removedModuleMgtException
- if we can't remove the modulepublic boolean disengageModuleFromSystem(String moduleId) throws ModuleMgtException
moduleId
- module to be globally disenagedModuleMgtException
- if we can't disengage the module globallyCopyright © 2018 WSO2. All rights reserved.