001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2008-2012 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar 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     * Sonar 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
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.batch;
021    
022    import org.sonar.api.BatchComponent;
023    
024    /**
025     * This lock is used to ensure that Sonar resources (files, packages, directories) are not created by buggy plugins
026     * when saving measures/violations on unknown resources.
027     * 
028     * @since 2.3
029     */
030    public interface ResourceCreationLock extends BatchComponent {
031    
032      /**
033       * Forbids the creation of resources when saving violations and measures. By default it's unlocked, so only warnings
034       * are logged. When locked, then an exception is thrown.
035       */
036      void lock();
037      
038    }