org.finra.herd.rest

Class UserNamespaceAuthorizationRestController

java.lang.Object

org.finra.herd.rest.HerdBaseController

org.finra.herd.rest.UserNamespaceAuthorizationRestController

@RestController
 @RequestMapping(value="/rest",
                produces={"application/xml","application/json"})
public class UserNamespaceAuthorizationRestController
extends HerdBaseController

The REST controller that handles user namespace authorization REST requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_NAMESPACE_AUTHORIZATIONS_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
UserNamespaceAuthorizationRestController()

Method Summary

Modifier and Type	Method and Description
UserNamespaceAuthorization	createUserNamespaceAuthorization(UserNamespaceAuthorizationCreateRequest request) Creates a new user namespace authorization.
UserNamespaceAuthorization	deleteUserNamespaceAuthorization(String userId, String namespace) Deletes an existing user namespace authorization by key.
UserNamespaceAuthorization	getUserNamespaceAuthorization(String userId, String namespace) Gets an existing user namespace authorization by key.
UserNamespaceAuthorizations	getUserNamespaceAuthorizationsByNamespace(String namespace) Gets a list of user namespace authorizations for the specified namespace.
UserNamespaceAuthorizations	getUserNamespaceAuthorizationsByUserId(String userId) Gets a list of user namespace authorizations for the specified user.
UserNamespaceAuthorization	updateUserNamespaceAuthorization(String userId, String namespace, UserNamespaceAuthorizationUpdateRequest request) Updates an existing user namespace authorization by key.

Methods inherited from class org.finra.herd.rest.HerdBaseController

addPagingHttpHeaders, validateNoDuplicateQueryStringParams

Methods inherited from class java.lang.Object

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

Field Detail

USER_NAMESPACE_AUTHORIZATIONS_URI_PREFIX

public static final String USER_NAMESPACE_AUTHORIZATIONS_URI_PREFIX

See Also:

Constant Field Values

Constructor Detail

UserNamespaceAuthorizationRestController

public UserNamespaceAuthorizationRestController()

Method Detail

createUserNamespaceAuthorization

@RequestMapping(value="/userNamespaceAuthorizations",
                method=POST,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_USER_NAMESPACE_AUTHORIZATIONS_POST")
public UserNamespaceAuthorization createUserNamespaceAuthorization(@RequestBody
                                                                                                                                                                                                                                                                                UserNamespaceAuthorizationCreateRequest request)

Creates a new user namespace authorization.

The user ID field may be prefixed with a wildcard token character "*" to authorize multiple users access to the namespace. The wildcard only works for as a prefix to match the suffix of the user ID. If the wildcard appears anywhere other than the prefix, the user ID must match as-is. For example:

• john.doe@domain.com - only authorizes user with ID "john.doe@domain.com"
• *@domain.com - authorizes users that has the suffix "@domain.com"
• * - authorizes all users
• john.doe* - only authorizes user with ID "john.doe*"

Requires GRANT permission on namespace

Parameters:

request - the information needed to create the user namespace authorization

Returns:

the created user namespace authorization

updateUserNamespaceAuthorization

@RequestMapping(value="/userNamespaceAuthorizations/userIds/{userId}/namespaces/{namespace}",
                method=PUT,
                consumes={"application/xml","application/json"})
 @Secured(value="FN_USER_NAMESPACE_AUTHORIZATIONS_POST")
public UserNamespaceAuthorization updateUserNamespaceAuthorization(@PathVariable(value="userId")
                                                                                                                                                                                                                                                                                                                       String userId,
                                                                                                                                                                                                                                                                                                                       @PathVariable(value="namespace")
                                                                                                                                                                                                                                                                                                                       String namespace,
                                                                                                                                                                                                                                                                                                                       @RequestBody
                                                                                                                                                                                                                                                                                                                       UserNamespaceAuthorizationUpdateRequest request)

Updates an existing user namespace authorization by key.

Requires GRANT permission on namespace

Parameters:

userId - the user id

namespace - the namespace

request - the information needed to update the user namespace authorization

Returns:

the updated user namespace authorization

getUserNamespaceAuthorization

@RequestMapping(value="/userNamespaceAuthorizations/userIds/{userId}/namespaces/{namespace}",
                method=GET)
 @Secured(value="FN_USER_NAMESPACE_AUTHORIZATIONS_GET")
public UserNamespaceAuthorization getUserNamespaceAuthorization(@PathVariable(value="userId")
                                                                                                                                                                                                                                                  String userId,
                                                                                                                                                                                                                                                  @PathVariable(value="namespace")
                                                                                                                                                                                                                                                  String namespace)

Gets an existing user namespace authorization by key.

Requires READ permission on namespace

Parameters:

userId - the user id

namespace - the namespace

Returns:

the retrieved user namespace authorization

deleteUserNamespaceAuthorization

@RequestMapping(value="/userNamespaceAuthorizations/userIds/{userId}/namespaces/{namespace}",
                method=DELETE)
 @Secured(value="FN_USER_NAMESPACE_AUTHORIZATIONS_DELETE")
public UserNamespaceAuthorization deleteUserNamespaceAuthorization(@PathVariable(value="userId")
                                                                                                                                                                                                                                                           String userId,
                                                                                                                                                                                                                                                           @PathVariable(value="namespace")
                                                                                                                                                                                                                                                           String namespace)

Deletes an existing user namespace authorization by key.

Requires GRANT permission on namespace

Parameters:

userId - the user id

namespace - the namespace

Returns:

the deleted user namespace authorization

getUserNamespaceAuthorizationsByUserId

@RequestMapping(value="/userNamespaceAuthorizations/userIds/{userId}",
                method=GET)
 @Secured(value="FN_USER_NAMESPACE_AUTHORIZATIONS_BY_USERID_GET")
public UserNamespaceAuthorizations getUserNamespaceAuthorizationsByUserId(@PathVariable(value="userId")
                                                                                                                                                                                                                                               String userId)

Gets a list of user namespace authorizations for the specified user.

Parameters:

userId - the user id

Returns:

the list of user namespace authorizations

getUserNamespaceAuthorizationsByNamespace

@RequestMapping(value="/userNamespaceAuthorizations/namespaces/{namespace}",
                method=GET)
 @Secured(value="FN_USER_NAMESPACE_AUTHORIZATIONS_BY_NAMESPACE_GET")
public UserNamespaceAuthorizations getUserNamespaceAuthorizationsByNamespace(@PathVariable(value="namespace")
                                                                                                                                                                                                                                                           String namespace)

Gets a list of user namespace authorizations for the specified namespace.

Parameters:

namespace - the namespace

Returns:

the list of user namespace authorizations