org.apache.jackrabbit.api.security.principal.ItemBasedPrincipal Maven / Gradle / Ivy
/*
* 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.api.security.principal;
import javax.jcr.RepositoryException;
/**
* ItemBasedPrincipal
is a Principal
having a
* corresponding item within the JCR repository. In addition to the methods
* inherited from the {@link java.security.Principal} interface it therefore
* provides a {@link #getPath()} method.
*/
public interface ItemBasedPrincipal extends JackrabbitPrincipal {
/**
* Returns the JCR path of the item that corresponds to this
* Principal
.
*
* @return the path of the {@link javax.jcr.Item} that corresponds to this
* Principal
.
* @throws RepositoryException If an error occurs while retrieving the
* Item
path.
*/
String getPath() throws RepositoryException;
}