Package org.opencastproject.userdirectory

Class UserEndpoint

java.lang.Object

org.opencastproject.userdirectory.UserEndpoint

@Path("/users")
public class UserEndpoint
extends Object

Provides a sorted set of known users

Field Summary

Fields

Modifier and Type	Field	Description
protected org.opencastproject.security.api.UserDirectoryService	userDirectoryService	The role directory service

Constructor Summary

Constructors

Constructor	Description
UserEndpoint()

Method Summary

Modifier and Type	Method	Description
org.opencastproject.security.api.JaxbUser	getUserAsJson(String username)
org.opencastproject.security.api.JaxbUser	getUserAsXml(String username)
javax.ws.rs.core.Response	getUsersAsJson(String queryString, int limit, int offset)
javax.ws.rs.core.Response	getUsersAsXml(String queryString, int limit, int offset)
void	setUserDirectoryService(org.opencastproject.security.api.UserDirectoryService userDirectoryService)	Sets the user directory service

Methods inherited from class java.lang.Object

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

Field Details

userDirectoryService

protected org.opencastproject.security.api.UserDirectoryService userDirectoryService

The role directory service

Constructor Details

UserEndpoint

public UserEndpoint()

Method Details

setUserDirectoryService

public void setUserDirectoryService(org.opencastproject.security.api.UserDirectoryService userDirectoryService)

Sets the user directory service

Parameters:

userDirectoryService - the userDirectoryService to set

getUsersAsXml

@GET
@Path("users.xml")
@Produces("application/xml")
public javax.ws.rs.core.Response getUsersAsXml(@QueryParam("query")
 String queryString,
 @QueryParam("limit")
 int limit,
 @QueryParam("offset")
 int offset)
                                        throws IOException

Throws:

IOException

getUsersAsJson

@GET
@Path("users.json")
@Produces("application/json")
public javax.ws.rs.core.Response getUsersAsJson(@QueryParam("query")
 String queryString,
 @QueryParam("limit")
 int limit,
 @QueryParam("offset")
 int offset)
                                         throws IOException

Throws:

IOException

getUserAsXml

@GET
@Path("{username}.xml")
@Produces("application/xml")
public org.opencastproject.security.api.JaxbUser getUserAsXml(@PathParam("username")
 String username)
                                                       throws org.opencastproject.util.NotFoundException

Throws:

org.opencastproject.util.NotFoundException

getUserAsJson

@GET
@Path("{username}.json")
@Produces("application/json")
public org.opencastproject.security.api.JaxbUser getUserAsJson(@PathParam("username")
 String username)
                                                        throws org.opencastproject.util.NotFoundException

Throws:

org.opencastproject.util.NotFoundException