Package org.dspace.rest

Class FiltersResource

java.lang.Object

org.dspace.rest.FiltersResource

@Path("/filters")
public class FiltersResource
extends Object

Class which provides read methods over the metadata registry.

Author:

Terry Brady, Georgetown University

Constructor Summary

Constructors

Constructor	Description
FiltersResource()

Method Summary

Modifier and Type	Method	Description
ItemFilter[]	getFilters(String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request)	Return all Use Case Item Filters in DSpace.

Methods inherited from class java.lang.Object

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

Constructor Detail

FiltersResource

public FiltersResource()

Method Detail

getFilters

@GET
@Produces({"application/json","application/xml"})
public ItemFilter[] getFilters(@QueryParam("userIP")
                               String user_ip,
                               @QueryParam("userAgent")
                               String user_agent,
                               @QueryParam("xforwardedfor")
                               String xforwardedfor,
                               @Context
                               javax.ws.rs.core.HttpHeaders headers,
                               @Context
                               javax.servlet.http.HttpServletRequest request)
                        throws javax.ws.rs.WebApplicationException

Return all Use Case Item Filters in DSpace.

Parameters:

user_ip - User's IP address.

user_agent - User agent string (specifies browser used and its version).

xforwardedfor - When accessed via a reverse proxy, the application sees the proxy's IP as the source of the request. The proxy may be configured to add the "X-Forwarded-For" HTTP header containing the original IP of the client so that the reverse-proxied application can get the client's IP.

headers - If you want to access the collection as the user logged into the context. The value of the "rest-dspace-token" header must be set to the token received from the login method response.

request - Servlet's HTTP request object.

Returns:

Return array of metadata schemas.

Throws:

javax.ws.rs.WebApplicationException - It can be caused by creating context or while was problem with reading community from database(SQLException).