org.cloudfoundry.identity.uaa.scim.endpoints

Class ScimUserEndpoints

java.lang.Object

org.cloudfoundry.identity.uaa.scim.endpoints.ScimUserEndpoints

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@Controller
@ManagedResource
public class ScimUserEndpoints
extends java.lang.Object
implements org.springframework.beans.factory.InitializingBean

User provisioning and query endpoints. Implements the core API from the Simple Cloud Identity Management (SCIM) group. Exposes basic CRUD and query features for user accounts in a backend database.

See Also:

SCIM specs

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	E_TAG

Constructor Summary

Constructors

Constructor and Description
ScimUserEndpoints()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
ScimUser	createUser(ScimUser user, javax.servlet.http.HttpServletResponse httpServletResponse)
ScimUser	deleteUser(java.lang.String userId, java.lang.String etag, javax.servlet.http.HttpServletResponse httpServletResponse)
org.cloudfoundry.identity.uaa.rest.SearchResults<?>	findUsers(java.lang.String attributesCommaSeparated, java.lang.String filter, java.lang.String sortBy, java.lang.String sortOrder, int startIndex, int count)
java.util.Map<java.lang.String,java.util.concurrent.atomic.AtomicInteger>	getErrorCounts()
int	getTotalUsers()
ScimUser	getUser(java.lang.String userId, javax.servlet.http.HttpServletResponse httpServletResponse)
int	getUserDeletes()
int	getUserUpdates()
org.springframework.web.servlet.View	handleException(java.lang.Exception t, javax.servlet.http.HttpServletRequest request)
void	setApprovalStore(org.cloudfoundry.identity.uaa.oauth.approval.ApprovalStore approvalStore)
void	setMessageConverters(org.springframework.http.converter.HttpMessageConverter<?>[] messageConverters) Set the message body converters to use.
void	setPasswordValidator(PasswordValidator passwordValidator)
void	setScimGroupMembershipManager(ScimGroupMembershipManager membershipManager)
void	setScimUserProvisioning(ScimUserProvisioning dao)
void	setScimUserResourceMonitor(org.cloudfoundry.identity.uaa.rest.ResourceMonitor<ScimUser> scimUserResourceMonitor)
void	setStatuses(java.util.Map<java.lang.Class<? extends java.lang.Exception>,org.springframework.http.HttpStatus> statuses) Map from exception type to Http status.
ScimUser	updateUser(ScimUser user, java.lang.String userId, java.lang.String etag, javax.servlet.http.HttpServletResponse httpServletResponse)
ScimUser	verifyUser(java.lang.String userId, java.lang.String etag, javax.servlet.http.HttpServletResponse httpServletResponse)

Methods inherited from class java.lang.Object

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

Field Detail

E_TAG

public static final java.lang.String E_TAG

See Also:

Constant Field Values

Constructor Detail

ScimUserEndpoints

public ScimUserEndpoints()

Method Detail

setMessageConverters

public void setMessageConverters(org.springframework.http.converter.HttpMessageConverter<?>[] messageConverters)

Set the message body converters to use.

These converters are used to convert from and to HTTP requests and responses.

setStatuses

public void setStatuses(java.util.Map<java.lang.Class<? extends java.lang.Exception>,org.springframework.http.HttpStatus> statuses)

Map from exception type to Http status.

Parameters:

statuses - the statuses to set

getTotalUsers

@ManagedMetric(metricType=COUNTER,
               displayName="Total Users")
public int getTotalUsers()

getUserUpdates

@ManagedMetric(metricType=COUNTER,
               displayName="User Account Update Count (Since Startup)")
public int getUserUpdates()

getUserDeletes

@ManagedMetric(metricType=COUNTER,
               displayName="User Account Delete Count (Since Startup)")
public int getUserDeletes()

getErrorCounts

@ManagedMetric(displayName="Error Counts")
public java.util.Map<java.lang.String,java.util.concurrent.atomic.AtomicInteger> getErrorCounts()

getUser

@RequestMapping(value="/Users/{userId}",
                method=GET)
@ResponseBody
public ScimUser getUser(@PathVariable
                                           java.lang.String userId,
                                           javax.servlet.http.HttpServletResponse httpServletResponse)

createUser

@RequestMapping(value="/Users",
                method=POST)
@ResponseStatus(value=CREATED)
@ResponseBody
public ScimUser createUser(@RequestBody
                                                             ScimUser user,
                                                             javax.servlet.http.HttpServletResponse httpServletResponse)

updateUser

@RequestMapping(value="/Users/{userId}",
                method=PUT)
@ResponseBody
public ScimUser updateUser(@RequestBody
                                              ScimUser user,
                                              @PathVariable
                                              java.lang.String userId,
                                              @RequestHeader(value="If-Match",required=false,defaultValue="NaN")
                                              java.lang.String etag,
                                              javax.servlet.http.HttpServletResponse httpServletResponse)

deleteUser

@RequestMapping(value="/Users/{userId}",
                method=DELETE)
@ResponseBody
public ScimUser deleteUser(@PathVariable
                                              java.lang.String userId,
                                              @RequestHeader(value="If-Match",required=false)
                                              java.lang.String etag,
                                              javax.servlet.http.HttpServletResponse httpServletResponse)

verifyUser

@RequestMapping(value="/Users/{userId}/verify",
                method=GET)
@ResponseBody
public ScimUser verifyUser(@PathVariable
                                              java.lang.String userId,
                                              @RequestHeader(value="If-Match",required=false)
                                              java.lang.String etag,
                                              javax.servlet.http.HttpServletResponse httpServletResponse)

findUsers

@RequestMapping(value="/Users",
                method=GET)
@ResponseBody
public org.cloudfoundry.identity.uaa.rest.SearchResults<?> findUsers(@RequestParam(value="attributes",required=false)
                                                                                        java.lang.String attributesCommaSeparated,
                                                                                        @RequestParam(required=false,defaultValue="id pr")
                                                                                        java.lang.String filter,
                                                                                        @RequestParam(required=false)
                                                                                        java.lang.String sortBy,
                                                                                        @RequestParam(required=false,defaultValue="ascending")
                                                                                        java.lang.String sortOrder,
                                                                                        @RequestParam(required=false,defaultValue="1")
                                                                                        int startIndex,
                                                                                        @RequestParam(required=false,defaultValue="100")
                                                                                        int count)

handleException

@ExceptionHandler
public org.springframework.web.servlet.View handleException(java.lang.Exception t,
                                                                    javax.servlet.http.HttpServletRequest request)
                                                     throws ScimException

Throws:

ScimException

setScimUserProvisioning

public void setScimUserProvisioning(ScimUserProvisioning dao)

setScimGroupMembershipManager

public void setScimGroupMembershipManager(ScimGroupMembershipManager membershipManager)

setApprovalStore

public void setApprovalStore(org.cloudfoundry.identity.uaa.oauth.approval.ApprovalStore approvalStore)

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.lang.Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

java.lang.Exception

setScimUserResourceMonitor

public void setScimUserResourceMonitor(org.cloudfoundry.identity.uaa.rest.ResourceMonitor<ScimUser> scimUserResourceMonitor)

setPasswordValidator

public void setPasswordValidator(PasswordValidator passwordValidator)