org.dspace.rest

Class HierarchyResource

java.lang.Object

org.dspace.rest.Resource

org.dspace.rest.HierarchyResource

@Path(value="/hierarchy")
 @Produces(value={"application/json","application/xml"})
public class HierarchyResource
extends Resource

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorizeService	authorizeService
protected CommunityService	communityService
protected ConfigurationService	configurationService
protected SiteService	siteService

Fields inherited from class org.dspace.rest.Resource

servletContext

Constructor Summary

Constructors

Constructor and Description
HierarchyResource()

Method Summary

Modifier and Type	Method and Description
HierarchySite	getHierarchy(String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request)

Methods inherited from class org.dspace.rest.Resource

createContext, getActionString, mySplit, processException, processFinally, writeStats

Methods inherited from class java.lang.Object

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

Field Detail

siteService

protected SiteService siteService

communityService

protected CommunityService communityService

authorizeService

protected AuthorizeService authorizeService

configurationService

protected ConfigurationService configurationService

Constructor Detail

HierarchyResource

public HierarchyResource()

Method Detail

getHierarchy

@GET
 @Produces(value={"application/json","application/xml"})
public HierarchySite getHierarchy(@QueryParam(value="userAgent")
                                                                                                  String user_agent,
                                                                                                  @QueryParam(value="xforwardedfor")
                                                                                                  String xforwardedfor,
                                                                                                  @Context
                                                                                                  javax.ws.rs.core.HttpHeaders headers,
                                                                                                  @Context
                                                                                                  javax.servlet.http.HttpServletRequest request)
                                                                                           throws UnsupportedEncodingException,
                                                                                                  javax.ws.rs.WebApplicationException

Parameters:

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 instance of collection. It can also return status code NOT_FOUND(404) if id of collection is incorrect or status code

Throws:

UnsupportedEncodingException - The Character Encoding is not supported.

javax.ws.rs.WebApplicationException - It is thrown when was problem with database reading (SQLException) or problem with creating context(ContextException). It is thrown by NOT_FOUND and UNATHORIZED status codes, too.