org.wso2.carbon.service.mgt

Class ServiceGroupAdmin

java.lang.Object

org.wso2.carbon.core.AbstractAdmin

org.wso2.carbon.service.mgt.ServiceGroupAdmin

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

Admin service to manage service groups

Field Summary

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

axisConfig, configurationContext

Constructor Summary

Constructors

Constructor and Description
ServiceGroupAdmin()
ServiceGroupAdmin(org.apache.axis2.context.ConfigurationContext configCtx)

Method Summary

Modifier and Type	Method and Description
ServiceGroupMetaData	configureServiceGroupMTOM(String flag, String serviceGroupName) set the service group parameter enableMTOM to manipulate MTOM flag true/false/optional
String	dumpAAR(String serviceGroupName) Using the information from AxisServiceGroup, a service archive will be created.
ParameterMetaData	getServiceGroupParameter(String serviceGroupName, String paramName)
String[]	getServiceGroupParameters(String serviceGroupName)
ServiceGroupMetaData	listServiceGroup(String serviceGroupName) Return service group details for a given service group
ServiceGroupMetaDataWrapper	listServiceGroups(String serviceTypeFilter, String serviceGroupSearchString, int pageNumber) List all the available service groups
void	removeServiceGroupParameter(String serviceGroupId, String parameterName)
void	setServiceGroupParameter(String serviceGroupId, String parameterElement)
void	setServiceGroupParameters(String serviceGroupId, String[] parameterElement)
void	updateServiceGroupParameter(String serviceGroupName, ParameterMetaData paramMetaData)
void	updateServiceGroupParamters(String serviceGroupName, ParameterMetaData[] params)

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 Detail

ServiceGroupAdmin

public ServiceGroupAdmin()
                  throws Exception

Throws:

Exception

ServiceGroupAdmin

public ServiceGroupAdmin(org.apache.axis2.context.ConfigurationContext configCtx)
                  throws Exception

Throws:

Exception

Method Detail

listServiceGroups

public ServiceGroupMetaDataWrapper listServiceGroups(String serviceTypeFilter,
                                                     String serviceGroupSearchString,
                                                     int pageNumber)
                                              throws org.apache.axis2.AxisFault

List all the available service groups

Parameters:

pageNumber - The number of the page to be retrieved

Returns:

The service group metadata

Throws:

org.apache.axis2.AxisFault - If an error occurs while retrieving service groups

listServiceGroup

public ServiceGroupMetaData listServiceGroup(String serviceGroupName)
                                      throws Exception

Return service group details for a given service group

Parameters:

serviceGroupName - axis service group name

Returns:

ServiceGroupMetaData

Throws:

org.apache.axis2.AxisFault

Exception

configureServiceGroupMTOM

public ServiceGroupMetaData configureServiceGroupMTOM(String flag,
                                                      String serviceGroupName)
                                               throws Exception

set the service group parameter enableMTOM to manipulate MTOM flag true/false/optional

Parameters:

flag -

Returns:

ServiceGroupMetaData

Throws:

Exception

updateServiceGroupParamters

public void updateServiceGroupParamters(String serviceGroupName,
                                        ParameterMetaData[] params)
                                 throws org.wso2.carbon.utils.ServerException

Parameters:

serviceGroupName -

params -

Throws:

org.wso2.carbon.utils.ServerException

updateServiceGroupParameter

public void updateServiceGroupParameter(String serviceGroupName,
                                        ParameterMetaData paramMetaData)
                                 throws org.wso2.carbon.utils.ServerException

Parameters:

serviceGroupName -

paramMetaData -

Throws:

org.wso2.carbon.utils.ServerException

getServiceGroupParameters

public String[] getServiceGroupParameters(String serviceGroupName)
                                   throws org.wso2.carbon.utils.ServerException

Parameters:

serviceGroupName -

Returns:

Throws:

org.wso2.carbon.utils.ServerException

getServiceGroupParameter

public ParameterMetaData getServiceGroupParameter(String serviceGroupName,
                                                  String paramName)
                                           throws org.wso2.carbon.utils.ServerException

Parameters:

serviceGroupName -

paramName -

Returns:

Throws:

org.wso2.carbon.utils.ServerException

setServiceGroupParameters

public void setServiceGroupParameters(String serviceGroupId,
                                      String[] parameterElement)
                               throws org.apache.axis2.AxisFault

Parameters:

serviceGroupId -

parameterElement -

Throws:

org.apache.axis2.AxisFault

setServiceGroupParameter

public void setServiceGroupParameter(String serviceGroupId,
                                     String parameterElement)
                              throws org.apache.axis2.AxisFault

Parameters:

serviceGroupId -

parameterElement -

Throws:

org.apache.axis2.AxisFault

removeServiceGroupParameter

public void removeServiceGroupParameter(String serviceGroupId,
                                        String parameterName)
                                 throws org.apache.axis2.AxisFault

Parameters:

serviceGroupId -

parameterName -

Throws:

org.apache.axis2.AxisFault

dumpAAR

public String dumpAAR(String serviceGroupName)
               throws org.apache.axis2.AxisFault

Using the information from AxisServiceGroup, a service archive will be created. A String will be returned with ID, that can be used to access the AAR and dump it anywhere user wishes.

Parameters:

serviceGroupName -

Returns:

id of service archive

Throws:

org.apache.axis2.AxisFault