public class ServiceAdmin extends org.wso2.carbon.core.AbstractAdmin implements ServiceAdminMBean
Modifier and Type | Field and Description |
---|---|
static String |
DISABLE_DELETION_PARAM |
static String |
DISABLE_TRY_IT_PARAM |
Constructor and Description |
---|
ServiceAdmin() |
ServiceAdmin(org.apache.axis2.engine.AxisConfiguration axisConfig) |
Modifier and Type | Method and Description |
---|---|
void |
addPoliciesToService(String serviceName,
org.apache.neethi.Policy policy,
int policyType,
String[] modulePaths)
This method add Policy to service at the Registry.
|
String |
addTransportBinding(String serviceId,
String transportProtocol) |
void |
changeServiceState(String serviceName,
boolean isActive) |
boolean |
checkForGroupedServices(String[] serviceGroupsList)
Check the service group list for service groups which has more than one service
|
void |
configureMTOM(String flag,
String serviceName)
set the service parameter enableMTOM to manipulate MTOM flag
true/false/optional
|
void |
deleteAllFaultyServiceGroups() |
void |
deleteAllNonAdminServiceGroups() |
boolean |
deleteFaultyServiceGroup(String archiveName) |
void |
deleteFaultyServiceGroups(String[] fileNames) |
void |
deleteServiceGroups(String[] serviceGroups) |
ServiceDownloadData |
downloadServiceArchive(String serviceGroupName)
Downloads service archive files
|
void |
engageModuleToService(String serviceName,
String moduleName,
String version) |
String |
getBindingOperationMessagePolicy(String serviceName,
String bindingName,
String operationName,
String messageType)
Returns the policy of a given message for a given service binding's operation
|
String |
getBindingOperationPolicy(String serviceName,
String bindingName,
String operationName)
Returns a policy for an operation of a given service binding
|
String |
getBindingPolicy(String serviceName,
String bindingName)
Returns the policy for a given service binding
|
String[] |
getExposedTransports(String serviceId) |
FaultyServicesWrapper |
getFaultyServiceArchives(int pageNumber) |
String |
getModulePolicy(String moduleName,
String moduleVersion)
Retrieves the merged policy from a given modiule
|
int |
getNumberOfActiveServices()
Get the currently active number of services
|
int |
getNumberOfFaultyServices()
Get the number of faulty services
|
int |
getNumberOfInactiveServices()
Get the currently inactive number of services
|
int |
getNumberOfServiceGroups() |
String |
getOperationMessagePolicy(String serviceName,
String operationName,
String messageType)
Returns the policy for a given message
|
String |
getOperationPolicy(String serviceName,
String operationName)
Returns the policy for a given service and it's operation
|
PolicyMetaData[] |
getPolicies(String serviceName) |
String |
getPolicy(String serviceName)
Returns the Service Policy for a given service.
|
String[] |
getServiceBindings(String serviceName) |
ServiceMetaData |
getServiceData(String serviceName) |
String[] |
getServiceParameters(String serviceName) |
org.apache.axiom.om.OMElement |
getWSDL(String serviceName) |
ServiceGroupMetaData |
listServiceGroup(String serviceGroupName)
Return service group details for a given service group
|
ServiceMetaDataWrapper |
listServices(String serviceTypeFilter,
String serviceSearchString,
int pageNumber)
List all the available services
|
void |
removeBindingPolicy(String serviceName,
String policyKey,
String[] moduleNames)
Removes policy given the key
|
void |
removeServiceParameter(String serviceName,
String parameterName) |
void |
removeServicePoliciesByNamespace(String serviceName,
String namesapce) |
String |
removeTransportBinding(String serviceId,
String transportProtocol) |
void |
setBindingOperationMessagePolicy(String serviceName,
String bindingName,
String operationName,
String messageType,
String policyString) |
void |
setBindingOperationPolicy(String serviceName,
String bindingName,
String operationName,
String policyString) |
void |
setBindingPolicy(String serviceName,
String bindingName,
String policyString) |
void |
setConfigurationContext(org.apache.axis2.context.ConfigurationContext configurationContext) |
void |
setModulePolicy(String moduleName,
String moduleVersion,
String policyString) |
void |
setPolicy(String serviceName,
String policyString) |
void |
setServiceOperationMessagePolicy(String serviceName,
String operationName,
String messageType,
String policyString) |
void |
setServiceOperationPolicy(String serviceName,
String operationName,
String policyString) |
void |
setServiceParameters(String serviceName,
String[] parameters) |
void |
setServicePolicy(String serviceName,
String policyString) |
void |
startService(String serviceName)
Start the service specified by
serviceName |
void |
stopService(String serviceName)
Stop the service specified by
serviceName |
getAxisConfig, getConfigContext, getConfigSystemRegistry, getConfigUserRegistry, getGovernanceRegistry, getGovernanceSystemRegistry, getGovernanceUserRegistry, getHttpSession, getLocalRepo, getRegistry, getTenantDomain, getUsername, getUserRealm, setPermissionUpdateTimestamp
public static final String DISABLE_TRY_IT_PARAM
public static final String DISABLE_DELETION_PARAM
public void setConfigurationContext(org.apache.axis2.context.ConfigurationContext configurationContext)
setConfigurationContext
in class org.wso2.carbon.core.AbstractAdmin
public void addPoliciesToService(String serviceName, org.apache.neethi.Policy policy, int policyType, String[] modulePaths) throws Exception
serviceName
- policy
- policyType
- Exception
public void removeServicePoliciesByNamespace(String serviceName, String namesapce) throws Exception
Exception
public void engageModuleToService(String serviceName, String moduleName, String version) throws Exception
Exception
public ServiceGroupMetaData listServiceGroup(String serviceGroupName) throws org.apache.axis2.AxisFault
serviceGroupName
- org.apache.axis2.AxisFault
- TODO: Do we need this in ServiceAdmin?public ServiceMetaDataWrapper listServices(String serviceTypeFilter, String serviceSearchString, int pageNumber) throws org.apache.axis2.AxisFault
serviceTypeFilter
- Service type of services to be returnedserviceSearchString
- Service name or part of a service namepageNumber
- The number of the page to be retrievedorg.apache.axis2.AxisFault
- If an error occurs while retrieving servicespublic int getNumberOfServiceGroups() throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public int getNumberOfActiveServices() throws org.apache.axis2.AxisFault
ServiceAdminMBean
getNumberOfActiveServices
in interface ServiceAdminMBean
org.apache.axis2.AxisFault
public int getNumberOfInactiveServices() throws Exception
ServiceAdminMBean
getNumberOfInactiveServices
in interface ServiceAdminMBean
Exception
- If an error occurs while getting the service countpublic int getNumberOfFaultyServices()
ServiceAdminMBean
getNumberOfFaultyServices
in interface ServiceAdminMBean
public FaultyServicesWrapper getFaultyServiceArchives(int pageNumber) throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public boolean deleteFaultyServiceGroup(String archiveName) throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public void deleteAllNonAdminServiceGroups() throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public void deleteAllFaultyServiceGroups() throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public boolean checkForGroupedServices(String[] serviceGroupsList) throws org.apache.axis2.AxisFault
serviceGroupsList
- - list of service groupsorg.apache.axis2.AxisFault
- on errorpublic void deleteServiceGroups(String[] serviceGroups) throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public void deleteFaultyServiceGroups(String[] fileNames) throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public ServiceMetaData getServiceData(String serviceName) throws Exception
Exception
public void changeServiceState(String serviceName, boolean isActive) throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public void configureMTOM(String flag, String serviceName) throws org.apache.axis2.AxisFault
flag
- serviceName
- org.apache.axis2.AxisFault
public void startService(String serviceName) throws Exception
ServiceAdminMBean
serviceName
startService
in interface ServiceAdminMBean
serviceName
- Name of the service to be restartedException
- If an error occurs while starting the servicepublic void stopService(String serviceName) throws Exception
ServiceAdminMBean
serviceName
stopService
in interface ServiceAdminMBean
serviceName
- Name of the service to be restartedException
- If an error occurs while stopping the servicepublic String[] getExposedTransports(String serviceId) throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public String addTransportBinding(String serviceId, String transportProtocol) throws Exception
Exception
public String removeTransportBinding(String serviceId, String transportProtocol) throws Exception
Exception
public void removeBindingPolicy(String serviceName, String policyKey, String[] moduleNames) throws org.wso2.carbon.utils.ServerException
serviceName
- Name of the servicepolicyKey
- Key of the policy to be removedmoduleNames
- Array of module namesorg.wso2.carbon.utils.ServerException
- on errorpublic void setServiceParameters(String serviceName, String[] parameters) throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public void removeServiceParameter(String serviceName, String parameterName) throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public String[] getServiceParameters(String serviceName) throws org.wso2.carbon.utils.ServerException
org.wso2.carbon.utils.ServerException
public String getPolicy(String serviceName) throws org.apache.axis2.AxisFault
serviceName
- The name of the serviceorg.apache.axis2.AxisFault
- on errorpublic String getModulePolicy(String moduleName, String moduleVersion) throws org.apache.axis2.AxisFault
moduleName
- Name of the modulemoduleVersion
- Version string of the stringorg.apache.axis2.AxisFault
- on errorpublic void setModulePolicy(String moduleName, String moduleVersion, String policyString) throws Exception
Exception
public String getOperationPolicy(String serviceName, String operationName) throws org.apache.axis2.AxisFault
serviceName
- The name of the serviceoperationName
- The operationorg.apache.axis2.AxisFault
- on errorpublic String getOperationMessagePolicy(String serviceName, String operationName, String messageType) throws org.apache.axis2.AxisFault
serviceName
- The name of the serviceoperationName
- The name of the operationmessageType
- The type of messageorg.apache.axis2.AxisFault
- on errorpublic PolicyMetaData[] getPolicies(String serviceName) throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public String getBindingPolicy(String serviceName, String bindingName) throws org.apache.axis2.AxisFault
serviceName
- The name of the servicebindingName
- The name of the binding in questionorg.apache.axis2.AxisFault
- on errorpublic String getBindingOperationPolicy(String serviceName, String bindingName, String operationName) throws org.apache.axis2.AxisFault
serviceName
- Name of the servicebindingName
- Name of the service bindingoperationName
- Name of the service operationorg.apache.axis2.AxisFault
- on errorpublic String getBindingOperationMessagePolicy(String serviceName, String bindingName, String operationName, String messageType) throws org.apache.axis2.AxisFault
serviceName
- Service namebindingName
- Service binding nameoperationName
- Service operation namemessageType
- Message typeorg.apache.axis2.AxisFault
- on errorpublic void setPolicy(String serviceName, String policyString) throws Exception
Exception
public void setServicePolicy(String serviceName, String policyString) throws Exception
Exception
public void setServiceOperationPolicy(String serviceName, String operationName, String policyString) throws Exception
Exception
public void setServiceOperationMessagePolicy(String serviceName, String operationName, String messageType, String policyString) throws Exception
Exception
public void setBindingPolicy(String serviceName, String bindingName, String policyString) throws Exception
Exception
public void setBindingOperationPolicy(String serviceName, String bindingName, String operationName, String policyString) throws Exception
Exception
public void setBindingOperationMessagePolicy(String serviceName, String bindingName, String operationName, String messageType, String policyString) throws Exception
Exception
public org.apache.axiom.om.OMElement getWSDL(String serviceName) throws org.apache.axis2.AxisFault
org.apache.axis2.AxisFault
public String[] getServiceBindings(String serviceName) throws Exception
Exception
public ServiceDownloadData downloadServiceArchive(String serviceGroupName)
serviceGroupName
- name of the service group needs to be downloadedCopyright © 2023 WSO2. All rights reserved.