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