Package org.oa4mp.server.admin.oauth2.tools

Class OA2AdminClientCommands

java.lang.Object

edu.uiuc.ncsa.security.util.cli.AbstractCommandsImpl

edu.uiuc.ncsa.security.util.cli.CommonCommands2

edu.uiuc.ncsa.security.storage.cli.StoreCommands2

org.oa4mp.server.admin.oauth2.base.OA4MPStoreCommands

org.oa4mp.server.admin.oauth2.base.BaseClientStoreCommands

org.oa4mp.server.admin.oauth2.tools.OA2AdminClientCommands

All Implemented Interfaces:

edu.uiuc.ncsa.security.core.Logable, edu.uiuc.ncsa.security.util.cli.Commands, Serializable

public class OA2AdminClientCommands
extends BaseClientStoreCommands

Created by Jeff Gaynor
on 12/8/16 at 12:34 PM

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OA2AdminClientCommands.AdminApprovalModsConfig

Nested classes/interfaces inherited from class org.oa4mp.server.admin.oauth2.base.BaseClientStoreCommands

BaseClientStoreCommands.ApprovalModsConfig

Nested classes/interfaces inherited from class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

edu.uiuc.ncsa.security.storage.cli.StoreCommands2.ChangeIDRecord, edu.uiuc.ncsa.security.storage.cli.StoreCommands2.RSRecord

Field Summary

Fields

Modifier and Type	Field	Description
static String	APPROVAL_QDL_ENABLE
static String	LINK_NEW_CLIENT_FLAG
static String	LINK_RANDOM_CLIENT_ID_ARG
static String	NO_VERIFY_ALL_FLAG
static String	UNLINK_ALL_FLAG
static String	UNLINK_REMOVE_FLAG

Fields inherited from class org.oa4mp.server.admin.oauth2.base.BaseClientStoreCommands

APPROVE_FLAG, APPROVER_KEY, clientApprovalStoreCommands, RESET_SECRET_DEFAULT_SIZE, RESET_SECRET_NEW_FLAG, RESET_SECRET_SIZE_FLAG

Fields inherited from class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

ALL_LIST_COMMAND, allEntries, DEFAULT_MAGIC_NUMBER, display_width, FILE_FLAG, FORCE_COPY_FLAG, KEY_SHORTHAND_PREFIX, LINE_LIST_COMMAND, LIST_EOL_MARKER, LOAD_ONLY_COMMAND, NEXT_N_COMMAND, RANDOM_ID_FLAG, RESULT_SET_KEY, resultSets, RM_FORCE_FLAG, RS_APPEND_ACTION, RS_CLEAR_ACTION, RS_DROP_ACTION, RS_FIELDS_ACTION, RS_FILE_KEY, RS_LIST_ACTION, RS_RANGE_KEY, RS_RANGE_SHORT_KEY, RS_READ_ACTION, RS_REMOVE_ACTION, RS_SAVE_ACTION, RS_SHOW_ACTION, RS_SIZE_ACTION, RS_SUBSET_ACTION, RS_WRITE_ACTION, SEARCH_AFTER_TS_FLAG, SEARCH_BEFORE_TS_FLAG, SEARCH_DATE_FLAG, SEARCH_DEBUG_FLAG, SEARCH_IS_NULL_FLAG, SEARCH_REGEX_FLAG, SEARCH_RESULT_SET_NAME, SEARCH_RETURNED_ATTRIBUTES_FLAG, SEARCH_SHORT_REGEX_FLAG, SEARCH_SIZE_FLAG, SEARCH_VERSIONS_FALSE_VALUE, SEARCH_VERSIONS_FLAG, SEARCH_VERSIONS_ONLY_VALUE, SEARCH_VERSIONS_TRUE_VALUE, SHORT_UPDATE_FLAG, SHOW_HEADER, SHOW_VERSIONS_LIST_COMMAND, SIZE_ALL_FLAG, SIZE_VERSIONS_FLAG, SKIP_UPDATE_PERMISSIONS_FLAG, sortable, STILE, UPDATE_FLAG, UPKEEP_FLAG_CFG, UPKEEP_FLAG_ENABLE, UPKEEP_FLAG_RUN, UPKEEP_FLAG_SHOW, UPKEEP_FLAG_TEST, VERBOSE_COMMAND

Fields inherited from class edu.uiuc.ncsa.security.util.cli.CommonCommands2

placeHolder

Fields inherited from class edu.uiuc.ncsa.security.util.cli.AbstractCommandsImpl

CL_INPUT_FILE_FLAG, CL_OUTPUT_FILE_FLAG, DEFAULT_NULL_VALUE_PLACEHOLDER, defaultIndent, INDENT, LOGO, logoName, NO_HEADER, NO_LOGO, showHeader, showLogo, SILENT

Constructor Summary

Constructors

Constructor	Description
OA2AdminClientCommands(edu.uiuc.ncsa.security.util.cli.CLIDriver driver, String defaultIndent, edu.uiuc.ncsa.security.core.Store adminClientStore, ClientApprovalStoreCommands clientApprovalStoreCommands, PermissionsStore permissionsStore, ClientStore clientStore)

Method Summary

Modifier and Type	Method	Description
void	count_clients(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
protected BaseClientStoreCommands.ApprovalModsConfig	createApprovalModsConfig(edu.uiuc.ncsa.security.util.cli.InputLine inputLine, BaseClient client, boolean doPrompt)
protected BaseClient	doApprovalMods(BaseClientStoreCommands.ApprovalModsConfig approvalModsConfig)	If there are modifications to the client before saving its approval (e.g.
void	extraUpdates(edu.uiuc.ncsa.security.core.Identifiable identifiable, int magicNumber)
String	getName()
void	initHelp()
void	initialize()
void	link(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
void	list_admins(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
void	list_clients(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
void	list_ersatz(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
void	list_provisioners(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
void	print_help()
void	set_ersatz(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
protected void	showCountClientsHelp()
protected void	showDeserializeHelp()
protected void	showListAdminsHelp()
protected void	showListClientsHelp()
void	unlink(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
protected void	unlinkRS(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
protected int	updateStorePermissions(edu.uiuc.ncsa.security.core.Identifier newID, edu.uiuc.ncsa.security.core.Identifier oldID, boolean copy)

Methods inherited from class org.oa4mp.server.admin.oauth2.base.BaseClientStoreCommands

approve, approve, approver_search, archiveFormat, columnHeader, create, create_hash, doChangeID, fieldWidths, format, format, format, getClientApprovalStore, getPublicKeyFile, getSecret, getSortable, inputJSON, inputJSON, isCARS, listEntries, longFormat, longFormat, NEWformat, old_approve, password, reset_secret, rmCleanup, showApproveHelp, showCreateHashHelp, status_search

Methods inherited from class org.oa4mp.server.admin.oauth2.base.OA4MPStoreCommands

about, decode, encode, getEnvironment, getState, load, printIndexHelp, processList, run_qdl, setState

Methods inherited from class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

actualCreate, addEntry, addEntry, archive, bootstrap, change_id, clear_id, clear_store, clearEntries, copy, create, create, createEntry, deserialize, doCopy, edit, extractRawList, findByIDOrRS, findItem, findItem, findItem, findSingleton, findSingleton, formatCounter, formatLongLine, fromXMLMap, get_id, getAndCheckKeyArg, getArgList, getEditorEntry, getID, getIdentifierfromIndex, getKeyArg, getKeyArg, getKeys, getMapConverter, getMethodName, getPrompt, getResultSets, getSerializationKeys, getStore, getStoreArchiver, getTempDir, hasEntries, hasId, hasID, hasKey, inputJSON, isBadID, isMonitored, list_keys, loadAllEntries, loadQDLScript, longFormat, longFormat, ls, multiLineInput, multiLinePropertyInput, oldrm, oldUpdate, preCopy, preCreation, printLS, printRS, rangeHelpSnippet, removeEntries, removeEntry, rm, rs, search, serialize, serialize, set_id, setEnvironment, setID, setIDFromInputLine, setResultSets, setSortable, setStore, showArchiveHelp, showCommandLineSwitchesHelp, showCopyHelp, showCreateHelp, showEntry, showEntrySubset, showKeyShorthandHelp, showListKeysHelp, showLSHelp, showResultSetHelp, showRMHelp, showSearchHelp, showSearchHelpExamples, showSerializeHelp, showSizeHelp, showUpdateHelp, showUpkeepHelp, size, time, toXMLMap, update, update, update, updateSingleValue, updateSingleValue, upkeep

Methods inherited from class edu.uiuc.ncsa.security.util.cli.CommonCommands2

getIOInterface, getPlaceHolder, getValue, isEmpty, isThrowExceptions, isVerbose, say2, sayii, set_output_on, set_verbose_on, setOutputOnHelp, setPlaceHolder, setThrowExceptions, setVerboseHelp, version, versionHelp

Methods inherited from class edu.uiuc.ncsa.security.util.cli.AbstractCommandsImpl

bootstrap, clear_env, clearEnvHelp, configureCommands, debug, error, error, get_env, getDriver, getHelpUtil, getInput, getLogoName, getPropertyHelp, gracefulExit, hasLogger, indentWidth, info, isDebugOn, isOk, isShowHeader, isShowLogo, print_env, printEnvHelp, printGetEnvHelp, printReadEnvHelp, printSaveEnvHelp, printSetEnvHelp, read_env, readJSON, readline, readline, save_env, say, say, sayi, sayv, set_env, setDebugOn, setDriver, setLogoName, setShowHeader, setShowLogo, showHelp, warn

Methods inherited from class java.lang.Object

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

Field Detail

LINK_NEW_CLIENT_FLAG

public static String LINK_NEW_CLIENT_FLAG

LINK_RANDOM_CLIENT_ID_ARG

public static String LINK_RANDOM_CLIENT_ID_ARG

UNLINK_ALL_FLAG

public static final String UNLINK_ALL_FLAG

See Also:

Constant Field Values

UNLINK_REMOVE_FLAG

public static final String UNLINK_REMOVE_FLAG

See Also:

Constant Field Values

NO_VERIFY_ALL_FLAG

public static String NO_VERIFY_ALL_FLAG

APPROVAL_QDL_ENABLE

public static final String APPROVAL_QDL_ENABLE

See Also:

Constant Field Values

Constructor Detail

OA2AdminClientCommands

public OA2AdminClientCommands(edu.uiuc.ncsa.security.util.cli.CLIDriver driver,
                              String defaultIndent,
                              edu.uiuc.ncsa.security.core.Store adminClientStore,
                              ClientApprovalStoreCommands clientApprovalStoreCommands,
                              PermissionsStore permissionsStore,
                              ClientStore clientStore)
                       throws Throwable

Throws:

Throwable

Method Detail

initialize

public void initialize()
                throws Throwable

Overrides:

initialize in class OA4MPStoreCommands

Throws:

Throwable

getName

public String getName()

print_help

public void print_help()
                throws Exception

Overrides:

print_help in class BaseClientStoreCommands

Throws:

Exception

extraUpdates

public void extraUpdates(edu.uiuc.ncsa.security.core.Identifiable identifiable,
                         int magicNumber)
                  throws IOException

Overrides:

extraUpdates in class BaseClientStoreCommands

Throws:

IOException

showListClientsHelp

protected void showListClientsHelp()

list_clients

public void list_clients(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                  throws Throwable

Throws:

Throwable

showCountClientsHelp

protected void showCountClientsHelp()

count_clients

public void count_clients(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                   throws Throwable

Throws:

Throwable

showListAdminsHelp

protected void showListAdminsHelp()

list_admins

public void list_admins(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                 throws Throwable

Throws:

Throwable

showDeserializeHelp

protected void showDeserializeHelp()

Overrides:

showDeserializeHelp in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

link

public void link(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
          throws Throwable

Throws:

Throwable

unlinkRS

protected void unlinkRS(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)

unlink

public void unlink(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
            throws Throwable

Throws:

Throwable

list_provisioners

public void list_provisioners(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                       throws Throwable

Throws:

Throwable

list_ersatz

public void list_ersatz(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                 throws Throwable

Throws:

Throwable

set_ersatz

public void set_ersatz(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                throws Throwable

Throws:

Throwable

initHelp

public void initHelp()
              throws Throwable

Overrides:

initHelp in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

Throws:

Throwable

createApprovalModsConfig

protected BaseClientStoreCommands.ApprovalModsConfig createApprovalModsConfig(edu.uiuc.ncsa.security.util.cli.InputLine inputLine,
                                                                              BaseClient client,
                                                                              boolean doPrompt)

Specified by:

createApprovalModsConfig in class BaseClientStoreCommands

doApprovalMods

protected BaseClient doApprovalMods(BaseClientStoreCommands.ApprovalModsConfig approvalModsConfig)
                             throws IOException

Description copied from class: BaseClientStoreCommands

If there are modifications to the client before saving its approval (e.g. admin clients should be prompted for QDL policy) put it here.

Overrides:

doApprovalMods in class BaseClientStoreCommands

Returns:

Throws:

IOException

updateStorePermissions

protected int updateStorePermissions(edu.uiuc.ncsa.security.core.Identifier newID,
                                     edu.uiuc.ncsa.security.core.Identifier oldID,
                                     boolean copy)

Specified by:

updateStorePermissions in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2