org.wso2.wsas.admin.service
Class ModuleAdmin

java.lang.Object
  extended byorg.wso2.wsas.admin.service.AbstractAdmin
      extended byorg.wso2.wsas.admin.service.ModuleAdmin

public class ModuleAdmin
extends AbstractAdmin

Admin service to manage operations related to modules


Field Summary
 
Fields inherited from class org.wso2.wsas.admin.service.AbstractAdmin
axisConfig, configCtx
 
Constructor Summary
ModuleAdmin()
           
ModuleAdmin(org.apache.axis2.context.ConfigurationContext configCtx)
           
 
Method Summary
 void disengageModuleFromOperation(java.lang.String moduleId, java.lang.String moduleVersion, java.lang.String serviceId, java.lang.String serviceVersion, java.lang.String operationId)
           
 void disengageModuleFromService(java.lang.String moduleId, java.lang.String moduleVersion, java.lang.String serviceId, java.lang.String serviceVersion)
           
 void disengageModuleFromServiceGroup(java.lang.String moduleId, java.lang.String moduleVersion, java.lang.String serviceGroupId)
           
 boolean disengageModuleFromSystem(java.lang.String moduleId, java.lang.String moduleversion)
           
 void engageModuleForMessage(java.lang.String moduleId, java.lang.String moduleVersion, java.lang.String serviceId, java.lang.String serviceVersion, java.lang.String operationId, java.lang.String messageLabel)
           
 java.lang.String engageModuleForOperation(java.lang.String moduleId, java.lang.String moduleVersion, java.lang.String serviceId, java.lang.String serviceVersion, java.lang.String operationId)
          Engaging a module to an operation
 java.lang.String engageModuleForService(java.lang.String moduleId, java.lang.String moduleVersion, java.lang.String serviceId, java.lang.String serviceVersion)
          Engaging a module to a service
 java.lang.String engageModuleForServiceGroup(java.lang.String moduleId, java.lang.String moduleVersion, java.lang.String serviceGroupId)
           
 java.lang.String engageModuleForSystem(java.lang.String moduleId, java.lang.String moduleversion)
          Engaging a module globally
 void forceDisengageModuleFromService(java.lang.String moduleId, java.lang.String moduleVersion, java.lang.String serviceId, java.lang.String serviceVersion)
          Forcefully disengage modules without taking into consideration any of the restrictions.
 org.apache.axiom.om.OMElement[] getDeclaredModuleParameters(java.lang.String moduleId, java.lang.String moduleVersion)
           
 ModuleMetaData getModuleInfo(java.lang.String moduleId, java.lang.String moduleVersion)
           
 org.apache.axiom.om.OMElement[] getModuleParameters(java.lang.String moduleId, java.lang.String moduleVersion)
           
 java.lang.Object[] getModuleStatus(java.lang.String moduleid, java.lang.String moduleversion)
           
 org.apache.axiom.om.OMElement[] getPolicies(java.lang.String moduleId, java.lang.String moduleVersion)
           
 org.apache.axiom.om.OMElement getPolicy(java.lang.String moduleId, java.lang.String moduleVersion)
           
 java.lang.String[] listGloballyEngagesModules()
           
 ModuleMetaData[] listModules()
           
 java.lang.String[] listOperationModules(java.lang.String serviceName, java.lang.String operationName)
           
 java.lang.String[] listOperationsParentParentEngagedModules(java.lang.String serviceName, java.lang.String operationName)
           
 java.lang.String[] listServiceGroupModules(java.lang.String serviceGroupId)
           
 java.lang.String[] listServiceModules(java.lang.String serviceName)
           
 java.lang.String[] listServicesParentEngagedModules(java.lang.String serviceName)
           
 void removeModule(java.lang.String moduleId, java.lang.String moduleversion)
          Delete a module
 void setAs(java.lang.String moduleName, java.lang.String version)
           
 void setModuleParameter(java.lang.String moduleId, java.lang.String moduleVersion, org.apache.axiom.om.OMElement paramterElement)
           
 void setModuleParameters(java.lang.String moduleId, java.lang.String moduleVersion, org.apache.axiom.om.OMElement[] paramterElements)
           
 void setPolicy(java.lang.String moduleId, java.lang.String moduleVersion, java.lang.String policyString)
           
 
Methods inherited from class org.wso2.wsas.admin.service.AbstractAdmin
getAxisConfig, getConfigContext, init, setAxisConfig, setConfigContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ModuleAdmin

public ModuleAdmin()

ModuleAdmin

public ModuleAdmin(org.apache.axis2.context.ConfigurationContext configCtx)
Method Detail

listModules

public ModuleMetaData[] listModules()
                             throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

listGloballyEngagesModules

public java.lang.String[] listGloballyEngagesModules()
                                              throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

listServiceModules

public java.lang.String[] listServiceModules(java.lang.String serviceName)
                                      throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

listServiceGroupModules

public java.lang.String[] listServiceGroupModules(java.lang.String serviceGroupId)
                                           throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

listOperationModules

public java.lang.String[] listOperationModules(java.lang.String serviceName,
                                               java.lang.String operationName)
                                        throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

getModuleInfo

public ModuleMetaData getModuleInfo(java.lang.String moduleId,
                                    java.lang.String moduleVersion)
                             throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

getModuleStatus

public java.lang.Object[] getModuleStatus(java.lang.String moduleid,
                                          java.lang.String moduleversion)
                                   throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

engageModuleForSystem

public java.lang.String engageModuleForSystem(java.lang.String moduleId,
                                              java.lang.String moduleversion)
                                       throws org.apache.axis2.AxisFault
Engaging a module globally

Parameters:
moduleId -
moduleversion -
Returns:
The status
Throws:
org.apache.axis2.AxisFault

disengageModuleFromSystem

public boolean disengageModuleFromSystem(java.lang.String moduleId,
                                         java.lang.String moduleversion)
                                  throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

removeModule

public void removeModule(java.lang.String moduleId,
                         java.lang.String moduleversion)
                  throws org.apache.axis2.AxisFault
Delete a module

Parameters:
moduleId -
moduleversion -
Throws:
org.apache.axis2.AxisFault

engageModuleForServiceGroup

public java.lang.String engageModuleForServiceGroup(java.lang.String moduleId,
                                                    java.lang.String moduleVersion,
                                                    java.lang.String serviceGroupId)
                                             throws org.apache.axis2.AxisFault
Parameters:
moduleId -
moduleVersion -
serviceGroupId -
Returns:
The status message
Throws:
org.apache.axis2.AxisFault

disengageModuleFromServiceGroup

public void disengageModuleFromServiceGroup(java.lang.String moduleId,
                                            java.lang.String moduleVersion,
                                            java.lang.String serviceGroupId)
                                     throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

engageModuleForService

public java.lang.String engageModuleForService(java.lang.String moduleId,
                                               java.lang.String moduleVersion,
                                               java.lang.String serviceId,
                                               java.lang.String serviceVersion)
                                        throws org.apache.axis2.AxisFault
Engaging a module to a service

Parameters:
moduleId -
moduleVersion -
serviceId -
serviceVersion -
Returns:
A message
Throws:
org.apache.axis2.AxisFault

disengageModuleFromService

public void disengageModuleFromService(java.lang.String moduleId,
                                       java.lang.String moduleVersion,
                                       java.lang.String serviceId,
                                       java.lang.String serviceVersion)
                                throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

forceDisengageModuleFromService

public void forceDisengageModuleFromService(java.lang.String moduleId,
                                            java.lang.String moduleVersion,
                                            java.lang.String serviceId,
                                            java.lang.String serviceVersion)
                                     throws org.apache.axis2.AxisFault
Forcefully disengage modules without taking into consideration any of the restrictions.

Parameters:
moduleId -
moduleVersion -
serviceId -
serviceVersion -
Throws:
org.apache.axis2.AxisFault

engageModuleForOperation

public java.lang.String engageModuleForOperation(java.lang.String moduleId,
                                                 java.lang.String moduleVersion,
                                                 java.lang.String serviceId,
                                                 java.lang.String serviceVersion,
                                                 java.lang.String operationId)
                                          throws org.apache.axis2.AxisFault
Engaging a module to an operation

Parameters:
moduleId -
moduleVersion -
serviceId -
serviceVersion -
operationId -
Returns:
A message
Throws:
org.apache.axis2.AxisFault

disengageModuleFromOperation

public void disengageModuleFromOperation(java.lang.String moduleId,
                                         java.lang.String moduleVersion,
                                         java.lang.String serviceId,
                                         java.lang.String serviceVersion,
                                         java.lang.String operationId)
                                  throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

engageModuleForMessage

public void engageModuleForMessage(java.lang.String moduleId,
                                   java.lang.String moduleVersion,
                                   java.lang.String serviceId,
                                   java.lang.String serviceVersion,
                                   java.lang.String operationId,
                                   java.lang.String messageLabel)
                            throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

getModuleParameters

public org.apache.axiom.om.OMElement[] getModuleParameters(java.lang.String moduleId,
                                                           java.lang.String moduleVersion)
                                                    throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

getPolicy

public org.apache.axiom.om.OMElement getPolicy(java.lang.String moduleId,
                                               java.lang.String moduleVersion)
                                        throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

setPolicy

public void setPolicy(java.lang.String moduleId,
                      java.lang.String moduleVersion,
                      java.lang.String policyString)
               throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

getDeclaredModuleParameters

public org.apache.axiom.om.OMElement[] getDeclaredModuleParameters(java.lang.String moduleId,
                                                                   java.lang.String moduleVersion)
                                                            throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

setModuleParameters

public void setModuleParameters(java.lang.String moduleId,
                                java.lang.String moduleVersion,
                                org.apache.axiom.om.OMElement[] paramterElements)
                         throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

setModuleParameter

public void setModuleParameter(java.lang.String moduleId,
                               java.lang.String moduleVersion,
                               org.apache.axiom.om.OMElement paramterElement)
                        throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

setAs

public void setAs(java.lang.String moduleName,
                  java.lang.String version)
           throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

getPolicies

public org.apache.axiom.om.OMElement[] getPolicies(java.lang.String moduleId,
                                                   java.lang.String moduleVersion)
                                            throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

listServicesParentEngagedModules

public java.lang.String[] listServicesParentEngagedModules(java.lang.String serviceName)
                                                    throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault

listOperationsParentParentEngagedModules

public java.lang.String[] listOperationsParentParentEngagedModules(java.lang.String serviceName,
                                                                   java.lang.String operationName)
                                                            throws org.apache.axis2.AxisFault
Throws:
org.apache.axis2.AxisFault