Package org.forgerock.openidm.scheduler.impl

Class TaskScannerService

java.lang.Object
org.forgerock.openidm.scheduler.impl.TaskScannerService
All Implemented Interfaces:
org.forgerock.json.resource.RequestHandler, ScheduledService
public class TaskScannerService extends Object implements org.forgerock.json.resource.RequestHandler, ScheduledService

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected IDMConnectionFactory
    connectionFactory
    The Connection Factory

    Fields inherited from interface org.forgerock.openidm.quartz.impl.ScheduledService

    ACTUAL_FIRE_TIME, CONFIG_NAME, CONFIGURED_INVOKE_CONTEXT, CONFIGURED_INVOKE_LOG_LEVEL, CONFIGURED_INVOKE_SERVICE, INVOKER_NAME, NEXT_FIRE_TIME, SCHEDULED_FIRE_TIME

  • Constructor Summary

    Constructors
    Constructor
    Description
    TaskScannerService()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    activate(org.osgi.service.component.ComponentContext context)
     
    void
    auditScheduledService(org.forgerock.services.context.Context context, org.forgerock.audit.events.AuditEvent auditEvent)
    Invoked by the scheduler to audit the scheduled event.
    protected void
    bindConnectionFactory(IDMConnectionFactory connectionFactory)
     
    void
    execute(org.forgerock.services.context.Context context, Map<String,Object> contextMap)
    Invoked by the Task Scanner whenever the task scanner is triggered by the scheduler
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException>
    handleAction(org.forgerock.services.context.Context context, org.forgerock.json.resource.ActionRequest request)
     
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>
    handleCreate(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>
    handleDelete(org.forgerock.services.context.Context context, org.forgerock.json.resource.DeleteRequest request)
     
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>
    handlePatch(org.forgerock.services.context.Context context, org.forgerock.json.resource.PatchRequest request)
     
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.QueryResponse,org.forgerock.json.resource.ResourceException>
    handleQuery(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>
    handleRead(org.forgerock.services.context.Context context, org.forgerock.json.resource.ReadRequest request)
     
    org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException>
    handleUpdate(org.forgerock.services.context.Context context, org.forgerock.json.resource.UpdateRequest request)
     

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • TaskScannerService

      public TaskScannerService()

  • Method Details

    • bindConnectionFactory

      protected void bindConnectionFactory(IDMConnectionFactory connectionFactory)

    • activate

      public void activate(org.osgi.service.component.ComponentContext context)

    • execute

      public void execute(org.forgerock.services.context.Context context, Map<String,Object> contextMap) throws ExecutionException
      Invoked by the Task Scanner whenever the task scanner is triggered by the scheduler
      Specified by:
      execute in interface ScheduledService
      Parameters:
      context - the Context to use for the request
      contextMap - Context information passed by the scheduler service
      Throws:
      ExecutionException - if execution of the scheduled work failed. Implementations can also throw RuntimeExceptions which will get logged.

    • auditScheduledService

      public void auditScheduledService(org.forgerock.services.context.Context context, org.forgerock.audit.events.AuditEvent auditEvent) throws ExecutionException
      Description copied from interface: ScheduledService
      Invoked by the scheduler to audit the scheduled event.
      Specified by:
      auditScheduledService in interface ScheduledService
      Parameters:
      context - the context to use to audit the event
      auditEvent - the event to audit
      Throws:
      ExecutionException - if the audit event fails

    • handleRead

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> handleRead(org.forgerock.services.context.Context context, org.forgerock.json.resource.ReadRequest request)
      Specified by:
      handleRead in interface org.forgerock.json.resource.RequestHandler

    • handleAction

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ActionResponse,org.forgerock.json.resource.ResourceException> handleAction(org.forgerock.services.context.Context context, org.forgerock.json.resource.ActionRequest request)
      Specified by:
      handleAction in interface org.forgerock.json.resource.RequestHandler

    • handleCreate

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> handleCreate(org.forgerock.services.context.Context context, org.forgerock.json.resource.CreateRequest request)
      Specified by:
      handleCreate in interface org.forgerock.json.resource.RequestHandler

    • handleDelete

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> handleDelete(org.forgerock.services.context.Context context, org.forgerock.json.resource.DeleteRequest request)
      Specified by:
      handleDelete in interface org.forgerock.json.resource.RequestHandler

    • handlePatch

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> handlePatch(org.forgerock.services.context.Context context, org.forgerock.json.resource.PatchRequest request)
      Specified by:
      handlePatch in interface org.forgerock.json.resource.RequestHandler

    • handleQuery

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

    • handleUpdate

      public org.forgerock.util.promise.Promise<org.forgerock.json.resource.ResourceResponse,org.forgerock.json.resource.ResourceException> handleUpdate(org.forgerock.services.context.Context context, org.forgerock.json.resource.UpdateRequest request)
      Specified by:
      handleUpdate in interface org.forgerock.json.resource.RequestHandler