001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info AT sonarsource DOT com
005 *
006 * This program is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.batch.postjob;
021
022import org.sonar.api.ExtensionPoint;
023import org.sonar.api.batch.ScannerSide;
024
025/**
026 * PostJobs are executed at the very end of scanner analysis. A PostJob can't do any modification
027 * since everything is already computed (issues, measures,...). <br>
028 * WARNING: Do not rely on the fact that analysis results are available on server side when using WS since this is an
029 * asynchronous process to compute data on server side in 5.x series.
030 *
031 * @since 5.2
032 */
033@ScannerSide
034@ExtensionPoint
035public interface PostJob {
036
037  /**
038   * Populate {@link PostJobDescriptor} of this PostJob.
039   */
040  void describe(PostJobDescriptor descriptor);
041
042  /**
043   * Called at the end of the analysis.
044   */
045  void execute(PostJobContext context);
046
047}