org.apache.jackrabbit.api.security.JackrabbitAccessControlEntry 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;
import javax.jcr.RepositoryException;
import javax.jcr.Value;
import javax.jcr.ValueFormatException;
import javax.jcr.security.AccessControlEntry;
import org.osgi.annotation.versioning.ProviderType;
/**
* JackrabbitAccessControlEntry
is a Jackrabbit specific extension
* of the AccessControlEntry
interface. It represents an single
* entry of a {@link JackrabbitAccessControlList}.
*/
@ProviderType
public interface JackrabbitAccessControlEntry extends AccessControlEntry {
/**
* @return true if this entry adds Privilege
s for the principal;
* false otherwise.
*/
boolean isAllow();
/**
* Return the names of the restrictions present with this access control entry.
*
* @return the names of the restrictions
* @throws RepositoryException if an error occurs.
*/
String[] getRestrictionNames() throws RepositoryException;
/**
* Return the value of the restriction with the specified name or
* null
if no such restriction exists. In case the restriction
* with the specified name contains multiple value this method will call
* {@code ValueFormatException}.
*
* @param restrictionName The of the restriction as obtained through
* {@link #getRestrictionNames()}.
* @return value of the restriction with the specified name or
* null
if no such restriction exists.
* @throws ValueFormatException If the restriction with the specified name
* contains multiple values.
* @throws RepositoryException if an error occurs.
* @see #getRestrictions(String)
*/
Value getRestriction(String restrictionName) throws ValueFormatException, RepositoryException;
/**
* Return the values of the restriction with the specified name or
* null
if no such restriction exists. For restrictions that
* contain just a single value this method is expected to return an array
* with a single element even if the underlying implementation stored the
* restriction in single-value JCR property.
*
* @param restrictionName The of the restriction as obtained through
* {@link #getRestrictionNames()}.
* @return the values of the restriction with the specified name as an array
* or null
if no such restriction exists. The array may contain
* zero, one or multiple values.
* @throws RepositoryException if an error occurs.
* @see #getRestriction(String)
*/
Value[] getRestrictions(String restrictionName) throws RepositoryException;
}