AbstractCLIApprover (OA4MP server API. 6.2.1 API)

java.lang.Object
- edu.uiuc.ncsa.security.util.cli.CLITool2
- - org.oa4mp.server.api.util.AbstractCLIApprover

All Implemented Interfaces:

edu.uiuc.ncsa.security.core.Logable
```
public abstract class AbstractCLIApprover
extends edu.uiuc.ncsa.security.util.cli.CLITool2
```
A command line approver. This has a couple of modes of operation.
- Immediate updates for non-memory store. If you commit a change, it is done instantly
- Polling mode. A directory is set aside to store the pending approvals. The server polls this at intervals and updates it store. This is especially useful for memory stores.
Use
You should invoke this from the command line and specify the server configuration file. You will have to run this with sufficient permissions to read that file, which probably means running this as root.
Running it from maven
To run this from maven directly, you need to follow these three steps:
1. run mvn compile from the command line to compile it
2. Issue
  
  mvn exec:java -Dexec.mainClass="edu.uiuc.ncsa.myproxy.oa4mp.server.util.CLIApprover" -Dexec.args="-cfg /path/to/config.xml -name config-name"
  r>
3. Follow the on-screen prompts.
Custom versions
This requires the right runtime ServiceEnvironment, which is normally loaded using a ConfigurationLoader.
Created by Jeff Gaynor
on 2/24/12 at 2:40 PM

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AbstractCLIApprover.ClientApprovalThread

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ANONYMOUS`
`static String`	`ID_DELIMITER`
`static String`	`POLLING_DIRECTORY`
`static String`	`POLLING_INTERVAL`
`static String`	`TEMP_FILE_PREFIX`
`static String`	`TEMP_FILE_SUFFIX`

Fields inherited from class edu.uiuc.ncsa.security.util.cli.CLITool2
CONFIG_FILE_LONG_OPTION, CONFIG_FILE_OPTION, CONFIG_NAME_ACTION, CONFIG_NAME_LONG_OPTION, CONFIG_NAME_OPTION, DEBUG_LONG_OPTION, DEBUG_OPTION, DEFAULT_LOG_FILE, HELP_LONG_OPTION, HELP_OPTION, LOG_FILE_LONG_OPTION, LOG_FILE_OPTION, NO_ACTION, VERBOSE_LONG_OPTION, VERBOSE_OPTION

Constructor Summary

Constructors
Constructor Description

AbstractCLIApprover()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`doIt()`
`protected String`	`formatClient(org.oa4mp.delegation.common.storage.clients.Client client)`
`String`	`getComponentName()`
`void`	`help()`

Methods inherited from class edu.uiuc.ncsa.security.util.cli.CLITool2
debug, defaultHelp, error, error, getBufferedReader, getConfigFile, getConfigName, getConfigurationNode, getEnvironment, getInputLine, getIoInterface, getLoader, getLogfileName, getMyLogger, getOptions, hasConfigFile, hasConfigName, info, initialize, isDebugOn, isVerbose, readline, run, run, say, say2, sayv, setBufferedReader, setConfigFile, setConfigName, setConfigurationNode, setDebugOn, setEnvironment, setInputLine, setIoInterface, setLogfileName, setMyLogger, setVerbose, warn

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

- Field Detail
  - ANONYMOUS
```
public static final String ANONYMOUS
```
    See Also:
    
    Constant Field Values
  - POLLING_INTERVAL
```
public static final String POLLING_INTERVAL
```
    See Also:
    
    Constant Field Values
  - POLLING_DIRECTORY
```
public static final String POLLING_DIRECTORY
```
    See Also:
    
    Constant Field Values
  - TEMP_FILE_PREFIX
```
public static final String TEMP_FILE_PREFIX
```
    See Also:
    
    Constant Field Values
  - TEMP_FILE_SUFFIX
```
public static final String TEMP_FILE_SUFFIX
```
    See Also:
    
    Constant Field Values
  - ID_DELIMITER
```
public static final String ID_DELIMITER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractCLIApprover
```
public AbstractCLIApprover()
```
- Method Detail
  - doIt
```
public void doIt()
          throws Exception
```
    Specified by:
    
    doIt in class edu.uiuc.ncsa.security.util.cli.CLITool2
    
    Throws:
    
    Exception
  - formatClient
```
protected String formatClient(org.oa4mp.delegation.common.storage.clients.Client client)
```
  - getComponentName
```
public String getComponentName()
```
    Specified by:
    
    getComponentName in class edu.uiuc.ncsa.security.util.cli.CLITool2
  - help
```
public void help()
```
    Specified by:
    
    help in class edu.uiuc.ncsa.security.util.cli.CLITool2