org.fcrepo.server.security.xacml.pep.rest.filters

Class AbstractFilter

java.lang.Object

org.fcrepo.server.security.xacml.pep.rest.filters.AbstractFilter

All Implemented Interfaces:

RESTFilter

Direct Known Subclasses:

AddDatastream, AddRelationship, BasicRISearchFilter, ControlFilter, DescribeFilter, Export, FindObjects, GetAccessParmResolverFilter, GetDatastream, GetDatastreamDissemination, GetDatastreamHistory, GetDissemination, GetFilter, GetNextPID, GetNextPIDFilter, GetObjectHistory, GetObjectHistoryFilter, GetObjectProfile, GetObjectXML, GetRelationships, Ingest, ListDatastreams, ListDatastreamsFilter, ListMethods, ListMethodsFilter, ModifyDatastream, ModifyObject, NoopFilter, PurgeDatastream, PurgeObject, PurgeRelationship, RISearchFilter, SetDatastreamState, SetDatastreamVersionable, UploadFilter, Validate

public abstract class AbstractFilter
extends java.lang.Object
implements RESTFilter

This is the AbstractFilter class which provides generic functionality for all REST filters. All REST filters should extend this class.

Author:

nishen@melcoe.mq.edu.au

Constructor Summary

Constructors

Constructor and Description
AbstractFilter() Default constructor obtains an instance of the Context Handler.

Method Summary

Methods

Modifier and Type	Method and Description
ContextHandler	getContextHandler()
protected java.util.Map<java.net.URI,org.jboss.security.xacml.sunxacml.attr.AttributeValue>	getEnvironment(javax.servlet.http.HttpServletRequest request) Returns a map of environment attributes.
protected static java.lang.String[]	getPathParts(javax.servlet.http.HttpServletRequest request)
protected java.util.List<java.util.Map<java.net.URI,java.util.List<org.jboss.security.xacml.sunxacml.attr.AttributeValue>>>	getSubjects(javax.servlet.http.HttpServletRequest request) Creates a list of Subjects from a servlet request.
protected boolean	isDatastream(java.lang.String item) Function to determine whether a parameter is a datastream or a dissemination.
protected boolean	isDate(java.lang.String item) Checks whether a parameter fits the date pattern.
protected boolean	isPID(java.lang.String item) Function to determine whether a parameter is a PID.
void	setContextHandler(ContextHandler contextHandler)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fcrepo.server.security.xacml.pep.rest.filters.RESTFilter

handleRequest

Constructor Detail

AbstractFilter

public AbstractFilter()
               throws PEPException

Default constructor obtains an instance of the Context Handler.

Throws:

PEPException

Method Detail

setContextHandler

public void setContextHandler(ContextHandler contextHandler)

getContextHandler

public ContextHandler getContextHandler()

Returns:

the ContextHandler instance

getSubjects

protected java.util.List<java.util.Map<java.net.URI,java.util.List<org.jboss.security.xacml.sunxacml.attr.AttributeValue>>> getSubjects(javax.servlet.http.HttpServletRequest request)
                                                                                                                                 throws javax.servlet.ServletException

Creates a list of Subjects from a servlet request. If no subject is found a subject called 'anonymous' is created.

Parameters:

request - the servlet request

Returns:

a list of Subjects

Throws:

javax.servlet.ServletException

getEnvironment

protected java.util.Map<java.net.URI,org.jboss.security.xacml.sunxacml.attr.AttributeValue> getEnvironment(javax.servlet.http.HttpServletRequest request)

Returns a map of environment attributes.

Parameters:

request - the servlet request from which to obtain the attributes

Returns:

a list of environment attributes

isPID

protected boolean isPID(java.lang.String item)

Function to determine whether a parameter is a PID.

Parameters:

item - the uri parameter

isDatastream

protected boolean isDatastream(java.lang.String item)

Function to determine whether a parameter is a datastream or a dissemination.

Parameters:

item - the uri parameter

isDate

protected boolean isDate(java.lang.String item)

Checks whether a parameter fits the date pattern.

Parameters:

item - the date

Returns:

returns true if the string is a date or else false

getPathParts

protected static java.lang.String[] getPathParts(javax.servlet.http.HttpServletRequest request)