org.wso2.carbon.event.template.manager.admin

Class TemplateManagerAdminService

java.lang.Object

org.wso2.carbon.core.AbstractAdmin

org.wso2.carbon.event.template.manager.admin.TemplateManagerAdminService

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

Consist of the methods exposed by TemplateManagerAdminService

Field Summary

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

axisConfig, configurationContext

Constructor Summary

Constructors

Constructor and Description
TemplateManagerAdminService() Default Constructor

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deleteConfiguration(String domainName, String configName) Delete specified scenario configuration
String[]	editConfiguration(ScenarioConfigurationDTO configuration) Edit specified scenario configuration.
DomainInfoDTO[]	getAllDomainInfos() Return "limited information" with regards to all available Domain Templates.
ScenarioConfigurationDTO	getConfiguration(String domainName, String configName) return details for a given template configuration name
ScenarioConfigurationInfoDTO[]	getConfigurationInfos(String domainName) return all of the available Scenario Configuration Info's for a given Domain domain.
DomainInfoDTO	getDomainInfo(String domainName) Return "limited information" with regards to a Domain Template, given its name.
String[]	saveConfiguration(ScenarioConfigurationDTO configuration) Create specified scenario configuration.
boolean	saveStreamMapping(StreamMappingDTO[] streamMappingDTOs, String configName, String domainName) When the template refers to a stream (say StreamX) which needs to be populated by a user-defined stream (say StreamY), specify how attributes in StreamY needs to be mapped to StreamX, using the streamMappingDTO, and invoke this service.

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

TemplateManagerAdminService

public TemplateManagerAdminService()

Default Constructor

Method Detail

getDomainInfo

public DomainInfoDTO getDomainInfo(String domainName)
                            throws org.apache.axis2.AxisFault

Return "limited information" with regards to a Domain Template, given its name. "limited information" means, only the information which are required by the UI will be returned.

Parameters:

domainName - name of the Domain.

Returns:

DomainInfoDTO object

Throws:

org.apache.axis2.AxisFault

getAllDomainInfos

public DomainInfoDTO[] getAllDomainInfos()
                                  throws org.apache.axis2.AxisFault

Return "limited information" with regards to all available Domain Templates. "limited information" means, only the information which are required by the UI will be returned.

Returns:

Domain information for all of the available Domain Templates

Throws:

org.apache.axis2.AxisFault

getConfiguration

public ScenarioConfigurationDTO getConfiguration(String domainName,
                                        String configName)
                                          throws org.apache.axis2.AxisFault

return details for a given template configuration name

Parameters:

domainName - domain name of the Domain, corresponding to the configuration

configName - scenario configuration name

Returns:

scenario configuration details

Throws:

org.apache.axis2.AxisFault

getConfigurationInfos

public ScenarioConfigurationInfoDTO[] getConfigurationInfos(String domainName)
                                                     throws org.apache.axis2.AxisFault

return all of the available Scenario Configuration Info's for a given Domain domain. This method does not return all the fields in a Scenario Configurations, rather returns only the fields which are required for the UI.

Parameters:

domainName - domain name of the Domain

Returns:

scenario configuration information.

Throws:

org.apache.axis2.AxisFault

deleteConfiguration

public boolean deleteConfiguration(String domainName,
                          String configName)
                            throws org.apache.axis2.AxisFault

Delete specified scenario configuration

Parameters:

domainName - domain name of the Domain

configName - name of the scenario configuration which needs to be deleted

Throws:

org.apache.axis2.AxisFault

saveConfiguration

public String[] saveConfiguration(ScenarioConfigurationDTO configuration)
                           throws org.apache.axis2.AxisFault

Create specified scenario configuration.

Parameters:

configuration - scenario configuration data transfer object which needs to be saved.

Returns:

Stream ID array. In case there are StreamMappings in the Domain (under this particular scenario), then the "toStream" IDs will be returned. If no StreamMappings present, null will be returned.

Throws:

org.apache.axis2.AxisFault

editConfiguration

public String[] editConfiguration(ScenarioConfigurationDTO configuration)
                           throws org.apache.axis2.AxisFault

Edit specified scenario configuration.

Parameters:

configuration - scenario configuration data transfer object which needs to be edited.

Returns:

Stream ID array. In case there are StreamMappings in the Domain (under this particular scenario), then the "toStream" IDs will be returned. If no StreamMappings present, null will be returned.

Throws:

org.apache.axis2.AxisFault

saveStreamMapping

public boolean saveStreamMapping(StreamMappingDTO[] streamMappingDTOs,
                        String configName,
                        String domainName)
                          throws org.apache.axis2.AxisFault

When the template refers to a stream (say StreamX) which needs to be populated by a user-defined stream (say StreamY), specify how attributes in StreamY needs to be mapped to StreamX, using the streamMappingDTO, and invoke this service. This service will create a Siddhi execution plan, which will select required attributes (as specified in the mapping) from StreamY and insert into StreamX.

Parameters:

streamMappingDTOs - Each StreamMappingDTO maps a user-defined stream to a stream defined in the template.

configName - ScenarioConfiguration name

domainName - domain name of the Domain.

Returns:

true on successful operation completion.

Throws:

org.apache.axis2.AxisFault