Package eu.miltema.slimweb.push

Interface PushHandle

  • All Known Implementing Classes:
    PushHandleImpl
    public interface PushHandle

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.Object getCustomData()  
      javax.servlet.http.HttpSession getHttpSession()  
      java.lang.String getLanguage()  
      java.lang.Object getSessionObject()  
      boolean isPushOpen()  
      void pushObject​(java.lang.Object object)
      Push an object to browser
      void redirect​(java.lang.Class<?> componentClass, java.lang.String parameters)
      Redirect browser to a new target component
      void redirect​(java.lang.String url)
      Redirect browser to a new URL
      void setCustomData​(java.lang.Object customData)
      Set custom data, which would be accessible in both, pushStarted() and pushTerminated()
      void setSessionObject​(java.lang.Object sessionObject)
      Update session object in http session
      void terminatePush()
      Terminate push connection

    • Method Detail

      • pushObject

        void pushObject​(java.lang.Object object)
        Push an object to browser
        Parameters:
        object - object to push

      • terminatePush

        void terminatePush()
        Terminate push connection

      • isPushOpen

        boolean isPushOpen()
        Returns:
        true, if push connection is open

      • getHttpSession

        javax.servlet.http.HttpSession getHttpSession()
        Returns:
        http session associated with this push connection

      • setCustomData

        void setCustomData​(java.lang.Object customData)
        Set custom data, which would be accessible in both, pushStarted() and pushTerminated()
        Parameters:
        customData - custom data

      • getCustomData

        java.lang.Object getCustomData()
        Returns:
        custom data

      • getLanguage

        java.lang.String getLanguage()
        Returns:
        current language

      • getSessionObject

        java.lang.Object getSessionObject()
        Returns:
        session object, which was registered in SlimwebConfiguration

      • setSessionObject

        void setSessionObject​(java.lang.Object sessionObject)
        Update session object in http session
        Parameters:
        sessionObject - session object

      • redirect

        void redirect​(java.lang.String url)
        Redirect browser to a new URL
        Parameters:
        url - target url

      • redirect

        void redirect​(java.lang.Class<?> componentClass,
              java.lang.String parameters)
        Redirect browser to a new target component
        Parameters:
        componentClass - target component class
        parameters - URL get-parameters, for example "attr1=john&attr2=smith"