Class LocalFileKnowledgeBase

    • Constructor Detail

      • LocalFileKnowledgeBase

        public LocalFileKnowledgeBase​(CopyOnWriteList<FailureCause> legacyCauses)
        Standard constructor. Used for legacy conversion.
        Parameters:
        legacyCauses - the causes.
      • LocalFileKnowledgeBase

        public LocalFileKnowledgeBase​(Collection<FailureCause> initialCauses)
        Standard constructor. Used for simple testability.
        Parameters:
        initialCauses - the causes.
      • LocalFileKnowledgeBase

        @DataBoundConstructor
        public LocalFileKnowledgeBase()
        Default constructor.
    • Method Detail

      • getCauses

        public Collection<FailureCause> getCauses()
        Description copied from class: KnowledgeBase
        Get the list of FailureCauses. It is intended to be used in the scanning phase hence it should be returned as quickly as possible, so the list could be cached.
        Specified by:
        getCauses in class KnowledgeBase
        Returns:
        the full list of causes.
      • getCauseNames

        public Collection<FailureCause> getCauseNames()
        Description copied from class: KnowledgeBase
        Get the list of the FailureCause's names and ids. The list should be the latest possible from the DB as they will be used for editing. The objects returned should contain at least the id and the name of the cause.
        Specified by:
        getCauseNames in class KnowledgeBase
        Returns:
        the full list of the names and ids of the causes.
      • getShallowCauses

        public Collection<FailureCause> getShallowCauses()
                                                  throws Exception
        Description copied from class: KnowledgeBase
        Get a shallow list of the FailureCauses. The list should be the latest possible from the DB as they will be used in the list of causes to edit. shallow meaning no indications but information enough to show a nice list; at least id and name but description, comment, lastOccurred and categories are preferred as well.
        Specified by:
        getShallowCauses in class KnowledgeBase
        Returns:
        a shallow list of all causes.
        Throws:
        Exception - if something in the KnowledgeBase handling goes wrong.
        See Also:
        KnowledgeBase.getCauseNames()
      • getCause

        public FailureCause getCause​(String id)
        Description copied from class: KnowledgeBase
        Get the cause with the given id. The cause returned is intended to be edited right away, so it should be as fresh from the db as possible.
        Specified by:
        getCause in class KnowledgeBase
        Parameters:
        id - the id of the cause.
        Returns:
        the cause or null if a cause with that id could not be found.
      • put

        protected void put​(FailureCause cause)
        Puts the cause directly into the map. Does not call save.
        Parameters:
        cause - the cause to put.
      • convertFrom

        public void convertFrom​(KnowledgeBase oldKnowledgeBase)
                         throws Exception
        Description copied from class: KnowledgeBase
        Converts the existing old knowledge base into this one. Will be called after the creation of a new object when then Jenkins config is saved, So it could just be that the old one is exactly the same as this one.
        Specified by:
        convertFrom in class KnowledgeBase
        Parameters:
        oldKnowledgeBase - the old one.
        Throws:
        Exception - if something in the KnowledgeBase handling goes wrong.
      • equals

        public boolean equals​(KnowledgeBase oldKnowledgeBase)
        Description copied from class: KnowledgeBase
        Called to see if the configuration has changed.
        Specified by:
        equals in class KnowledgeBase
        Parameters:
        oldKnowledgeBase - the previous config.
        Returns:
        true if it is the same.
      • start

        public void start()
        Description copied from class: KnowledgeBase
        Called when the KnowledgeBase should be up and running.
        Specified by:
        start in class KnowledgeBase
      • stop

        public void stop()
        Description copied from class: KnowledgeBase
        Called when it is time to clean up after the KnowledgeBase.
        Specified by:
        stop in class KnowledgeBase
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • isEnableStatistics

        public boolean isEnableStatistics()
        Description copied from class: KnowledgeBase
        If Statistics logging is enabled on this knowledge base or not.
        Specified by:
        isEnableStatistics in class KnowledgeBase
        Returns:
        true if so. False if not or not implemented.
      • removeBuildfailurecause

        public void removeBuildfailurecause​(Run build)
                                     throws Exception
        Description copied from class: KnowledgeBase
        Removes the build failure cause of particular build.
        Overrides:
        removeBuildfailurecause in class KnowledgeBase
        Parameters:
        build - the build.
        Throws:
        Exception - if something in the KnowledgeBase handling goes wrong.