Package org.apache.wiki.api.filters

Class BasicPageFilter

    • Constructor Summary

      Constructors 
      Constructor Description
      BasicPageFilter()
      Deprecated.
       

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void destroy​(Engine engine)
      Deprecated.
      Called for every filter, e.g. on wiki engine shutdown.
      void destroy​(WikiEngine engine)
      Deprecated.
       
      void initialize​(WikiEngine engine, java.util.Properties properties)
      Deprecated.
       
      void postSave​(Context wikiContext, java.lang.String content)
      Deprecated.
      This method is called after the page has been successfully saved.
      void postSave​(WikiContext wikiContext, java.lang.String content)
      Deprecated.
       
      java.lang.String postTranslate​(Context wikiContext, java.lang.String htmlContent)
      Deprecated.
      This method is called after a page has been fed through the translation process, so anything you are seeing here is translated content.
      java.lang.String postTranslate​(WikiContext wikiContext, java.lang.String htmlContent)
      Deprecated.
       
      java.lang.String preSave​(Context wikiContext, java.lang.String content)
      Deprecated.
      This method is called before the page has been saved to the PageProvider.
      java.lang.String preSave​(WikiContext wikiContext, java.lang.String content)
      Deprecated.
       
      java.lang.String preTranslate​(Context wikiContext, java.lang.String content)
      Deprecated.
      This method is called whenever a page has been loaded from the provider, but not yet been sent through the markup-translation process.
      java.lang.String preTranslate​(WikiContext wikiContext, java.lang.String content)
      Deprecated.
       

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • preTranslate

        public java.lang.String preTranslate​(Context wikiContext,
                                     java.lang.String content)
                              throws FilterException
        Deprecated.
        Description copied from interface: PageFilter
        This method is called whenever a page has been loaded from the provider, but not yet been sent through the markup-translation process. Note that you cannot do HTML translation here, because it will be escaped.
        Parameters:
        wikiContext - The current context.
        content - WikiMarkup.
        Returns:
        The modified wikimarkup content. Default implementation returns the markup as received.
        Throws:
        FilterException - If something goes wrong. Throwing this causes the entire page processing to be abandoned.

      • postTranslate

        public java.lang.String postTranslate​(Context wikiContext,
                                      java.lang.String htmlContent)
                               throws FilterException
        Deprecated.
        Description copied from interface: PageFilter
        This method is called after a page has been fed through the translation process, so anything you are seeing here is translated content. If you want to do any of your own WikiMarkup2HTML translation, do it here.
        Parameters:
        wikiContext - The WikiContext.
        htmlContent - The translated HTML.
        Returns:
        The modified HTML. Default implementation returns the translated html as received.
        Throws:
        FilterException - If something goes wrong. Throwing this causes the entire page processing to be abandoned.

      • preSave

        public java.lang.String preSave​(Context wikiContext,
                                java.lang.String content)
                         throws FilterException
        Deprecated.
        Description copied from interface: PageFilter
        This method is called before the page has been saved to the PageProvider.
        Parameters:
        wikiContext - The WikiContext
        content - The wikimarkup that the user just wanted to save.
        Returns:
        The modified wikimarkup. Default implementation returns the markup as received.
        Throws:
        FilterException - If something goes wrong. Throwing this causes the entire page processing to be abandoned.

      • postSave

        public void postSave​(Context wikiContext,
                     java.lang.String content)
              throws FilterException
        Deprecated.
        Description copied from interface: PageFilter
        This method is called after the page has been successfully saved. If the saving fails for any reason, then this method will not be called.

        Since the result is discarded from this method, this is only useful for things like counters, etc.

        Parameters:
        wikiContext - The WikiContext
        content - The content which was just stored.
        Throws:
        FilterException - If something goes wrong. As the page is already saved, This is just logged.

      • destroy

        public void destroy​(Engine engine)
        Deprecated.
        Description copied from interface: PageFilter
        Called for every filter, e.g. on wiki engine shutdown. Use this if you have to clean up or close global resources you allocated in the initialize() method.
        Parameters:
        engine - The Engine which owns this filter.