Interface BusinessServiceConfigurationMBean

All Superinterfaces:
CommonServiceConfigurationMBean, MonitoringConfigurationMBean

public interface BusinessServiceConfigurationMBean extends CommonServiceConfigurationMBean
Provides API for managing business services
  • Field Details

  • Method Details

    • synchronizeServices

      Diagnostics[] synchronizeServices(Collection<Ref> refs, HandleDelete handleDelete) throws NotFoundException, IllegalArgumentException
      Synchronizes a collection of business services by importing them from the registry. If the collection contains a service which was not originally imported from the registry then it will be ignored.
      Parameters:
      refs - Collection of all the Ref which have to be synchronized.
      handleDelete -
    • HandleDelete.MarkForDelete
    • In this case all the services which are not found in the registry will be marked for deletion.
    • HandleDelete.Delete
    • In this case all the services which are not found in the registry will be Deleted from the OSB.
    • HandleDelete.Detach
    • In this case all the services which are not found in the registry will be detached from the registry.
      Returns:
      Any error during the synchronization will be provided back in Diagnostics.
      Throws:
      NotFoundException - If a Ref is not found.
      IllegalArgumentException - If the Ref does not corresponds to a business service ref.
    • detachBusinessServicesFromRegistry

      void detachBusinessServicesFromRegistry(Collection<Ref> refs) throws NotFoundException, IllegalArgumentException
      Detaches a collection of Business Services from the registry. If the collection contains a service that was not originally imported from the registry then it will be ignored.
      Parameters:
      refs - Collection of Refs to be detached.
      Throws:
      NotFoundException - If the resource is not found.
      IllegalArgumentException - If the ref does not corresponds to a business service ref.
    • isResultCachingEnabled

      boolean isResultCachingEnabled(Ref serviceref) throws Exception
      Returns true if result caching is enabled
      Parameters:
      serviceref - reference to the service
      Throws:
      Exception
    • enableResultCaching

      void enableResultCaching(Ref serviceref) throws Exception
      Enables result caching for the service.
      Parameters:
      serviceref - reference to the service
      Throws:
      Exception
    • disableResultCaching

      void disableResultCaching(Ref serviceref) throws Exception
      Disables result caching for the service.
      Parameters:
      serviceref - reference to the service
      Throws:
      Exception
    • isThrottlingEnabled

      boolean isThrottlingEnabled(Ref serviceref) throws Exception
      Returns true if throttling is enabled
      Parameters:
      serviceref - reference to the service
      Throws:
      Exception
    • enableThrottling

      void enableThrottling(Ref serviceref) throws Exception
      Enables throttling for the service.
      Parameters:
      serviceref - reference to the service
      Throws:
      Exception
    • disableThrottling

      void disableThrottling(Ref serviceref) throws Exception
      Disables throttling for the service.
      Parameters:
      serviceref - reference to the service
      Throws:
      Exception
    • isURIOfflineEnabled

      boolean isURIOfflineEnabled(Ref serviceref) throws Exception
      Returns true if URI Offline is enabled
      Parameters:
      serviceref - reference to the service
      Throws:
      Exception
    • enableURIOffline

      void enableURIOffline(Ref serviceref) throws Exception
      Enables URI Offline for the service.
      Parameters:
      serviceref - reference to the service
      Throws:
      Exception
    • disableURIOffline

      void disableURIOffline(Ref serviceref) throws Exception
      Disables URI Offline for the service.
      Parameters:
      serviceref - reference to the service
      Throws:
      Exception