Package org.wso2.carbon.proxyadmin.common.service

Interface IProxyServiceAdmin

public interface IProxyServiceAdmin
The class IProxyServiceAdmin provides the administration service to configure proxy services.

  • Method Details

    • enableStatistics

      String enableStatistics(String proxyName) throws ProxyAdminException
      Enables statistics for the specified proxy service
      Parameters:
      proxyName - name of the proxy service name of which the statistics need to be enabled
      Returns:
      successful on success or failed otherwise
      Throws:
      ProxyAdminException - in case of a failure in enabling statistics

    • disableStatistics

      String disableStatistics(String proxyName) throws ProxyAdminException
      Disables statistics for the specified proxy servivce
      Parameters:
      proxyName - name of the proxy service of which statistics need to be disabled
      Returns:
      successful on success or failed if unsuccessful
      Throws:
      ProxyAdminException - in case of a failure in disabling statistics

    • enableTracing

      String enableTracing(String proxyName) throws ProxyAdminException
      Enables tracing for the specified proxy service
      Parameters:
      proxyName - name of the the proxy service of which tracing needs to be enabled
      Returns:
      successful on success or failed otherwise
      Throws:
      ProxyAdminException - in case of a failure in enabling tracing

    • disableTracing

      String disableTracing(String proxyName) throws ProxyAdminException
      Disables tracing for the specified proxy service
      Parameters:
      proxyName - name of the proxy service of which tracing needs to be disabled
      Returns:
      SUCCESSFUL is the operation is successful and FAILED if it is failed
      Throws:
      ProxyAdminException - in case of a failure in disabling tracing

    • deleteProxyService

      String deleteProxyService(String proxyName) throws ProxyAdminException
      Deletes a proxy service from the synapse configuration
      Parameters:
      proxyName - name of the proxy service which needs to be deleted
      Returns:
      successful on success or failed otherwise
      Throws:
      ProxyAdminException - if the proxy service name given is not existent in the synapse configuration

    • getAvailableTransports

      String[] getAvailableTransports() throws ProxyAdminException
      Get the available transport names from the AxisConfiguration
      Returns:
      String array of available transport names
      Throws:
      ProxyAdminException

    • getAvailableSequences

      String[] getAvailableSequences() throws ProxyAdminException
      Get the available sequences from the SynapseConfiguration
      Returns:
      String array of available sequence names
      Throws:
      ProxyAdminException - if there is an error

    • getAvailableEndpoints

      String[] getAvailableEndpoints() throws ProxyAdminException
      Get the available endpoints from the SynapseConfiguration
      Returns:
      String array of available endpoint names
      Throws:
      ProxyAdminException - if there is an error

    • getEndpoint

      String getEndpoint(String name) throws ProxyAdminException
      Gets the endpoint object defined under the given name
      Parameters:
      name - the name of the endpoint
      Returns:
      endpoint configuration related with the name
      Throws:
      ProxyAdminException - if the endpoint is not found for the given name

    • getMetaData

      MetaData getMetaData() throws ProxyAdminException
      Encapsulates the available transports, endpoints, and sequences into a single two dimensional array
      Returns:
      A two dimensional array containing the set of transports, endpoints, and sequences under 0,1, and 2 indices.
      Throws:
      ProxyAdminException

    • startProxyService

      String startProxyService(String proxyName) throws ProxyAdminException
      Starts the service specified by the name
      Parameters:
      proxyName - name of the proxy service which needs to be started
      Returns:
      successful on success or failed otherwise
      Throws:
      ProxyAdminException - incase of a failure in starting the service

    • stopProxyService

      String stopProxyService(String proxyName) throws ProxyAdminException
      Stops the service specified by the name
      Parameters:
      proxyName - name of the proxy service which needs to be stoped
      Returns:
      successful on success or failed otherwise
      Throws:
      ProxyAdminException - in case of a failure in stopping the service

    • redeployProxyService

      String redeployProxyService(String proxyName) throws ProxyAdminException
      Redeploying service Removes an existing one,Adds a new one
      Parameters:
      proxyName - name of the proxy service which needs to be redeployed
      Returns:
      successful on success or failed otherwise
      Throws:
      ProxyAdminException - in case of a failure in redeploying the service

    • getSourceView

      String getSourceView(ProxyData pd) throws ProxyAdminException
      Throws:
      ProxyAdminException

    • getProxy

      ProxyData getProxy(String proxyName) throws ProxyAdminException
      Throws:
      ProxyAdminException

    • addProxy

      String addProxy(ProxyData pd) throws ProxyAdminException
      Throws:
      ProxyAdminException

    • modifyProxy

      String modifyProxy(ProxyData pd) throws ProxyAdminException
      Throws:
      ProxyAdminException