JSPWiki
  1. JSPWiki
  2. JSPWIKI-303

JSPWiki-API library creation

        Details

        • Type: New Feature New Feature
        • Status: Open
        • Priority: Critical Critical
        • Resolution: Unresolved
        • Affects Version/s: None
        • Fix Version/s: 2.10.2
        • Component/s: Core & storage
        • Labels:
          None

          Description

          The proposal is to create a "jspwiki-api.jar", which would contain all the interfaces and classes from "com.ecyrd.jspwiki.api" -package. This would be a new package, which contains a set of interfaces (and probably some basic datacontainer classes) to provide access to JSPWiki innards.

          The design of the API set is available in http://www.jspwiki.org/wiki/JSPWiki3APIDesignProposal

            Issue Links

            relates to

            Improvement - An improvement or enhancement to an existing feature or task. JSPWIKI-155 Allow customisation of core classes via ClassUtil.getMappedObject

            • Minor - Minor loss of function, or other problem where easy workaround is present.
            • Resolved

            Task - A task that needs to be done. JSPWIKI-38 Rename packages to "org.apache.jspwiki"

            • Major - Major loss of function.
            • Closed

              Activity

              Ascending order - Click to sort in descending order
              Hide
              Permalink
              Janne Jalkanen added a comment -

              As this is a part of the 3.0 API promise, it should be considered as blocking.

              Show
              Janne Jalkanen added a comment - As this is a part of the 3.0 API promise, it should be considered as blocking.
              Hide
              Permalink
              Andrew Jaquith added a comment -

              We haven't had any activity on this issue for a while, so I would like to recap my latest proposal for this issue.

              Per a friendly beer discussion I had with Janne last year (plus a few follow-up e-mails), I propose we do the following:

              • The official API package, for stable interfaces (primarily) and stable classes (where possible) is "org.apache.wiki".
              • The implementation package is "org.apache.wikibase" or "org.apache.wikicore". This package name is still fairly short and snappy, but isn't as ugly as tacking on an "-impl" suffix to "wiki" might be.
              • Separate Eclipse source folders for the two package trees.
              • Separate JAR files for the wiki.* and wikbase.* classes.

              Can I request a vote on this? Please post your comments in JIRA.

              Show
              Andrew Jaquith added a comment - We haven't had any activity on this issue for a while, so I would like to recap my latest proposal for this issue. Per a friendly beer discussion I had with Janne last year (plus a few follow-up e-mails), I propose we do the following: The official API package, for stable interfaces (primarily) and stable classes (where possible) is "org.apache.wiki". The implementation package is "org.apache.wikibase" or "org.apache.wikicore". This package name is still fairly short and snappy, but isn't as ugly as tacking on an "-impl" suffix to "wiki" might be. Separate Eclipse source folders for the two package trees. Separate JAR files for the wiki.* and wikbase.* classes. Can I request a vote on this? Please post your comments in JIRA.
              Hide
              Permalink
              Harry Metske added a comment -

              Agreed on all points.

              Does this require an official vote on the mailing list ?

              Show
              Harry Metske added a comment - Agreed on all points. Does this require an official vote on the mailing list ?
              Hide
              Permalink
              Janne Jalkanen added a comment -

              I actually propose now that we forget this and just get on with the release. We'll have a whole new round of discussions on what should be in those pages and what not. If anything, we should start a separate project e.g. under "org.jspwiki" space to provide an API package and then retrofit ourselves to that API.

              Show
              Janne Jalkanen added a comment - I actually propose now that we forget this and just get on with the release. We'll have a whole new round of discussions on what should be in those pages and what not. If anything, we should start a separate project e.g. under "org.jspwiki" space to provide an API package and then retrofit ourselves to that API.
              Hide
              Permalink
              Andrew Jaquith added a comment -

              Postponing until 3.1.

              Show
              Andrew Jaquith added a comment - Postponing until 3.1.

                People

                • Assignee:
                  Juan Pablo Santos Rodríguez
                  Reporter:
                  Janne Jalkanen
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  0 Start watching this issue

                  Dates

                  • Created:
                    Updated:

                    Development