Package com.helger.photon.api

Interface IAPIInvoker

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    APIInvoker
    public interface IAPIInvoker
extends Serializable
    Base interface for an API invoker. It has a set of IAPIExecutor instances that it can invoke.
    Author:
    Philip Helger

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void invoke​(InvokableAPIDescriptor aInvokableDescriptor, com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope, com.helger.servlet.response.UnifiedResponse aUnifiedResponse)
      Invoke the specified API

    • Method Detail

      • invoke

        void invoke​(@Nonnull
            InvokableAPIDescriptor aInvokableDescriptor,
            @Nonnull
            com.helger.web.scope.IRequestWebScopeWithoutResponse aRequestScope,
            @Nonnull
            com.helger.servlet.response.UnifiedResponse aUnifiedResponse)
     throws Exception
        Invoke the specified API
        Parameters:
        aInvokableDescriptor - The invokable descriptor. Never null.
        aRequestScope - The current request scope. Never null.
        aUnifiedResponse - The current response object, with caching already disabled. Never null.
        Throws:
        Exception - In case something goes wrong