Java Doc for VishnuAllocatorPlugin.java in  » Science » Cougaar12_4 » org » cougaar » lib » vishnu » client » Java Source Code / Java DocumentationJava Source Code and Java Documentation

 Callback for input tasks 
 Provide the callback that is paired with the buffering thread, which is a
 listener.

 By default, sets highest confidence on allocation.

Got an ill-formed task, now handle it, by
publishing a failed plan allocation for the task.

 Called when an allocation is removed from the cluster.
 I.e.

 Implemented for UTILAllocationListener
 Defines re-allocation of a rescinded task.

 Implemented for UTILAllocationListener
 Called automatically by the UTILAllocationCallback 
 if the allocation has changed but it does NOT need 
 to be rescinded.

OVERRIDE to specify task notifications (i.e.

 Implemented for UTILAllocationListener
 Defines conditions for rescinding tasks.
 Only return true if the plugin can do something different 
 with the task that failed.

 Implemented for UTILAllocationListener
 Public version of publishRemove
 Called by UTILAllocationCallback.reactToChangedAlloc.

 The idea is to add subscriptions (via the filterCallback), and when 
 they change, to have the callback react to the change, and tell 
 the listener (many times the plugin) what to do.

 Callback for input tasks 
 Provide the callback that is paired with the buffering thread, which is a
 listener.  The buffering thread is the listener to the callback
 Creates an instance of the WorkflowCallback, which means the plugin
 is looking for tasks that are part of workflows.
 

 By default, sets highest confidence on allocation. 

 This is usually only appropriate for allocation to Physical Assets.  

 If your allocator allocates to organizations, you probably want to override 

 this function and set the confidence to alloc.MEDIUM_CONFIDENCE. 

 Or you could do : 
 double confidence = ((GLMAsset) asset).hasPhysicalPG () ? 
 alloc.HIGHEST_CONFIDENCE : alloc.MEDIUM_CONFIDENCE; 
 

If the task has a setup or wrapup duration, and expansion is made and
then the subtasks get allocated with the setup and wrapup durations.

Calls createAllocation to create the allocation of task to asset, and makeSetupAndWrapupTasks to create the optional setup and wrapup tasks. createAllocationis called using getConfidence and getRole.
See Also:   VishnuAllocatorPlugin.createAllocation
See Also:   VishnuAllocatorPlugin.makeSetupAndWrapupTasks
Parameters:
  task - task being assigned to asset
Parameters:
  asset - asset handling the task
Parameters:
  start - start of the main task
Parameters:
  end - end of the main task
Parameters:
  setupStart - start of a setup task, equal to start if there is no setup task
Parameters:
  wrapupEnd - end of a wrapup task, equal to end if there is no wrapup task

Got an ill-formed task, now handle it, by
publishing a failed plan allocation for the task.
Parameters:
  t - badly-formed task to handle

 Called when an allocation is removed from the cluster.
 I.e. an upstream cluster removed an allocation, and that 
 rescind has resulted in this allocation being removed.
 If the plugin maintains some local state of the availability
 of assets, it should update them here.
 This is different from the needToRescind-handleRescindedAlloc pair
 which are used when the plugin gets a result that it wants to
 replan.  If needToRescind returns true, a downstream
 cluster will see handleRemovedAlloc get called.
 Calls VishnuPlugin.handleRemovedTasks.  If in incremental mode,
 the SchedulerLifecycle Mode will tell the scheduler to forget about
 the removed task.
 

 Implemented for UTILAllocationListener
 Defines re-allocation of a rescinded task.  
 Overriders need to take into consideration that 
 the asset chosen last time is not available this time.
 Note that updateAllocationResult is called automatically by
 the UTILAllocationCallback if the allocation has changed 
 (typically if its allocation result has changed) 
 but it does NOT need to be rescinded.
 Called by UTILAllocationCallback.reactToChangedAlloc.
 Only called when needToRescind returns TRUE.
 See comment on needToRescind.
 Does nothing by default.
 

 Implemented for UTILAllocationListener
 Called automatically by the UTILAllocationCallback 
 if the allocation has changed but it does NOT need 
 to be rescinded. 
 updateAllocationResult is called first and then this method 
 gets called.
 Called by UTILAllocationCallback.reactToChangedAlloc.
 Only called when needToRescind returns FALSE.
 See comment on needToRescind.
 Does nothing by default.
 

OVERRIDE to specify task notifications (i.e. changed (allocations) the plugin is interested in.

Just calls interestingTask by default, which is generally what you want.
Parameters:
  t - task to check for notification boolean true if task is interesting

 Implemented for UTILAllocationListener
 Defines conditions for rescinding tasks.
 Only return true if the plugin can do something different 
 with the task that failed.  See allocHelper.isFailedPE.
 When returns TRUE, handleRescindedAlloc is called. 
 If in making an allocation, a preference
 threshold is exceeded, the returned plan element will be
 a Disposition (see UTILAllocate.makeAllocation ()).
 Called by UTILAllocationCallback.reactToChangedAlloc.
 

 Implemented for UTILAllocationListener
 Public version of publishRemove
 Called by UTILAllocationCallback.reactToChangedAlloc.
 

 The idea is to add subscriptions (via the filterCallback), and when 
 they change, to have the callback react to the change, and tell 
 the listener (many times the plugin) what to do.
 Override and call super to add new filters, or override 
 createXXXCallback to change callback behaviour.
 By default adds allocation callback after creating it.