001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2015 ForgeRock AS.
015 */
016package org.opends.server.backends.pluggable.spi;
017
018/** Defines access modes of a Storage. */
019public enum AccessMode {
020  /** Constant used to open the Storage in read-only mode; implies missing trees will be ignored. */
021  READ_ONLY(false),
022  /** Constant used to open the Storage in read-write mode; implies trees will be created if not already present. */
023  READ_WRITE(true);
024
025  private final boolean readWrite;
026
027  AccessMode(boolean update)
028  {
029    this.readWrite = update;
030  }
031
032  /**
033   * Returns if the storage is being opened READ_WRITE.
034   *
035   * @return true if the storage is being opened READ_WRITE
036   */
037  public boolean isWriteable()
038  {
039    return readWrite;
040  }
041}