001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube 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     * SonarQube 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     */
020    package org.sonar.batch.scan;
021    
022    import org.sonar.api.batch.bootstrap.ProjectBuilder;
023    import org.sonar.api.batch.bootstrap.ProjectReactor;
024    import org.sonar.api.batch.bootstrap.internal.ProjectBuilderContext;
025    
026    import javax.annotation.Nullable;
027    
028    /**
029     * Barrier to control the project lifecycle :
030     * <p/>
031     * <ul>
032     * <li>initialize the project configuration by executing ProjectBuilder extensions</li>
033     * <li>apply sub-project exclusions (sonar.skippedModules, ...)</li>
034     * <li>---- this barrier ----</li>
035     * <li>run optional dry run database</li>
036     * <li>connect to dry-run or remote database</li>
037     * </ul>
038     */
039    public class ProjectReactorReady {
040    
041      private final ProjectReactor reactor;
042      private ProjectBuilder[] projectBuilders;
043      private ProjectExclusions exclusions;
044      private ProjectReactorValidator validator;
045    
046      public ProjectReactorReady(ProjectExclusions exclusions, ProjectReactor reactor, @Nullable ProjectBuilder[] projectBuilders, ProjectReactorValidator validator) {
047        this.exclusions = exclusions;
048        this.reactor = reactor;
049        this.projectBuilders = projectBuilders;
050        this.validator = validator;
051      }
052    
053      public ProjectReactorReady(ProjectExclusions exclusions, ProjectReactor reactor, ProjectReactorValidator validator) {
054        this(exclusions, reactor, new ProjectBuilder[0], validator);
055      }
056    
057      public void start() {
058        // 1 Apply project builders
059        ProjectBuilderContext context = new ProjectBuilderContext(reactor);
060    
061        for (ProjectBuilder projectBuilder : projectBuilders) {
062          projectBuilder.build(context);
063        }
064    
065        // 2 Apply project exclusions
066        exclusions.apply();
067    
068        // 3 Validate final reactor
069        validator.validate(reactor);
070      }
071    }