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.batch;
021    
022    import org.apache.commons.configuration.Configuration;
023    import org.sonar.api.batch.ResourceCreationLock;
024    
025    /**
026     * This lock is used to ensure that Sonar resources (files, packages, directories) are not created by buggy plugins
027     * when saving measures/violations on unknown resources.
028     *
029     * @since 2.3
030     */
031    public final class DefaultResourceCreationLock implements ResourceCreationLock {
032    
033      private boolean locked = false;
034      private boolean failWhenLocked=false;
035    
036      public DefaultResourceCreationLock() {
037      }
038    
039      public DefaultResourceCreationLock(Configuration configuration) {
040        this.failWhenLocked = configuration.getBoolean("sonar.hardIndexLock", false);
041      }
042    
043      public boolean isLocked() {
044        return locked;
045      }
046    
047      public void lock() {
048        this.locked = true;
049      }
050    
051      /**
052       * Unlocking is for internal use only.
053       */
054      public void unlock() {
055        locked = false;
056      }
057    
058      public boolean isFailWhenLocked() {
059        return failWhenLocked;
060      }
061    
062      public void setFailWhenLocked(boolean b) {
063        this.failWhenLocked = b;
064      }
065    }