Class SearchFactory

  • All Implemented Interfaces:

    public abstract class SearchFactory
    extends Object
    implements ExtensionPoint
    Creates a Search instance for a SearchableModelObject.

    This allows you to plug in different backends to the search, such as full-text search, or more intelligent user-sensitive search, etc. Puts @Extension annotation on your implementation to have it registered.

    Right now, there's no user control over which SearchFactory takes priority, but we may do so later.

    Kohsuke Kawaguchi
    • Constructor Detail

      • SearchFactory

        public SearchFactory()
    • Method Detail

      • createFor

        public abstract Search createFor​(SearchableModelObject owner)
        Creates a Search object. This method needs to execute quickly (without actually executing any search), since it is created per incoming HTTP response.
        owner - The SearchableModelObject object for which we are creating the search. The returned object will provide the search for this object.
        null if your factory isn't interested in creating a Search object. The next factory will get a chance to act on it.