Package org.apache.jena.permissions.model.impl

Class SecuredRDFListImpl

java.lang.Object

org.apache.jena.permissions.impl.SecuredItemImpl

org.apache.jena.permissions.model.impl.SecuredRDFNodeImpl

org.apache.jena.permissions.model.impl.SecuredResourceImpl

org.apache.jena.permissions.model.impl.SecuredRDFListImpl

All Implemented Interfaces:

FrontsNode, SecuredRDFList, SecuredRDFNode, SecuredResource, SecuredItem, RDFList, RDFNode, Resource

public class SecuredRDFListImpl
extends SecuredResourceImpl
implements SecuredRDFList

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jena.rdf.model.RDFList

RDFList.ApplyFn, RDFList.ReduceFn

Nested classes/interfaces inherited from interface org.apache.jena.permissions.SecuredItem

SecuredItem.Util

Field Summary

Fields inherited from class org.apache.jena.permissions.impl.SecuredItemImpl

CACHE, COUNT, MAX_CACHE

Method Summary

Modifier and Type	Method	Description
void	add(RDFNode value)
RDFList	append(java.util.Iterator<? extends RDFNode> nodes)
RDFList	append(RDFList list)
void	apply(java.util.Set<SecurityEvaluator.Action> perms, RDFList.ApplyFn fn)	Apply fn to all elements of the graph for which the user has the permissions.
void	apply(RDFList.ApplyFn fn)
java.util.List<RDFNode>	asJavaList()
void	concatenate(java.util.Iterator<? extends RDFNode> nodes)
void	concatenate(RDFList list)
SecuredRDFList	cons(RDFNode value)
boolean	contains(RDFNode value)
SecuredRDFList	copy()
RDFNode	get(int i)
RDFNode	getHead()
static <T extends RDFList> SecuredRDFList	getInstance(SecuredModel securedModel, T rdfList)	Get an instance of SecuredProperty
boolean	getStrict()
SecuredRDFList	getTail()
java.lang.String	getValidityErrorMessage()
int	indexOf(RDFNode value)
int	indexOf(RDFNode value, int start)
boolean	isEmpty()
boolean	isValid()
ExtendedIterator<RDFNode>	iterator()
ExtendedIterator<RDFNode>	iterator(java.util.Set<SecurityEvaluator.Action> constraints)	Retrieve an iterator on the list for which the user has the specified permissions.
<T> ExtendedIterator<T>	mapWith(java.util.function.Function<RDFNode,T> fn)
java.lang.Object	reduce(java.util.Set<SecurityEvaluator.Action> requiredActions, RDFList.ReduceFn fn, java.lang.Object initial)	Execute a reduct function across the list.
java.lang.Object	reduce(RDFList.ReduceFn fn, java.lang.Object initial)
RDFList	remove(RDFNode val)
SecuredRDFList	removeHead()
void	removeList()
SecuredRDFNode	replace(int i, RDFNode value)
boolean	sameListAs(RDFList list)
SecuredRDFNode	setHead(RDFNode value)
void	setStrict(boolean strict)
SecuredRDFList	setTail(RDFList tail)
int	size()
SecuredRDFList	with(RDFNode value)

Methods inherited from class org.apache.jena.permissions.model.impl.SecuredResourceImpl

abort, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addProperty, addProperty, addProperty, addProperty, asLiteral, asResource, begin, canReadProperty, commit, getId, getInstance, getLocalName, getNameSpace, getProperty, getProperty, getPropertyResourceValue, getRequiredProperty, getRequiredProperty, getStmtTerm, getURI, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasProperty, hasProperty, hasProperty, hasProperty, hasURI, inModel, listProperties, listProperties, listProperties, removeAll, removeProperties, visitWith

Methods inherited from class org.apache.jena.permissions.model.impl.SecuredRDFNodeImpl

as, asNode, canAs, equals, getInstance, getModel, hashCode, isAnon, isLiteral, isResource, isStmtResource, isURIResource

Methods inherited from class org.apache.jena.permissions.impl.SecuredItemImpl

canCreate, canCreate, canCreate, canDelete, canDelete, canDelete, canRead, canRead, canRead, canUpdate, canUpdate, canUpdate, decrementUse, getBaseItem, getModelIRI, getModelNode, getSecurityEvaluator, incrementUse, isEquivalent, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.jena.graph.FrontsNode

asNode

Methods inherited from interface org.apache.jena.rdf.model.RDFNode

as, asLiteral, asResource, canAs, getModel, isAnon, isLiteral, isResource, isStmtResource, isURIResource, visitWith

Methods inherited from interface org.apache.jena.rdf.model.Resource

abort, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addProperty, addProperty, addProperty, addProperty, begin, commit, equals, getId, getLocalName, getNameSpace, getProperty, getProperty, getPropertyResourceValue, getRequiredProperty, getRequiredProperty, getStmtTerm, getURI, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasProperty, hasProperty, hasProperty, hasProperty, hasURI, inModel, listProperties, listProperties, listProperties, removeAll, removeProperties, toString

Methods inherited from interface org.apache.jena.permissions.SecuredItem

canCreate, canCreate, canCreate, canDelete, canDelete, canDelete, canRead, canRead, canRead, canUpdate, canUpdate, canUpdate, equals, getBaseItem, getModelIRI, getModelNode, getSecurityEvaluator, isEquivalent

Method Detail

getInstance

public static <T extends RDFList> SecuredRDFList getInstance(SecuredModel securedModel,
                                                             T rdfList)

Get an instance of SecuredProperty

Parameters:

securedModel - the Secured Model to use.

rdfList - The rdfList to secure

Returns:

The SecuredProperty

add

public void add(RDFNode value)
         throws UpdateDeniedException,
                AddDeniedException,
                AuthenticationRequiredException

Specified by:

add in interface RDFList

Throws:

UpdateDeniedException

AddDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Update

Required triple permissions:

Create SecTriple(SecNode.FUTURE, RDF.first, value), Create SecTriple(SecNode.FUTURE, RDF.first, RDF.nil)

append

public RDFList append(java.util.Iterator<? extends RDFNode> nodes)
               throws ReadDeniedException,
                      AuthenticationRequiredException

Specified by:

append in interface RDFList

Throws:

UpdateDeniedException

AddDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

ReadDeniedException

Required graph permissions:

Update

Required triple permissions:

Create SecTriple( SecNode.FUTURE, RDF.first, value ), Create SecTriple( SecNode.FUTURE, RDF.rest, this )

append

public RDFList append(RDFList list)
               throws ReadDeniedException,
                      AuthenticationRequiredException

Specified by:

append in interface RDFList

Throws:

UpdateDeniedException

AddDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

ReadDeniedException

Required graph permissions:

Update

Required triple permissions:

Create SecTriple( SecNode.FUTURE, RDF.first, value ), Create SecTriple( SecNode.FUTURE, RDF.rest, this )

apply

public void apply(RDFList.ApplyFn fn)
           throws ReadDeniedException,
                  AuthenticationRequiredException

Specified by:

apply in interface RDFList

Throws:

ReadDeniedException - graph Read or other permissions are not met

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then the function is not applied to any list items., Read

Required triple permissions:

Read (to be included in the calculation), other permissions required by the function.

apply

public void apply(java.util.Set<SecurityEvaluator.Action> perms,
                  RDFList.ApplyFn fn)
           throws ReadDeniedException,
                  AuthenticationRequiredException

Description copied from interface: SecuredRDFList

Apply fn to all elements of the graph for which the user has the permissions.

Specified by:

apply in interface SecuredRDFList

Parameters:

perms - The permissions the user must have on the items in the list.

fn - The function to apply.

Throws:

ReadDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then the function will not be applied to any of the elements.

Required triple permissions:

Read and constraints

asJavaList

public java.util.List<RDFNode> asJavaList()
                                   throws ReadDeniedException,
                                          AuthenticationRequiredException

Specified by:

asJavaList in interface RDFList

Returns:

List

Throws:

AuthenticationRequiredException - if user is not authenticated and is required to be.

ReadDeniedException

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then an empty list is returned.

Required triple permissions:

Read for triples containing the returned RDFNodes.

concatenate

public void concatenate(java.util.Iterator<? extends RDFNode> nodes)
                 throws UpdateDeniedException,
                        AddDeniedException,
                        AuthenticationRequiredException

Specified by:

concatenate in interface RDFList

Throws:

UpdateDeniedException

AddDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Update

Required triple permissions:

Create SecTriple( SecNode.FUTURE, RDF.first, node ) for each node in nodes.

concatenate

public void concatenate(RDFList list)
                 throws UpdateDeniedException,
                        AddDeniedException,
                        AuthenticationRequiredException

Specified by:

concatenate in interface RDFList

Throws:

UpdateDeniedException

AddDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Update

Required triple permissions:

Create SecTriple( SecNode.FUTURE, RDF.first, node ) for each node in nodes.

cons

public SecuredRDFList cons(RDFNode value)
                    throws UpdateDeniedException,
                           AddDeniedException,
                           AuthenticationRequiredException

Specified by:

cons in interface RDFList

Throws:

UpdateDeniedException

AddDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Update

Required triple permissions:

Create SecTriple( SecNode.FUTURE, RDF.first, value ), Create SecTriple( SecNode.FUTURE, RDF.rest, this )

contains

public boolean contains(RDFNode value)
                 throws ReadDeniedException,
                        AuthenticationRequiredException

Specified by:

contains in interface RDFList

Throws:

ReadDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then false is returned.

Required triple permissions:

Read for triple containing value.

copy

public SecuredRDFList copy()
                    throws ReadDeniedException,
                           AuthenticationRequiredException

Specified by:

copy in interface RDFList

Throws:

ReadDeniedException

AddDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then an empty list is returned., Update

Required triple permissions:

Read on each triple to be read., Create SecTriple( SecNode.FUTURE, RDF.first, value ), Create SecTriple( SecNode.FUTURE, RDF.rest, this )

get

public RDFNode get(int i)
            throws ReadDeniedException,
                   AuthenticationRequiredException

Specified by:

get in interface RDFList

Throws:

ReadDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then a ListIndexException is thrown. The indexing of the underlying list may be shifted by permission constraints.

getHead

public RDFNode getHead()
                throws ReadDeniedException,
                       AuthenticationRequiredException

Specified by:

getHead in interface RDFList

Throws:

ReadDeniedException

EmptyListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then a ListIndexException is thrown. The head may be shifted from the underlying list by permission constraints.

Required triple permissions:

Read for triple containing value.

getStrict

public boolean getStrict()

Specified by:

getStrict in interface RDFList

getTail

public SecuredRDFList getTail()
                       throws ReadDeniedException,
                              AuthenticationRequiredException

Specified by:

getTail in interface RDFList

Throws:

ReadDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then a ListIndexException is thrown. The tail may be shifted from the underlying list by permission constraints.

Required triple permissions:

Read for triple containing value.

getValidityErrorMessage

public java.lang.String getValidityErrorMessage()
                                         throws ReadDeniedException,
                                                AuthenticationRequiredException

Specified by:

getValidityErrorMessage in interface RDFList

Throws:

ReadDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read- if SecurityEvaluator.isHardReadError() is true and the user does not have read access then null is returned.

indexOf

public int indexOf(RDFNode value)
            throws ReadDeniedException,
                   AuthenticationRequiredException

Specified by:

indexOf in interface RDFList

Throws:

ReadDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then -1 is returned.

Required triple permissions:

Read for triple containing value.

indexOf

public int indexOf(RDFNode value,
                   int start)
            throws ReadDeniedException,
                   AuthenticationRequiredException

Specified by:

indexOf in interface RDFList

Throws:

ReadDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then -1 is returned

Required triple permissions:

Read for triple containing value.

isEmpty

public boolean isEmpty()
                throws ReadDeniedException,
                       AuthenticationRequiredException

Specified by:

isEmpty in interface RDFList

Throws:

ReadDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then true is returned.

isValid

public boolean isValid()
                throws ReadDeniedException,
                       AuthenticationRequiredException

Specified by:

isValid in interface RDFList

Throws:

ReadDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read

iterator

public ExtendedIterator<RDFNode> iterator()
                                   throws ReadDeniedException,
                                          AuthenticationRequiredException

Specified by:

iterator in interface RDFList

Throws:

ReadDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then an empty iterator is returned.

Required triple permissions:

Read for triple containing value to be included in the result.

iterator

public ExtendedIterator<RDFNode> iterator(java.util.Set<SecurityEvaluator.Action> constraints)
                                   throws ReadDeniedException,
                                          AuthenticationRequiredException

Description copied from interface: SecuredRDFList

Retrieve an iterator on the list for which the user has the specified permissions.

Specified by:

iterator in interface SecuredRDFList

Parameters:

constraints - the permissions required for the user to access the node.

Returns:

an iterator on the items.

Throws:

ReadDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then an empty iterator is returned.

Required triple permissions:

Read for triple containing value to be included in the result.

mapWith

public <T> ExtendedIterator<T> mapWith(java.util.function.Function<RDFNode,T> fn)
                                throws ReadDeniedException,
                                       AuthenticationRequiredException

Specified by:

mapWith in interface RDFList

Throws:

ReadDeniedException

AuthenticationRequiredException

reduce

public java.lang.Object reduce(RDFList.ReduceFn fn,
                               java.lang.Object initial)
                        throws ReadDeniedException,
                               AuthenticationRequiredException

Specified by:

reduce in interface RDFList

Throws:

ReadDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - Only readable triples will be passed to the function. if SecurityEvaluator.isHardReadError() is true and the user does not have read access then no items will be passed to the function..

Required triple permissions:

Read for triple containing value to be included in the result., Read for triple containing value.

reduce

public java.lang.Object reduce(java.util.Set<SecurityEvaluator.Action> requiredActions,
                               RDFList.ReduceFn fn,
                               java.lang.Object initial)
                        throws EmptyListException,
                               ListIndexException,
                               InvalidListException,
                               ReadDeniedException,
                               AuthenticationRequiredException

Description copied from interface: SecuredRDFList

Execute a reduct function across the list.

Specified by:

reduce in interface SecuredRDFList

Parameters:

requiredActions - the permission set required to execute the reduce.

fn - the reduction function.

initial - the initial accumulation value.

Returns:

the accumulator after execution.

Throws:

ReadDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - Only readable triples will be passed to the function. if SecurityEvaluator.isHardReadError() is true and the user does not have read access then no items will be passed to the function.

Required triple permissions:

Read for triple containing value to be included in the result., Read for triple containing value.

remove

public RDFList remove(RDFNode val)
               throws UpdateDeniedException,
                      DeleteDeniedException,
                      AuthenticationRequiredException

Specified by:

remove in interface RDFList

Throws:

UpdateDeniedException

DeleteDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Update

Required triple permissions:

Delete for triple containing value.

removeHead

public SecuredRDFList removeHead()
                          throws UpdateDeniedException,
                                 DeleteDeniedException,
                                 AuthenticationRequiredException

Specified by:

removeHead in interface RDFList

Throws:

UpdateDeniedException

DeleteDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Update

Required triple permissions:

Delete for the head triple.

removeList

public void removeList()
                throws UpdateDeniedException,
                       AuthenticationRequiredException

Specified by:

removeList in interface RDFList

Throws:

UpdateDeniedException

DeleteDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Update

Required triple permissions:

Delete for triple containing value.

replace

public SecuredRDFNode replace(int i,
                              RDFNode value)
                       throws UpdateDeniedException,
                              AuthenticationRequiredException,
                              ListIndexException

Specified by:

replace in interface RDFList

Throws:

UpdateDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Update

Required triple permissions:

Update for triple i, and value.

sameListAs

public boolean sameListAs(RDFList list)
                   throws ReadDeniedException,
                          AuthenticationRequiredException

Specified by:

sameListAs in interface RDFList

Throws:

ReadDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then the the lists will be the same if the list parameter is an empty list.

Required triple permissions:

Read for triples included in the comparison.

setHead

public SecuredRDFNode setHead(RDFNode value)
                       throws EmptyListException,
                              AuthenticationRequiredException

Specified by:

setHead in interface RDFList

Throws:

UpdateDeniedException

DeleteDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Update

Required triple permissions:

Create for triple containing value.

setStrict

public void setStrict(boolean strict)
               throws UpdateDeniedException,
                      AuthenticationRequiredException

Specified by:

setStrict in interface RDFList

Throws:

UpdateDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Update

setTail

public SecuredRDFList setTail(RDFList tail)
                       throws UpdateDeniedException,
                              AuthenticationRequiredException

Specified by:

setTail in interface RDFList

Throws:

UpdateDeniedException

AuthenticationRequiredException

size

public int size()
         throws ReadDeniedException,
                AuthenticationRequiredException

Specified by:

size in interface RDFList

Throws:

ReadDeniedException

EmptyListException

ListIndexException

InvalidListException

AuthenticationRequiredException - if user is not authenticated and is required to be.

Required graph permissions:

Read - if SecurityEvaluator.isHardReadError() is true and the user does not have read access then zero (0) will be returned.

Required triple permissions:

Read for triples counted in the result.

with

public SecuredRDFList with(RDFNode value)
                    throws UpdateDeniedException,
                           AddDeniedException,
                           AuthenticationRequiredException

Specified by:

with in interface RDFList

Throws:

UpdateDeniedException

DeleteDeniedException

AuthenticationRequiredException - if user is not authenticated and is required to be.

AddDeniedException

Required graph permissions:

Update

Required triple permissions:

Create for triple containing value.