/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jackrabbit.oak.jcr;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import javax.jcr.InvalidItemStateException;
import org.apache.jackrabbit.oak.api.Tree.Status;
import org.apache.jackrabbit.oak.api.TreeLocation;
import org.apache.jackrabbit.oak.commons.PathUtils;
/**
* Abstract base class for {@link NodeDelegate} and {@link PropertyDelegate}
*/
public abstract class ItemDelegate {
protected final SessionDelegate sessionDelegate;
/** The underlying {@link org.apache.jackrabbit.oak.api.TreeLocation} of this item. */
private TreeLocation location;
ItemDelegate(SessionDelegate sessionDelegate, TreeLocation location) {
assert sessionDelegate != null;
assert location != null;
this.sessionDelegate = sessionDelegate;
this.location = location;
}
/**
* Get the name of this item
* @return oak name of this item
*/
@Nonnull
public String getName() throws InvalidItemStateException {
return PathUtils.getName(getPath());
}
/**
* Get the path of this item
* @return oak path of this item
*/
@Nonnull
public String getPath() throws InvalidItemStateException {
return getLocation().getPath(); // never null
}
/**
* Get the parent of this item or {@code null}.
* @return parent of this item or {@code null} for root or if the parent
* is not accessible.
*/
@CheckForNull
public NodeDelegate getParent() throws InvalidItemStateException {
return NodeDelegate.create(sessionDelegate, getLocation().getParent());
}
/**
* Determine whether this item is stale
* @return {@code true} iff stale
*/
public boolean isStale() {
return getLocationOrNull() == null;
}
/**
* Get the status of this item
* @return {@link Status} of this item
*/
@Nonnull
public Status getStatus() throws InvalidItemStateException {
return getLocation().getStatus(); // never null
}
/**
* Get the session delegate with which this item is associated
* @return {@link SessionDelegate} to which this item belongs
*/
@Nonnull
public final SessionDelegate getSessionDelegate() {
return sessionDelegate;
}
/**
* The underlying {@link org.apache.jackrabbit.oak.api.TreeLocation} of this item.
* @return tree location of the underlying item
* @throws InvalidItemStateException if the location points to a stale item
*/
@Nonnull
public TreeLocation getLocation() throws InvalidItemStateException {
TreeLocation location = getLocationOrNull();
if (location == null) {
throw new InvalidItemStateException("Item is stale");
}
return location;
}
@Override
public String toString() {
// don't disturb the state: avoid resolving location
return getClass().getSimpleName() + '[' + location.getPath() + ']';
}
//------------------------------------------------------------< private >---
/**
* The underlying {@link org.apache.jackrabbit.oak.api.TreeLocation} of this item.
* @return tree location of the underlying item or {@code null} if stale.
*/
@CheckForNull
private synchronized TreeLocation getLocationOrNull() {
if (isStale(location)) {
return null;
}
location = sessionDelegate.getLocation(location.getPath());
return isStale(location) ? null : location;
}
private static boolean isStale(TreeLocation location) {
return location.getStatus() == Status.REMOVED || location.getPath() == null;
}
}