Package hudson.model

Interface TaskListener

  • All Superinterfaces:
    Serializable, org.jenkinsci.remoting.SerializableOnlyOverRemoting
    All Known Subinterfaces:
    All Known Implementing Classes:
    AbstractTaskListener, BuildListenerAdapter, LogTaskListener, StreamBuildListener, StreamTaskListener

    public interface TaskListener
    extends org.jenkinsci.remoting.SerializableOnlyOverRemoting
    Receives events that happen during some lengthy operation that has some chance of failures, such as a build, SCM change polling, agent launch, and so on.

    This interface is implemented by Hudson core and passed to extension points so that they can record the progress of the operation without really knowing how those information and handled/stored by Hudson.

    The information is one way or the other made available to users, and so the expectation is that when something goes wrong, enough information shall be written to a TaskListener so that the user can diagnose what's going wrong.

    StreamTaskListener is the most typical implementation of this interface.

    Implementations are generally expected to be remotable via Channel.

    Kohsuke Kawaguchi