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 and Description
void	add(RDFNode value)
SecuredRDFList	append(Iterator<? extends RDFNode> nodes) Resulting list will contain the readable nodes from this list concatenated with nodes
RDFList	append(RDFList list) Resulting list will contain the readable nodes from this list concatenated with the list argument
void	apply(RDFList.ApplyFn fn) Uses the security settings for the application of the function calls.
void	apply(Set<SecurityEvaluator.Action> perms, RDFList.ApplyFn fn) This method is intended to provide the capabilities to apply functions that need to do more than read the graph.
List<RDFNode>	asJavaList()
void	concatenate(Iterator<? extends RDFNode> nodes)
void	concatenate(RDFList list)
SecuredRDFList	cons(RDFNode value)
boolean	contains(RDFNode value)
SecuredRDFList	copy() Creates a copy of this list comprising the readable elements of this list.
SecuredRDFNode	get(int i) Answer the node that is the i'th element of the list, assuming that the head is item zero.
SecuredRDFNode	getHead() The value that is at the head of the list.
static <T extends RDFList> SecuredRDFList	getInstance(SecuredModel securedModel, T rdfList) Get an instance of SecuredProperty
boolean	getStrict()
SecuredRDFList	getTail() The value that is at the tail of the list.
String	getValidityErrorMessage()
int	indexOf(RDFNode value)
int	indexOf(RDFNode value, int start)
boolean	isEmpty()
boolean	isValid()
ExtendedIterator<RDFNode>	iterator()
ExtendedIterator<RDFNode>	iterator(Set<SecurityEvaluator.Action> constraints)
Class<? extends RDFList>	listAbstractionClass()
Property	listFirst()
Resource	listNil()
Property	listRest()
Resource	listType()
<T> ExtendedIterator<T>	mapWith(Function<RDFNode,T> fn)
Object	reduce(RDFList.ReduceFn fn, Object initial) Only readable triples will be passed to the function.
Object	reduce(Set<SecurityEvaluator.Action> requiredActions, RDFList.ReduceFn fn, Object initial) Only readable triples will be passed to the function.
RDFList	remove(RDFNode val)
void	removeAll() Deprecated.
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() Size may be modified by security constraionts.
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, 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, visitWith

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

as, asNode, canAs, equals, 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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.jena.permissions.model.SecuredResource

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

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

getStmtTerm, inModel, toString

Methods inherited from interface org.apache.jena.permissions.model.SecuredRDFNode

asNode, canAs, getModel, inModel

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

as, asLiteral, isAnon, isLiteral, isResource, isStmtResource, isURIResource, visitWith

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

canCreate, canCreate, canCreate, canDelete, canDelete, canDelete, canRead, canRead, canRead, canUpdate, canUpdate, canUpdate, 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 SecuredRDFList

Specified by:

add in interface RDFList

Throws:

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

UpdateDeniedException

AddDeniedException

append

public SecuredRDFList append(Iterator<? extends RDFNode> nodes)
                      throws ReadDeniedException,
                             AuthenticationRequiredException

Description copied from interface: SecuredRDFList

Resulting list will contain the readable nodes from this list concatenated with nodes

Specified by:

append in interface SecuredRDFList

Specified by:

append in interface RDFList

Throws:

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

ReadDeniedException

append

public RDFList append(RDFList list)
               throws ReadDeniedException,
                      AuthenticationRequiredException

Description copied from interface: SecuredRDFList

Resulting list will contain the readable nodes from this list concatenated with the list argument

Specified by:

append in interface SecuredRDFList

Specified by:

append in interface RDFList

Throws:

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

ReadDeniedException

apply

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

Description copied from interface: SecuredRDFList

Uses the security settings for the application of the function calls. Thus if the function reads data the Read must be allowed, etc.

Specified by:

apply in interface SecuredRDFList

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.

apply

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

Description copied from interface: SecuredRDFList

This method is intended to provide the capabilities to apply functions that need to do more than read the graph. If the user does not have constraints access to the item in the list the item is not included in the function.

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.

asJavaList

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

Specified by:

asJavaList in interface SecuredRDFList

Specified by:

asJavaList in interface RDFList

Returns:

List

Throws:

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

ReadDeniedException

concatenate

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

Specified by:

concatenate in interface SecuredRDFList

Specified by:

concatenate in interface RDFList

Throws:

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

UpdateDeniedException

AddDeniedException

concatenate

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

Specified by:

concatenate in interface SecuredRDFList

Specified by:

concatenate in interface RDFList

Throws:

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

UpdateDeniedException

AddDeniedException

cons

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

Specified by:

cons in interface SecuredRDFList

Specified by:

cons in interface RDFList

Throws:

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

UpdateDeniedException

AddDeniedException

contains

public boolean contains(RDFNode value)
                 throws ReadDeniedException,
                        AuthenticationRequiredException

Specified by:

contains in interface SecuredRDFList

Specified by:

contains in interface RDFList

Throws:

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

ReadDeniedException

copy

public SecuredRDFList copy()
                    throws ReadDeniedException,
                           AuthenticationRequiredException

Description copied from interface: SecuredRDFList

Creates a copy of this list comprising the readable elements of this list.

Specified by:

copy in interface SecuredRDFList

Specified by:

copy in interface RDFList

Throws:

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

ReadDeniedException

get

public SecuredRDFNode get(int i)
                   throws ReadDeniedException,
                          AuthenticationRequiredException

Description copied from interface: SecuredRDFList

Answer the node that is the i'th element of the list, assuming that the head is item zero. If the list is too short to have an i'th element, throws a ListIndexException. List may be shortened by security constraints.

Specified by:

get in interface SecuredRDFList

Specified by:

get in interface RDFList

Throws:

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

ReadDeniedException

getHead

public SecuredRDFNode getHead()
                       throws ReadDeniedException,
                              AuthenticationRequiredException

Description copied from interface: SecuredRDFList

The value that is at the head of the list. head may be shifted by security constraints.

Specified by:

getHead in interface SecuredRDFList

Specified by:

getHead in interface RDFList

Throws:

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

ReadDeniedException

getStrict

public boolean getStrict()

Specified by:

getStrict in interface RDFList

getTail

public SecuredRDFList getTail()
                       throws ReadDeniedException,
                              AuthenticationRequiredException

Description copied from interface: SecuredRDFList

The value that is at the tail of the list. tail may be shifted by security constraints.

Specified by:

getTail in interface SecuredRDFList

Specified by:

getTail in interface RDFList

Throws:

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

ReadDeniedException

getValidityErrorMessage

public String getValidityErrorMessage()
                               throws ReadDeniedException,
                                      AuthenticationRequiredException

Specified by:

getValidityErrorMessage in interface SecuredRDFList

Specified by:

getValidityErrorMessage in interface RDFList

Throws:

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

ReadDeniedException

indexOf

public int indexOf(RDFNode value)
            throws ReadDeniedException,
                   AuthenticationRequiredException

Specified by:

indexOf in interface SecuredRDFList

Specified by:

indexOf in interface RDFList

Throws:

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

ReadDeniedException

indexOf

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

Specified by:

indexOf in interface SecuredRDFList

Specified by:

indexOf in interface RDFList

Throws:

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

ReadDeniedException

isEmpty

public boolean isEmpty()
                throws ReadDeniedException,
                       AuthenticationRequiredException

Specified by:

isEmpty in interface SecuredRDFList

Specified by:

isEmpty in interface RDFList

Throws:

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

ReadDeniedException

isValid

public boolean isValid()
                throws ReadDeniedException,
                       AuthenticationRequiredException

Specified by:

isValid in interface SecuredRDFList

Specified by:

isValid in interface RDFList

Throws:

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

ReadDeniedException

iterator

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

Specified by:

iterator in interface SecuredRDFList

Specified by:

iterator in interface RDFList

Throws:

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

ReadDeniedException

iterator

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

Specified by:

iterator in interface SecuredRDFList

Throws:

ReadDeniedException

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

listAbstractionClass

public Class<? extends RDFList> listAbstractionClass()

listFirst

public Property listFirst()

listNil

public Resource listNil()

listRest

public Property listRest()

listType

public Resource listType()

mapWith

public <T> ExtendedIterator<T> mapWith(Function<RDFNode,T> fn)
                                throws ReadDeniedException,
                                       AuthenticationRequiredException

Specified by:

mapWith in interface RDFList

Throws:

ReadDeniedException

AuthenticationRequiredException

reduce

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

Description copied from interface: SecuredRDFList

Only readable triples will be passed to the function. If the function does any action other than read those permissions must also be granted.

Specified by:

reduce in interface SecuredRDFList

Specified by:

reduce in interface RDFList

Throws:

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

ReadDeniedException

reduce

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

Description copied from interface: SecuredRDFList

Only readable triples will be passed to the function. In addition, only triples that pass the requiredActions tests will be passed to the function.

Specified by:

reduce in interface SecuredRDFList

Parameters:

requiredActions - The set of permission (in addition to Read) that the user must have

fn - The reduction function

initial - The initial state for the ruduce value.

Throws:

EmptyListException

ListIndexException

InvalidListException

ReadDeniedException

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

remove

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

Specified by:

remove in interface SecuredRDFList

Specified by:

remove in interface RDFList

Throws:

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

UpdateDeniedException

DeleteDeniedException

removeAll

@Deprecated
public void removeAll()
                           throws UpdateDeniedException,
                                  AuthenticationRequiredException

Deprecated.

Specified by:

removeAll in interface SecuredRDFList

Specified by:

removeAll in interface RDFList

Throws:

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

UpdateDeniedException

removeHead

public SecuredRDFList removeHead()
                          throws UpdateDeniedException,
                                 DeleteDeniedException,
                                 AuthenticationRequiredException

Specified by:

removeHead in interface SecuredRDFList

Specified by:

removeHead in interface RDFList

Throws:

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

UpdateDeniedException

DeleteDeniedException

removeList

public void removeList()
                throws UpdateDeniedException,
                       AuthenticationRequiredException

Specified by:

removeList in interface SecuredRDFList

Specified by:

removeList in interface RDFList

Throws:

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

UpdateDeniedException

replace

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

Specified by:

replace in interface SecuredRDFList

Specified by:

replace in interface RDFList

Throws:

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

UpdateDeniedException

ListIndexException

sameListAs

public boolean sameListAs(RDFList list)
                   throws ReadDeniedException,
                          AuthenticationRequiredException

Specified by:

sameListAs in interface SecuredRDFList

Specified by:

sameListAs in interface RDFList

Throws:

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

ReadDeniedException

setHead

public SecuredRDFNode setHead(RDFNode value)
                       throws EmptyListException,
                              AuthenticationRequiredException

Specified by:

setHead in interface SecuredRDFList

Specified by:

setHead in interface RDFList

Throws:

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

EmptyListException

setStrict

public void setStrict(boolean strict)
               throws UpdateDeniedException,
                      AuthenticationRequiredException

Specified by:

setStrict in interface SecuredRDFList

Specified by:

setStrict in interface RDFList

Throws:

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

UpdateDeniedException

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

Description copied from interface: SecuredRDFList

Size may be modified by security constraionts.

Specified by:

size in interface SecuredRDFList

Specified by:

size in interface RDFList

Throws:

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

ReadDeniedException

with

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

Specified by:

with in interface SecuredRDFList

Specified by:

with in interface RDFList

Throws:

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

UpdateDeniedException

AddDeniedException