[ 
https://issues.apache.org/jira/browse/OODT-330?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13145751#comment-13145751
 ] 

Brian Foster edited comment on OODT-330 at 11/7/11 8:10 PM:
------------------------------------------------------------

- attached patch

- code can be reviewed here: https://reviews.apache.org/r/2755/

Here are some example outputs:

{code}
$ ./wmgr-client -h
-----------------------------------------------------------------------------------------------------------------
| Short | Long                                             | Description
-----------------------------------------------------------------------------------------------------------------

 -u,     --url <url>                                        Workflow Manager URL
                                                              Handler: 
                                                               Sets the 
following Java Properties: 
                                                               
[org.apache.oodt.cas.workflow.url] 

 -op,    --operation                                        Declare that you 
wish to present an operation
 -p,     --pageNum <page>                                   Page Number
                                                              Requirement 
Rules: 
                                                               [GetNextPage : 
REQUIRED, GetPrevPage : REQUIRED] 

                                                              Handler: 
                                                               Will invoke 
'setPageNum' on action selected, 
                                                               except for the 
following actions: [] 

 -m,     --metaData                                         Declare that you 
wish to present metadata
                                                              Requirement 
Rules: 
                                                               [SendEvent : 
OPTIONAL, DynMetadata : OPTIONAL] 

 -en,    --eventName <event-name>                           Name of the Event 
to trigger
                                                              Requirement 
Rules: 
                                                               [SendEvent : 
REQUIRED, GetWorkflowsByEvent : 
                                                               REQUIRED] 

                                                              Handler: 
                                                               Will invoke 
'setEventName' on action selected, 
                                                               except for the 
following actions: [] 

 -s,     --status <status>                                  Workflow status
                                                              Requirement 
Rules: 
                                                               [GetFirstPage : 
OPTIONAL, GetNextPage : OPTIONAL, 
                                                               GetPrevPage : 
OPTIONAL, GetLastPage : OPTIONAL] 

                                                              Handler: 
                                                               Will invoke 
'setStatus' on action selected, except 
                                                               for the 
following actions: [] 

 -tids,  --taskIds <task-ids>                               List of workflow 
task ids
                                                              Requirement 
Rules: 
                                                               [DynWorkflow : 
REQUIRED] 

                                                              Handler: 
                                                               Will invoke 
'setTaskIds' on action selected, 
                                                               except for the 
following actions: [] 

 -id,    --id <id>                                          ID
                                                              Requirement 
Rules: 
                                                               [GetTaskById : 
REQUIRED, GetConditionById : 
                                                               REQUIRED, 
GetWorkflowById : REQUIRED, 
                                                               GetWorkflowInst 
: REQUIRED, GetWallClockTime : 
                                                               REQUIRED, 
GetTaskWallClockTime : REQUIRED, 
                                                               StopWorkflowInst 
: REQUIRED, PauseWorkflowInst : 
                                                               REQUIRED, 
ResumeWorkflowInst : REQUIRED, 
                                                               
GetWorkflowInstMet : REQUIRED] 

                                                              Handler: 
                                                               Will invoke 
'setId' on action selected, except for 
                                                               the following 
actions: [GetTaskById : setTaskId, 
                                                               GetConditionById 
: setConditionId, GetWorkflowById 
                                                               : setWorkflowId, 
GetWorkflowInst : setInstanceId, 
                                                               GetWallClockTime 
: setInstanceId, 
                                                               
GetTaskWallClockTime : setInstanceId, 
                                                               StopWorkflowInst 
: setInstanceId, 
                                                               
PauseWorkflowInst : setInstanceId, 
                                                               
ResumeWorkflowInst : setInstanceId, 
                                                               
GetWorkflowInstMet : setInstanceId] 

 -psa,   --printSupportedActions                            Print Supported 
Actions
 -a,     --action <action-name>                             This is the name of 
the action to trigger
 -h,     --help                                             Prints help menu
-----------------------------------------------------------------------------------------------------------------




$ ./wmgr-client -psa

Actions:
  Action:
    Name: StopWorkflowInst
    Description: Stops a workflow instance

Actions:
  Action:
    Name: GetNextPage
    Description: Gets next page of workflows

Actions:
  Action:
    Name: GetTaskById
    Description: Gets task information for task with given ID

Actions:
  Action:
    Name: GetWallClockTime
    Description: Gets wall clock time for workflow instance

Actions:
  Action:
    Name: GetLastPage
    Description: Gets last page of workflows

Actions:
  Action:
    Name: GetFirstPage
    Description: Gets first page of workflows

Actions:
  Action:
    Name: GetWorkflowInst
    Description: Gets workflow instance by instance ID

Actions:
  Action:
    Name: GetConditionById
    Description: Gets condition information for condition with given ID

Actions:
  Action:
    Name: DynWorkflow
    Description: Creates a workflow using the given tasks and then executes it

Actions:
  Action:
    Name: GetWorkflows
    Description: List all workflow models

Actions:
  Action:
    Name: GetWorkflowInsts
    Description: List all workflow instances

Actions:
  Action:
    Name: GetPrevPage
    Description: Gets prev page of workflows

Actions:
  Action:
    Name: ResumeWorkflowInst
    Description: Resumes a paused workflow instance

Actions:
  Action:
    Name: GetWorkflowById
    Description: Gets workflow information for workflow with given ID

Actions:
  Action:
    Name: PauseWorkflowInst
    Description: Pauses a workflow instance

Actions:
  Action:
    Name: GetWorkflowInstMet
    Description: Gets workflow instance metadata

Actions:
  Action:
    Name: GetWorkflowsByEvent
    Description: List workflow information for workflows with attached to event

Actions:
  Action:
    Name: GetRegisteredEvents
    Description: List registered events

Actions:
  Action:
    Name: GetTaskWallClockTime
    Description: Gets wall clock time for workflow instance's current task

Actions:
  Action:
    Name: SendEvent
    Description: Triggers an event



$ ./wmgr-client -h SendEvent

Action Help for 'SendEvent'
 - Required:
    -u [--url] <url>
    -op [--operation]
      -se [--sendEvent]
    -en [--eventName] <event-name>
 - Optional:
    -m [--metaData]
      -k [--key] <key-vals>



$ ./wmgr-client -h DynWorkflow

Action Help for 'DynWorkflow'
 - Required:
    -u [--url] <url>
    -op [--operation]
      -dw [--dynWorkflow]
    -tids [--taskIds] <task-ids>
 - Optional:



$ ./wmgr-client -h GetConditionById

Action Help for 'GetConditionById'
 - Required:
    -u [--url] <url>
    -op [--operation]
      -cbyid [--getConditionById]
    -id [--id] <condition-id>
 - Optional:
{code}
                
      was (Author: bfoster):
    - attached patch

- code can be reviewed here: https://reviews.apache.org/r/2755/

Here are some example outputs:

$ ./wmgr-client -h
-----------------------------------------------------------------------------------------------------------------
| Short | Long                                             | Description
-----------------------------------------------------------------------------------------------------------------

 -u,     --url <url>                                        Workflow Manager URL
                                                              Handler: 
                                                               Sets the 
following Java Properties: 
                                                               
[org.apache.oodt.cas.workflow.url] 

 -op,    --operation                                        Declare that you 
wish to present an operation
 -p,     --pageNum <page>                                   Page Number
                                                              Requirement 
Rules: 
                                                               [GetNextPage : 
REQUIRED, GetPrevPage : REQUIRED] 

                                                              Handler: 
                                                               Will invoke 
'setPageNum' on action selected, 
                                                               except for the 
following actions: [] 

 -m,     --metaData                                         Declare that you 
wish to present metadata
                                                              Requirement 
Rules: 
                                                               [SendEvent : 
OPTIONAL, DynMetadata : OPTIONAL] 

 -en,    --eventName <event-name>                           Name of the Event 
to trigger
                                                              Requirement 
Rules: 
                                                               [SendEvent : 
REQUIRED, GetWorkflowsByEvent : 
                                                               REQUIRED] 

                                                              Handler: 
                                                               Will invoke 
'setEventName' on action selected, 
                                                               except for the 
following actions: [] 

 -s,     --status <status>                                  Workflow status
                                                              Requirement 
Rules: 
                                                               [GetFirstPage : 
OPTIONAL, GetNextPage : OPTIONAL, 
                                                               GetPrevPage : 
OPTIONAL, GetLastPage : OPTIONAL] 

                                                              Handler: 
                                                               Will invoke 
'setStatus' on action selected, except 
                                                               for the 
following actions: [] 

 -tids,  --taskIds <task-ids>                               List of workflow 
task ids
                                                              Requirement 
Rules: 
                                                               [DynWorkflow : 
REQUIRED] 

                                                              Handler: 
                                                               Will invoke 
'setTaskIds' on action selected, 
                                                               except for the 
following actions: [] 

 -id,    --id <id>                                          ID
                                                              Requirement 
Rules: 
                                                               [GetTaskById : 
REQUIRED, GetConditionById : 
                                                               REQUIRED, 
GetWorkflowById : REQUIRED, 
                                                               GetWorkflowInst 
: REQUIRED, GetWallClockTime : 
                                                               REQUIRED, 
GetTaskWallClockTime : REQUIRED, 
                                                               StopWorkflowInst 
: REQUIRED, PauseWorkflowInst : 
                                                               REQUIRED, 
ResumeWorkflowInst : REQUIRED, 
                                                               
GetWorkflowInstMet : REQUIRED] 

                                                              Handler: 
                                                               Will invoke 
'setId' on action selected, except for 
                                                               the following 
actions: [GetTaskById : setTaskId, 
                                                               GetConditionById 
: setConditionId, GetWorkflowById 
                                                               : setWorkflowId, 
GetWorkflowInst : setInstanceId, 
                                                               GetWallClockTime 
: setInstanceId, 
                                                               
GetTaskWallClockTime : setInstanceId, 
                                                               StopWorkflowInst 
: setInstanceId, 
                                                               
PauseWorkflowInst : setInstanceId, 
                                                               
ResumeWorkflowInst : setInstanceId, 
                                                               
GetWorkflowInstMet : setInstanceId] 

 -psa,   --printSupportedActions                            Print Supported 
Actions
 -a,     --action <action-name>                             This is the name of 
the action to trigger
 -h,     --help                                             Prints help menu
-----------------------------------------------------------------------------------------------------------------




$ ./wmgr-client -psa

Actions:
  Action:
    Name: StopWorkflowInst
    Description: Stops a workflow instance

Actions:
  Action:
    Name: GetNextPage
    Description: Gets next page of workflows

Actions:
  Action:
    Name: GetTaskById
    Description: Gets task information for task with given ID

Actions:
  Action:
    Name: GetWallClockTime
    Description: Gets wall clock time for workflow instance

Actions:
  Action:
    Name: GetLastPage
    Description: Gets last page of workflows

Actions:
  Action:
    Name: GetFirstPage
    Description: Gets first page of workflows

Actions:
  Action:
    Name: GetWorkflowInst
    Description: Gets workflow instance by instance ID

Actions:
  Action:
    Name: GetConditionById
    Description: Gets condition information for condition with given ID

Actions:
  Action:
    Name: DynWorkflow
    Description: Creates a workflow using the given tasks and then executes it

Actions:
  Action:
    Name: GetWorkflows
    Description: List all workflow models

Actions:
  Action:
    Name: GetWorkflowInsts
    Description: List all workflow instances

Actions:
  Action:
    Name: GetPrevPage
    Description: Gets prev page of workflows

Actions:
  Action:
    Name: ResumeWorkflowInst
    Description: Resumes a paused workflow instance

Actions:
  Action:
    Name: GetWorkflowById
    Description: Gets workflow information for workflow with given ID

Actions:
  Action:
    Name: PauseWorkflowInst
    Description: Pauses a workflow instance

Actions:
  Action:
    Name: GetWorkflowInstMet
    Description: Gets workflow instance metadata

Actions:
  Action:
    Name: GetWorkflowsByEvent
    Description: List workflow information for workflows with attached to event

Actions:
  Action:
    Name: GetRegisteredEvents
    Description: List registered events

Actions:
  Action:
    Name: GetTaskWallClockTime
    Description: Gets wall clock time for workflow instance's current task

Actions:
  Action:
    Name: SendEvent
    Description: Triggers an event



$ ./wmgr-client -h SendEvent

Action Help for 'SendEvent'
 - Required:
    -u [--url] <url>
    -op [--operation]
      -se [--sendEvent]
    -en [--eventName] <event-name>
 - Optional:
    -m [--metaData]
      -k [--key] <key-vals>



$ ./wmgr-client -h DynWorkflow

Action Help for 'DynWorkflow'
 - Required:
    -u [--url] <url>
    -op [--operation]
      -dw [--dynWorkflow]
    -tids [--taskIds] <task-ids>
 - Optional:



$ ./wmgr-client -h GetConditionById

Action Help for 'GetConditionById'
 - Required:
    -u [--url] <url>
    -op [--operation]
      -cbyid [--getConditionById]
    -id [--id] <condition-id>
 - Optional:
                  
> Factor out command line utility from oodt-commons
> -------------------------------------------------
>
>                 Key: OODT-330
>                 URL: https://issues.apache.org/jira/browse/OODT-330
>             Project: OODT
>          Issue Type: New Feature
>          Components: commons
>    Affects Versions: 0.3
>         Environment: none
>            Reporter: Brian Foster
>            Assignee: Brian Foster
>            Priority: Minor
>             Fix For: 0.4
>
>         Attachments: SendEventCliAction.java, 
> SwitchWorkflowToUseCasCli.patch.txt, WorkflowCliAction.java, 
> cmd-line-actions.xml, cmd-line-options.xml, move_cas-cl_to_trunk.patch.txt
>
>
> Factoring out CAS Command Line interface:
> - will include speed improvements over existing version in oodt-commons
> - will include support for grouping command line options
> - will include support for writing your own command line help print-out 
> look/format
> - will include factoring out of Spring based usages such that they are still 
> highly supported, but also optional

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: 
https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Reply via email to