Package org.wso2.carbon.apimgt.impl.observers

Interface APIStatusObserver

  • All Known Implementing Classes:
    SimpleLoggingObserver
    public interface APIStatusObserver
    One or more implementations of this interface can be registered with the APIProvider to receive and handle API status update events.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean statusChanged​(String previous, String current, org.wso2.carbon.apimgt.api.model.API api)
      This event is fired every time the status of an API is changed through the APIProvider interface.

    • Method Detail

      • statusChanged

        boolean statusChanged​(String previous,
                      String current,
                      org.wso2.carbon.apimgt.api.model.API api)
        This event is fired every time the status of an API is changed through the APIProvider interface. Note that by the time this event is fired, the status field on the API object is already modified and hence any calls to api.getStatus() will return the latest status (i.e current). The return value of the method determines whether the subsequent observers in the chain should be notified or not. In situation where publishing to gateway is also handled by the APIProvider, this event gets fired before the actual publishing operations.
        Parameters:
        previous - Previous status of the API (i.e status before the update)
        current - Current status of the API
        api - API instance on which the update operation is performed
        Returns:
        true if the next observer in the chain should be invoked, or false to prevent notifying other observers