Action (Parent module for everything of interest. 5.6 API)

java.lang.Object
- edu.uiuc.ncsa.sas.thing.Thing
- - edu.uiuc.ncsa.sas.thing.action.Action

All Implemented Interfaces:

SASConstants

Direct Known Subclasses:

ExecuteAction, InvokeAction, LogoffAction, LogonAction, NewKeyAction
```
public class Action
extends Thing
implements SASConstants
```
Models an actions, such as logon, execute, logoff, etc.
Created by Jeff Gaynor
on 8/15/22 at 10:39 AM

Field Summary
- Fields inherited from class edu.uiuc.ncsa.sas.thing.Thing
  type
- Fields inherited from interface edu.uiuc.ncsa.sas.SASConstants
  ACTION_EXECUTE, ACTION_INVOKE, ACTION_LOGOFF, ACTION_LOGON, ACTION_NEW_KEY, CLIENT_ID_HEAD, HEADER_SESSION_ID, KEYS_ACTION, KEYS_ARGUMENT, KEYS_COMMENT, KEYS_EXECUTABLE_NAME, KEYS_INTERNAL_ID, KEYS_METHOD, KEYS_PROMPT, KEYS_SAS, KEYS_STATE, KEYS_SUBJECT, KEYS_SUBJECT_ID, KEYS_SUBJECT_SESSION_ID, KEYS_TYPE, REQUEST_TYPE, RESPONSE_CONTENT, RESPONSE_MESSAGE, RESPONSE_PROMPT, RESPONSE_SESSION_ID, RESPONSE_STATUS, RESPONSE_STATUS_ERROR, RESPONSE_STATUS_OK, RESPONSE_SYMMETRIC_KEY, RESPONSE_TYPE, RESPONSE_TYPE_ERROR, RESPONSE_TYPE_LOGOFF, RESPONSE_TYPE_LOGON, RESPONSE_TYPE_NEW_KEY, RESPONSE_TYPE_OUTPUT, RESPONSE_TYPE_PROMPT

Constructor Summary

Constructors
Constructor Description

Action(String type)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`deserialize(net.sf.json.JSONObject json)`
`String`	`getComment()`	the client may send a comment.
`String`	`getId()`	An (optional) unique identifier that the client sends.
`String`	`getState()`	An optional state string that the client sends. It is passed back unaltered.
`net.sf.json.JSONObject`	`serialize()`	Typically this is called by the `Client` during POST
`void`	`setComment(String comment)`
`void`	`setId(String id)`
`void`	`setState(String state)`
`String`	`toString()`

Methods inherited from class edu.uiuc.ncsa.sas.thing.Thing
equals, getType, setType

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Action
```
public Action(String type)
```
- Method Detail
  - getId
```
public String getId()
```
    An (optional) unique identifier that the client sends. This allows the client to disambiguate like-named calls and dispatch them however it pleases.
    
    This is passed back unaltered if present.
    
    Returns:
  - setId
```
public void setId(String id)
```
  - getState
```
public String getState()
```
    An optional state string that the client sends.
    
    It is passed back unaltered.
    
    Returns:
  - setState
```
public void setState(String state)
```
  - getComment
```
public String getComment()
```
    the client may send a comment. This is passed along, and while it might be recorded in the logs, is ignored. This is because JSON does not allow for comments, hence the client can have comments for its own purposes.
    
    Returns:
  - setComment
```
public void setComment(String comment)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Thing
  - serialize
```
public net.sf.json.JSONObject serialize()
```
    Typically this is called by the Client during POST
    
    Returns:
  - deserialize
```
public void deserialize(net.sf.json.JSONObject json)
```