Class UserUpdateService

  • All Implemented Interfaces:
    org.forgerock.json.resource.CollectionResourceProvider

    public final class UserUpdateService
    extends Object
    implements org.forgerock.json.resource.CollectionResourceProvider
    A RequestHandler that proxies user requests to update the user's KBA answers.
    Since:
    0.8.0
    • Constructor Summary

      Constructors 
      Constructor Description
      UserUpdateService​(org.forgerock.json.resource.ConnectionFactory connectionFactory, org.forgerock.json.resource.ResourcePath identityService, org.forgerock.json.JsonPointer kbaPropertyField)
      Construct a service to update the user's KBA info.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,​org.forgerock.json.resource.ResourceException> actionCollection​(org.forgerock.services.context.Context context, org.forgerock.json.resource.ActionRequest request)  
      org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,​org.forgerock.json.resource.ResourceException> actionInstance​(org.forgerock.services.context.Context context, String resourceId, org.forgerock.json.resource.ActionRequest request)  
      org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,​org.forgerock.json.resource.ResourceException> createInstance​(org.forgerock.services.context.Context context, org.forgerock.json.resource.CreateRequest request)  
      org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,​org.forgerock.json.resource.ResourceException> deleteInstance​(org.forgerock.services.context.Context context, String resourceId, org.forgerock.json.resource.DeleteRequest request)  
      org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,​org.forgerock.json.resource.ResourceException> patchInstance​(org.forgerock.services.context.Context context, String resourceId, org.forgerock.json.resource.PatchRequest request)  
      org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,​org.forgerock.json.resource.ResourceException> queryCollection​(org.forgerock.services.context.Context context, org.forgerock.json.resource.QueryRequest request, org.forgerock.json.resource.QueryResourceHandler handler)  
      org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,​org.forgerock.json.resource.ResourceException> readInstance​(org.forgerock.services.context.Context context, String resourceId, org.forgerock.json.resource.ReadRequest request)  
      org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,​org.forgerock.json.resource.ResourceException> updateInstance​(org.forgerock.services.context.Context context, String resourceId, org.forgerock.json.resource.UpdateRequest request)  
    • Constructor Detail

      • UserUpdateService

        @Inject
        public UserUpdateService​(org.forgerock.json.resource.ConnectionFactory connectionFactory,
                                 org.forgerock.json.resource.ResourcePath identityService,
                                 org.forgerock.json.JsonPointer kbaPropertyField)
        Construct a service to update the user's KBA info.
        Parameters:
        connectionFactory - a ConnectionFactory with access to the identityService route.
        identityService - the route to the identity service used to patch the user
        kbaPropertyField - the pointer where KBA is stored in the user
    • Method Detail

      • actionCollection

        public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,​org.forgerock.json.resource.ResourceException> actionCollection​(org.forgerock.services.context.Context context,
                                                                                                                                                                   org.forgerock.json.resource.ActionRequest request)
        Specified by:
        actionCollection in interface org.forgerock.json.resource.CollectionResourceProvider
      • actionInstance

        public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,​org.forgerock.json.resource.ResourceException> actionInstance​(org.forgerock.services.context.Context context,
                                                                                                                                                                 String resourceId,
                                                                                                                                                                 org.forgerock.json.resource.ActionRequest request)
        Specified by:
        actionInstance in interface org.forgerock.json.resource.CollectionResourceProvider
      • createInstance

        public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,​org.forgerock.json.resource.ResourceException> createInstance​(org.forgerock.services.context.Context context,
                                                                                                                                                                   org.forgerock.json.resource.CreateRequest request)
        Specified by:
        createInstance in interface org.forgerock.json.resource.CollectionResourceProvider
      • deleteInstance

        public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,​org.forgerock.json.resource.ResourceException> deleteInstance​(org.forgerock.services.context.Context context,
                                                                                                                                                                   String resourceId,
                                                                                                                                                                   org.forgerock.json.resource.DeleteRequest request)
        Specified by:
        deleteInstance in interface org.forgerock.json.resource.CollectionResourceProvider
      • patchInstance

        public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,​org.forgerock.json.resource.ResourceException> patchInstance​(org.forgerock.services.context.Context context,
                                                                                                                                                                  String resourceId,
                                                                                                                                                                  org.forgerock.json.resource.PatchRequest request)
        Specified by:
        patchInstance in interface org.forgerock.json.resource.CollectionResourceProvider
      • queryCollection

        public org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,​org.forgerock.json.resource.ResourceException> queryCollection​(org.forgerock.services.context.Context context,
                                                                                                                                                                 org.forgerock.json.resource.QueryRequest request,
                                                                                                                                                                 org.forgerock.json.resource.QueryResourceHandler handler)
        Specified by:
        queryCollection in interface org.forgerock.json.resource.CollectionResourceProvider
      • readInstance

        public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,​org.forgerock.json.resource.ResourceException> readInstance​(org.forgerock.services.context.Context context,
                                                                                                                                                                 String resourceId,
                                                                                                                                                                 org.forgerock.json.resource.ReadRequest request)
        Specified by:
        readInstance in interface org.forgerock.json.resource.CollectionResourceProvider
      • updateInstance

        public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,​org.forgerock.json.resource.ResourceException> updateInstance​(org.forgerock.services.context.Context context,
                                                                                                                                                                   String resourceId,
                                                                                                                                                                   org.forgerock.json.resource.UpdateRequest request)
        Specified by:
        updateInstance in interface org.forgerock.json.resource.CollectionResourceProvider