org.modeshape.jcr.federation.spi.WritableConnector Maven / Gradle / Ivy

Go to download
/*
 * ModeShape (http://www.modeshape.org)
 * See the COPYRIGHT.txt file distributed with this work for information
 * regarding copyright ownership.  Some portions may be licensed
 * to Red Hat, Inc. under one or more contributor license agreements.
 * See the AUTHORS.txt file in the distribution for a full listing of
 * individual contributors.
 *
 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
 * is licensed to you under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * ModeShape is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.modeshape.jcr.federation.spi;

/**
 * A specialized abstract {@link Connector} class that is support both reads and writes. In addition, this class has a {@code readonly}
 * flag allowing clients to configure a writable connector (external source) as read-only. In this case, all of the write operations
 * will throw an exception.

* @author Horia Chiorean ([email protected])
 */
public abstract class WritableConnector extends Connector {

    /**
     * A flag which indicates whether a connector allows both write & read operations, or only read operations. If a connector
     * is read-only, any attempt to write content (add/update/delete etc) will result in an exception being raised.
     */
    private boolean readonly = false;

    @Override
    public boolean isReadonly() {
        return readonly;
    }
}