Package org.webappos.webproc

Interface IRWebProcessorBusService

  • All Superinterfaces:
    java.rmi.Remote
    public interface IRWebProcessorBusService
extends java.rmi.Remote
    Used by server-side and remote server-side web processors to register themselves within the server-side bridge as well as to obtain pointers to server-side API.
    Implemented using Java RMI.
    Author:
    Sergejs Kozlovics

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ConfigStatic getConfig()
      Called when initializing server-side API inside web processors to obtain current webAppOS configuration (loaded from webappos.properties).
      org.webappos.properties.IRPropertiesManager getPropertiesManager()
      Called when initializing server-side API inside web processors to obtain the properties manager for accessing apps, engines, and services properties.
      org.webappos.registry.IRRegistry getRegistry()
      Called when initializing server-side API inside web processors to obtain a pointer to Registry API.
      org.webappos.status.IRStatus getStatus()
      Called when initializing server-side API inside web processors to obtain a pointer to Status API.
      org.webappos.webcaller.IRWebCaller getWebCaller()
      Called when initializing server-side API inside web processors to obtain a pointer to Web Caller API to be able to make web calls.
      org.webappos.webmem.IRWebMemoryArea getWebMemoryArea()
      Called when initializing server-side API inside web processors to obtain a pointer to web memory area API.
      void registerWebProcessor​(java.lang.String webProcId, IRWebProcessor wpAPI)
      Called by web processors to register themselves within Web Processor Bus Service.
      void webCallFinished​(java.lang.String webProcId, java.lang.String webcallResult)
      Called by each web processor after completing a web call to return the web call result to server-side Web Caller.

    • Method Detail

      • registerWebProcessor

        void registerWebProcessor​(java.lang.String webProcId,
                          IRWebProcessor wpAPI)
                   throws java.rmi.RemoteException
        Called by web processors to register themselves within Web Processor Bus Service.
        Parameters:
        webProcId - the ID of the current web processor that wants to be registered; this ID is passed to a web processor adapter by Web Processor Bus Service when connecting to a web processor
        wpAPI - a callback pointer to the current web processor implementing IRWebProcessor
        Throws:
        java.rmi.RemoteException - on Web Processor Bus error

      • webCallFinished

        void webCallFinished​(java.lang.String webProcId,
                     java.lang.String webcallResult)
              throws java.rmi.RemoteException
        Called by each web processor after completing a web call to return the web call result to server-side Web Caller. After webCallFinished, Web Caller assumes that the current web processor is now available to execute other web calls.
        Parameters:
        webProcId - the ID of the current web processor, which has just finished a web call
        webcallResult - the result of the web call (a stringified JSON in case of "jsoncall" calling conventions, or null in case of "webmemcall")
        Throws:
        java.rmi.RemoteException - on Web Processor Bus error

      • getConfig

        ConfigStatic getConfig()
                throws java.rmi.RemoteException
        Called when initializing server-side API inside web processors to obtain current webAppOS configuration (loaded from webappos.properties).
        Returns:
        a local (web-processor-specific) copy of webAppOS configuration
        Throws:
        java.rmi.RemoteException - on Web Processor Bus error

      • getPropertiesManager

        org.webappos.properties.IRPropertiesManager getPropertiesManager()
                                                          throws java.rmi.RemoteException
        Called when initializing server-side API inside web processors to obtain the properties manager for accessing apps, engines, and services properties.
        Returns:
        a pointer to the properties manager via RMI
        Throws:
        java.rmi.RemoteException - on Web Processor Bus error

      • getWebMemoryArea

        org.webappos.webmem.IRWebMemoryArea getWebMemoryArea()
                                              throws java.rmi.RemoteException
        Called when initializing server-side API inside web processors to obtain a pointer to web memory area API.
        Returns:
        a pointer to web memory area API via RMI
        Throws:
        java.rmi.RemoteException - on Web Processor Bus error

      • getRegistry

        org.webappos.registry.IRRegistry getRegistry()
                                      throws java.rmi.RemoteException
        Called when initializing server-side API inside web processors to obtain a pointer to Registry API.
        Returns:
        a pointer to Registry API via RMI
        Throws:
        java.rmi.RemoteException - on Web Processor Bus error

      • getStatus

        org.webappos.status.IRStatus getStatus()
                                throws java.rmi.RemoteException
        Called when initializing server-side API inside web processors to obtain a pointer to Status API.
        Returns:
        a pointer to Status API via RMI
        Throws:
        java.rmi.RemoteException - on Web Processor Bus error

      • getWebCaller

        org.webappos.webcaller.IRWebCaller getWebCaller()
                                         throws java.rmi.RemoteException
        Called when initializing server-side API inside web processors to obtain a pointer to Web Caller API to be able to make web calls.
        Returns:
        a pointer to Web Caller API via RMI
        Throws:
        java.rmi.RemoteException - on Web Processor Bus error