com.dtolabs.rundeck.core.cli.acl

Class AclTool

java.lang.Object

com.dtolabs.rundeck.core.cli.BaseTool

com.dtolabs.rundeck.core.cli.acl.AclTool

All Implemented Interfaces:

CLITool, CLIToolLogger, BaseLogger

public class AclTool
extends BaseTool

Created by greg on 4/2/15.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_CREATE
static java.lang.String	ACTION_LIST
static java.lang.String	ACTION_TEST list action identifier
static java.lang.String	ACTION_VALIDATE
static java.lang.String	ADHOC_LONG_OPT
static java.lang.String	ADHOC_OPT
static java.lang.String	ALLOW_LONG_OPT
static java.lang.String	ALLOW_OPT
static java.lang.String	ATTRS_OPT
static java.lang.String	ATTRS_OPT_LONG
static java.lang.String	CONTEXT_LONG_OPT
static java.lang.String	CONTEXT_OPT
static java.lang.String	DENY_LONG_OPT
static java.lang.String	DENY_OPT
static java.lang.String	DIR_OPTION short option string for dir
static java.lang.String	DIR_OPTION_LONG long option string for dir
static java.lang.String	FILE_OPTION short option string for file path
static java.lang.String	FILE_OPTION_LONG long option string for file path
static java.lang.String	GENERIC_LONG_OPT
static java.lang.String	GENERIC_OPT
static java.lang.String	GROUPS_LONG_OPT
static java.lang.String	GROUPS_OPT
static java.lang.String	INPUT_OPT
static java.lang.String	INPUT_OPT_LONG
static java.lang.String	JOB_LONG_OPT
static java.lang.String	JOB_OPT
static java.lang.String	JOB_UUID_LONG_OPT
static java.lang.String	JOB_UUID_OPT
static java.lang.String	LIST_OPT
static java.lang.String	LIST_OPT_LONG
static org.apache.log4j.Logger	log4j log4j
static java.lang.String	NODE_LONG_OPT
static java.lang.String	NODE_OPT
static java.lang.String	PROJECT_ACL_LONG_OPT
static java.lang.String	PROJECT_ACL_OPT
static java.lang.String	PROJECT_LONG_OPT
static java.lang.String	PROJECT_OPT
static java.lang.String	REGEX_OPT
static java.lang.String	REGEX_OPT_LONG
static java.lang.String	RESOURCE_LONG_OPT
static java.lang.String	RESOURCE_OPT
static java.lang.String	STORAGE_LONG_OPT
static java.lang.String	STORAGE_OPT
static java.lang.String	TAGS_LONG_OPT
static java.lang.String	TAGS_OPT
static java.lang.String	USER_LONG_OPT
static java.lang.String	USER_OPT
static java.lang.String	VALIDATE_LONG_OPT
static java.lang.String	VALIDATE_OPT
static java.lang.String	VERBOSE_LONG_OPT
static java.lang.String	VERBOSE_OPT

Constructor Summary

Constructors

Constructor and Description
AclTool(CLIToolLogger cliToolLogger)
AclTool(CLIToolLogger cliToolLogger, java.lang.String rdeckBase)

Method Summary

Modifier and Type	Method and Description
void	debug(java.lang.String message) Logs debug message via implementation specific log facility
void	error(java.lang.String output) Logs error message via implementation specific log facility
java.lang.String	getHelpString()
protected void	go() Call the action
protected boolean	isUseHelpOption()
void	log(java.lang.String output) Logs message via implementation specific log facility
static void	main(java.lang.String[] args) Creates an instance and executes BaseTool.run(String[]).
org.apache.commons.cli.CommandLine	parseArgs(java.lang.String[] args) Reads the argument vector and constructs a CommandLine object containing params
static java.util.Map<java.lang.String,?>	toDataMap(com.dtolabs.rundeck.core.cli.acl.AclTool.AuthRequest authRequest) Create the map structure corresponding to yaml
void	verbose(java.lang.String message) Logs verbose message via implementation specific log facility
void	warn(java.lang.String output) Logs warning message via implementation specific log facility

Methods inherited from class com.dtolabs.rundeck.core.cli.BaseTool

addToolOptions, exit, getCommandLine, getOptions, help, initOptions, optionDisplayString, optionDisplayString, run, setShouldExit, validateOptions

Methods inherited from class java.lang.Object

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

Field Detail

log4j

public static final org.apache.log4j.Logger log4j

log4j

FILE_OPTION

public static final java.lang.String FILE_OPTION

short option string for file path

See Also:

Constant Field Values

FILE_OPTION_LONG

public static final java.lang.String FILE_OPTION_LONG

long option string for file path

See Also:

Constant Field Values

DIR_OPTION

public static final java.lang.String DIR_OPTION

short option string for dir

See Also:

Constant Field Values

DIR_OPTION_LONG

public static final java.lang.String DIR_OPTION_LONG

long option string for dir

See Also:

Constant Field Values

ALLOW_LONG_OPT

public static final java.lang.String ALLOW_LONG_OPT

See Also:

Constant Field Values

ALLOW_OPT

public static final java.lang.String ALLOW_OPT

See Also:

Constant Field Values

GROUPS_LONG_OPT

public static final java.lang.String GROUPS_LONG_OPT

See Also:

Constant Field Values

GROUPS_OPT

public static final java.lang.String GROUPS_OPT

See Also:

Constant Field Values

USER_OPT

public static final java.lang.String USER_OPT

See Also:

Constant Field Values

USER_LONG_OPT

public static final java.lang.String USER_LONG_OPT

See Also:

Constant Field Values

PROJECT_OPT

public static final java.lang.String PROJECT_OPT

See Also:

Constant Field Values

PROJECT_LONG_OPT

public static final java.lang.String PROJECT_LONG_OPT

See Also:

Constant Field Values

PROJECT_ACL_OPT

public static final java.lang.String PROJECT_ACL_OPT

See Also:

Constant Field Values

PROJECT_ACL_LONG_OPT

public static final java.lang.String PROJECT_ACL_LONG_OPT

See Also:

Constant Field Values

JOB_OPT

public static final java.lang.String JOB_OPT

See Also:

Constant Field Values

JOB_LONG_OPT

public static final java.lang.String JOB_LONG_OPT

See Also:

Constant Field Values

JOB_UUID_OPT

public static final java.lang.String JOB_UUID_OPT

See Also:

Constant Field Values

JOB_UUID_LONG_OPT

public static final java.lang.String JOB_UUID_LONG_OPT

See Also:

Constant Field Values

CONTEXT_OPT

public static final java.lang.String CONTEXT_OPT

See Also:

Constant Field Values

CONTEXT_LONG_OPT

public static final java.lang.String CONTEXT_LONG_OPT

See Also:

Constant Field Values

ADHOC_OPT

public static final java.lang.String ADHOC_OPT

See Also:

Constant Field Values

ADHOC_LONG_OPT

public static final java.lang.String ADHOC_LONG_OPT

See Also:

Constant Field Values

NODE_OPT

public static final java.lang.String NODE_OPT

See Also:

Constant Field Values

NODE_LONG_OPT

public static final java.lang.String NODE_LONG_OPT

See Also:

Constant Field Values

TAGS_OPT

public static final java.lang.String TAGS_OPT

See Also:

Constant Field Values

TAGS_LONG_OPT

public static final java.lang.String TAGS_LONG_OPT

See Also:

Constant Field Values

DENY_OPT

public static final java.lang.String DENY_OPT

See Also:

Constant Field Values

DENY_LONG_OPT

public static final java.lang.String DENY_LONG_OPT

See Also:

Constant Field Values

VERBOSE_OPT

public static final java.lang.String VERBOSE_OPT

See Also:

Constant Field Values

VERBOSE_LONG_OPT

public static final java.lang.String VERBOSE_LONG_OPT

See Also:

Constant Field Values

VALIDATE_OPT

public static final java.lang.String VALIDATE_OPT

See Also:

Constant Field Values

VALIDATE_LONG_OPT

public static final java.lang.String VALIDATE_LONG_OPT

See Also:

Constant Field Values

STORAGE_OPT

public static final java.lang.String STORAGE_OPT

See Also:

Constant Field Values

STORAGE_LONG_OPT

public static final java.lang.String STORAGE_LONG_OPT

See Also:

Constant Field Values

GENERIC_OPT

public static final java.lang.String GENERIC_OPT

See Also:

Constant Field Values

GENERIC_LONG_OPT

public static final java.lang.String GENERIC_LONG_OPT

See Also:

Constant Field Values

RESOURCE_OPT

public static final java.lang.String RESOURCE_OPT

See Also:

Constant Field Values

RESOURCE_LONG_OPT

public static final java.lang.String RESOURCE_LONG_OPT

See Also:

Constant Field Values

INPUT_OPT

public static final java.lang.String INPUT_OPT

See Also:

Constant Field Values

INPUT_OPT_LONG

public static final java.lang.String INPUT_OPT_LONG

See Also:

Constant Field Values

REGEX_OPT

public static final java.lang.String REGEX_OPT

See Also:

Constant Field Values

REGEX_OPT_LONG

public static final java.lang.String REGEX_OPT_LONG

See Also:

Constant Field Values

ATTRS_OPT

public static final java.lang.String ATTRS_OPT

See Also:

Constant Field Values

ATTRS_OPT_LONG

public static final java.lang.String ATTRS_OPT_LONG

See Also:

Constant Field Values

LIST_OPT

public static final java.lang.String LIST_OPT

See Also:

Constant Field Values

LIST_OPT_LONG

public static final java.lang.String LIST_OPT_LONG

See Also:

Constant Field Values

ACTION_TEST

public static final java.lang.String ACTION_TEST

list action identifier

See Also:

Constant Field Values

ACTION_CREATE

public static final java.lang.String ACTION_CREATE

See Also:

Constant Field Values

ACTION_LIST

public static final java.lang.String ACTION_LIST

See Also:

Constant Field Values

ACTION_VALIDATE

public static final java.lang.String ACTION_VALIDATE

See Also:

Constant Field Values

Constructor Detail

AclTool

public AclTool(CLIToolLogger cliToolLogger)
        throws java.io.IOException,
               com.dtolabs.rundeck.core.authorization.providers.PoliciesParseException

Throws:

java.io.IOException

com.dtolabs.rundeck.core.authorization.providers.PoliciesParseException

AclTool

public AclTool(CLIToolLogger cliToolLogger,
               java.lang.String rdeckBase)
        throws java.io.IOException,
               com.dtolabs.rundeck.core.authorization.providers.PoliciesParseException

Throws:

java.io.IOException

com.dtolabs.rundeck.core.authorization.providers.PoliciesParseException

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Creates an instance and executes BaseTool.run(String[]).

Parameters:

args - command line arg vector

Throws:

java.lang.Exception - action error

isUseHelpOption

protected boolean isUseHelpOption()

Specified by:

isUseHelpOption in class BaseTool

Returns:

true if the -h/--help option should be added to the options automatically.

parseArgs

public org.apache.commons.cli.CommandLine parseArgs(java.lang.String[] args)
                                             throws CLIToolOptionsException

Reads the argument vector and constructs a CommandLine object containing params

Specified by:

parseArgs in interface CLITool

Overrides:

parseArgs in class BaseTool

Parameters:

args - the cli arg vector

Returns:

a new instance of CommandLine

Throws:

CLIToolOptionsException - if arguments are incorrect

go

protected void go()
           throws CLIToolOptionsException

Call the action

Specified by:

go in class BaseTool

Throws:

CLIToolOptionsException - if an error occurs

toDataMap

public static java.util.Map<java.lang.String,?> toDataMap(com.dtolabs.rundeck.core.cli.acl.AclTool.AuthRequest authRequest)

Create the map structure corresponding to yaml

Parameters:

authRequest - request

Returns:

data map

getHelpString

public java.lang.String getHelpString()

Specified by:

getHelpString in class BaseTool

Returns:

the help string used when -h option is specified.

log

public void log(java.lang.String output)

Description copied from interface: BaseLogger

Logs message via implementation specific log facility

Parameters:

output - message to log

error

public void error(java.lang.String output)

Description copied from interface: BaseLogger

Logs error message via implementation specific log facility

Parameters:

output - message to log

warn

public void warn(java.lang.String output)

Description copied from interface: BaseLogger

Logs warning message via implementation specific log facility

Parameters:

output - message to log

verbose

public void verbose(java.lang.String message)

Logs verbose message via implementation specific log facility

Parameters:

message - message to log

debug

public void debug(java.lang.String message)

Description copied from interface: BaseLogger

Logs debug message via implementation specific log facility

Parameters:

message - message to log