Package org.apache.wiki.providers

Class WikiPageAdapterProvider

  • All Implemented Interfaces:
    PageProvider, WikiProvider
    @Deprecated
public class WikiPageAdapterProvider
extends java.lang.Object
implements PageProvider
    Deprecated.
    adapted provider should use PageProvider instead.
    This provider ensures backward compatibility with page providers not using the public API. As providers should use the public API directly, the use of this class is considered deprecated.
    See Also:
    PageProvider

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void deletePage​(java.lang.String pageName)
      Deprecated.
      Removes an entire page from the repository.
      void deleteVersion​(java.lang.String pageName, int version)
      Deprecated.
      Removes a specific version from the repository.
      java.util.Collection<SearchResult> findPages​(QueryItem[] query)
      Deprecated.
      Finds pages based on the query.
      java.util.Collection<Page> getAllChangedSince​(java.util.Date date)
      Deprecated.
      Gets a list of recent changes.
      java.util.Collection<Page> getAllPages()
      Deprecated.
      Returns all pages.
      int getPageCount()
      Deprecated.
      Gets the number of pages.
      Page getPageInfo​(java.lang.String page, int version)
      Deprecated.
      Returns info about the page.
      java.lang.String getPageText​(java.lang.String page, int version)
      Deprecated.
      Gets a specific version out of the repository.
      java.lang.String getProviderInfo()
      Deprecated.
      Return a valid HTML string for information.
      java.util.List<Page> getVersionHistory​(java.lang.String page)
      Deprecated.
      Returns version history.
      void initialize​(Engine engine, java.util.Properties properties)
      Deprecated.
      Initializes the page provider.
      void movePage​(java.lang.String from, java.lang.String to)
      Deprecated.
      Move a page
      boolean pageExists​(java.lang.String page)
      Deprecated.
      Return true, if page exists.
      boolean pageExists​(java.lang.String page, int version)
      Deprecated.
      Return true, if page with a particular version exists.
      void putPageText​(Page page, java.lang.String text)
      Deprecated.
      Attempts to save the page text for page "page".

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • initialize

        public void initialize​(Engine engine,
                       java.util.Properties properties)
                throws NoRequiredPropertyException,
                       java.io.IOException
        Deprecated.
        Initializes the page provider.
        Specified by:
        initialize in interface WikiProvider
        Parameters:
        engine - Engine to own this provider
        properties - A set of properties used to initialize this provider
        Throws:
        NoRequiredPropertyException - If the provider needs a property which is not found in the property set
        java.io.IOException - If there is an IO problem

      • getProviderInfo

        public java.lang.String getProviderInfo()
        Deprecated.
        Return a valid HTML string for information. May be anything.
        Specified by:
        getProviderInfo in interface WikiProvider
        Returns:
        A string describing the provider.

      • putPageText

        public void putPageText​(Page page,
                        java.lang.String text)
                 throws ProviderException
        Deprecated.
        Attempts to save the page text for page "page". Note that the provider creates a new version regardless of what the version parameter of the WikiPage is.
        Specified by:
        putPageText in interface PageProvider
        Parameters:
        page - The WikiPage to save
        text - The text to save.
        Throws:
        ProviderException - If something goes wrong.

      • pageExists

        public boolean pageExists​(java.lang.String page)
        Deprecated.
        Return true, if page exists.
        Specified by:
        pageExists in interface PageProvider
        Parameters:
        page - The page name.
        Returns:
        true, if the page exists; false otherwise.

      • pageExists

        public boolean pageExists​(java.lang.String page,
                          int version)
        Deprecated.
        Return true, if page with a particular version exists.
        Specified by:
        pageExists in interface PageProvider
        Parameters:
        page - The page name to check for
        version - The version to check
        Returns:
        True, if page exists; false otherwise.

      • findPages

        public java.util.Collection<SearchResult> findPages​(QueryItem[] query)
        Deprecated.
        Finds pages based on the query. Only applicable to providers which implement the FastSearch interface. Otherwise JSPWiki will use its internal cache.

        This method should really be a part of the FastSearch IF.

        Specified by:
        findPages in interface PageProvider
        Parameters:
        query - An array of QueryItems to match
        Returns:
        A Collection of WikiPages.

      • getAllChangedSince

        public java.util.Collection<Page> getAllChangedSince​(java.util.Date date)
        Deprecated.
        Gets a list of recent changes.
        Specified by:
        getAllChangedSince in interface PageProvider
        Parameters:
        date - The date to check from
        Returns:
        A Collection of WikiPages

      • getPageText

        public java.lang.String getPageText​(java.lang.String page,
                                    int version)
                             throws ProviderException
        Deprecated.
        Gets a specific version out of the repository.
        Specified by:
        getPageText in interface PageProvider
        Parameters:
        page - Name of the page to fetch.
        version - Version of the page to fetch.
        Returns:
        The content of the page, or null, if the page does not exist.
        Throws:
        ProviderException - If something goes wrong.

      • deleteVersion

        public void deleteVersion​(java.lang.String pageName,
                          int version)
                   throws ProviderException
        Deprecated.
        Removes a specific version from the repository. The implementations should really do no more security checks, since that is the domain of the PageManager. Just delete it as efficiently as you can.
        Specified by:
        deleteVersion in interface PageProvider
        Parameters:
        pageName - Name of the page to be removed.
        version - Version of the page to be removed. May be LATEST_VERSION.
        Throws:
        ProviderException - If the page cannot be removed for some reason.

      • deletePage

        public void deletePage​(java.lang.String pageName)
                throws ProviderException
        Deprecated.
        Removes an entire page from the repository. The implementations should really do no more security checks, since that is the domain of the PageManager. Just delete it as efficiently as you can. You should also delete any auxiliary files that belong to this page, IF they were created by this provider.

        The reason why this is named differently from deleteVersion() (logically, this method should be an overloaded version) is that I want to be absolutely sure I don't accidentally use the wrong method. With overloading something like that happens sometimes...

        Specified by:
        deletePage in interface PageProvider
        Parameters:
        pageName - Name of the page to be removed completely.
        Throws:
        ProviderException - If the page could not be removed for some reason.

      • movePage

        public void movePage​(java.lang.String from,
                     java.lang.String to)
              throws ProviderException
        Deprecated.
        Move a page
        Specified by:
        movePage in interface PageProvider
        Parameters:
        from - Name of the page to move.
        to - New name of the page.
        Throws:
        ProviderException - If the page could not be moved for some reason.