Package edu.uiuc.ncsa.myproxy.oauth2.tools

Class OA2AdminClientCommands

java.lang.Object

edu.uiuc.ncsa.security.util.cli.CommonCommands

edu.uiuc.ncsa.security.storage.cli.StoreCommands

org.oa4mp.server.admin.base.oauth2.myproxy.StoreCommands2

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

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

All Implemented Interfaces:

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

public class OA2AdminClientCommands
extends BaseClientStoreCommands

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

Nested Class Summary

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

edu.uiuc.ncsa.security.storage.cli.StoreCommands.RSRecord

Field Summary

Fields

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

Fields inherited from class edu.uiuc.ncsa.myproxy.oauth2.base.BaseClientStoreCommands

clientApprovalStoreCommands, RESET_SECRET_DEFAULT_SIZE, RESET_SECRET_NEW_FLAG, RESET_SECRET_SIZE_FLAG

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

ALL_LIST_COMMAND, allEntries, DEFAULT_MAGIC_NUMBER, display_width, FILE_FLAG, FORCE_COPY_FLAG, KEY_SHORTHAND_PREFIX, LINE_LIST_COMMAND, NEXT_N_COMMAND, RANDOM_ID_FLAG, resultSets, RM_FORCE_FLAG, RS_CLEAR_KEY, RS_LIST_INFO_KEY, RS_REMOVE_KEY, RS_SHOW_KEY, SEARCH_AFTER_TS_FLAG, SEARCH_BEFORE_TS_FLAG, SEARCH_DATE_FLAG, SEARCH_DEBUG_FLAG, SEARCH_REGEX_FLAG, SEARCH_RESULT_SET_NAME, SEARCH_RETURNED_ATTRIBUTES_FLAG, SEARCH_SHORT_REGEX_FLAG, SEARCH_SIZE_FLAG, SHORT_UPDATE_FLAG, SIZE_ALL_FLAG, SIZE_VERSIONS_FLAG, sortable, 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.CommonCommands

BATCH_FILE_LINE_CONTINUES, BATCH_FILE_MODE_FLAG, BATCH_MODE_FLAG, batchFile, CL_INPUT_FILE_FLAG, CL_OUTPUT_FILE_FLAG, DEFAULT_NULL_VALUE_PLACEHOLDER, defaultIndent, INDENT, logger, placeHolder

Constructor Summary

Constructors

Constructor	Description
OA2AdminClientCommands(edu.uiuc.ncsa.security.core.util.MyLoggingFacade logger, String defaultIndent, edu.uiuc.ncsa.security.core.Store adminClientStore, ClientApprovalStoreCommands clientApprovalStoreCommands, org.oa4mp.server.api.permissions.admin.PermissionsStore permissionsStore, ClientStore clientStore)

Method Summary

Modifier and Type	Method	Description
protected BaseClient	approvalMods(edu.uiuc.ncsa.security.util.cli.InputLine inputLine, BaseClient client)	If there are modifications to the client before saving its approval (e.g.
void	bootstrap()
void	count_clients(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
void	extraUpdates(edu.uiuc.ncsa.security.core.Identifiable identifiable, int magicNumber)
String	getName()
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)

Methods inherited from class edu.uiuc.ncsa.myproxy.oauth2.base.BaseClientStoreCommands

approve, approve, approver_search, archiveFormat, create, create_hash, format, format, getClientApprovalStore, getPublicKeyFile, getSecret, getSortable, inputJSON, inputJSON, isCARS, listAll, longFormat, longFormat, password, reset_secret, rm, rmCleanup, rs, showApproveHelp, showCreateHashHelp, status_search

Methods inherited from class edu.uiuc.ncsa.myproxy.oauth2.base.StoreCommands2

decode, encode, getEnvironment, main

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

actualCreate, addEntry, addEntry, archive, clear_id, clear_store, clearEntries, copy, create, create, createEntry, createNew, deserialize, doCopy, doRename, edit, escapeRegex, findItem, formatLongLine, fromXMLMap, get_id, getAndCheckKeyArg, getArgList, getEditorEntry, getID, getKeyArg, getKeyArg, getMapConverter, getPrompt, getResultSets, getSerializationKeys, getStore, getStoreArchiver, getTempDir, hasEntries, hasId, hasID, hasKey, inputJSON, isMonitored, list_keys, loadAllEntries, loadQDLScript, longFormat, longFormat, ls, multiLineInput, multiLinePropertyInput, oldls, oldrm, oldUpdate, preCreation, printRS, removeEntries, removeEntry, rename, search, serialize, serialize, set_id, setEnvironment, setID, setIDFromInputLine, setResultSets, setSortable, setStore, showArchiveHelp, showCommandLineSwitchesHelp, showCreateHelp, showEntries, showEntry, showKeyShorthandHelp, showListKeysHelp, showLSHelp, showLSHelp3, showResultSetHelp, showRMHelp, showSearchHelp, showSearchHelpExamples, showSerializeHelp, showSizeHelp, showUpdateHelp, showUpkeepHelp, size, supportsQDL, toXMLMap, update, update, update, updateSingleValue, updateSingleValue, upkeep

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

clear_env, clearEnvHelp, debug, echo, echoHelp, error, get_env, getBufferedReader, getDriver, getHelpUtil, getInput, getIOInterface, getPlaceHolder, getPropertyHelp, getValue, gracefulExit, indentWidth, info, isBatch, isBatchFile, isBatchMode, isDebugOn, isEmpty, isOk, isPrintOuput, isVerbose, logit, print_env, printEnvHelp, printGetEnvHelp, printReadEnvHelp, printSaveEnvHelp, printSetEnvHelp, read_env, readFile, readJSON, readline, readline, save_env, say, say, say2, sayi, sayii, sayv, set_env, set_output_on, set_verbose_on, setBatchFile, setBatchMode, setBufferedReader, setDebugOn, setDriver, setHelpUtil, setIOInterface, setOutputOnHelp, setPlaceHolder, setPrintOuput, setVerbose, setVerboseHelp, showHelp, version, versionHelp, 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

Constructor Detail

OA2AdminClientCommands

public OA2AdminClientCommands(edu.uiuc.ncsa.security.core.util.MyLoggingFacade logger,
                              String defaultIndent,
                              edu.uiuc.ncsa.security.core.Store adminClientStore,
                              ClientApprovalStoreCommands clientApprovalStoreCommands,
                              org.oa4mp.server.api.permissions.admin.PermissionsStore permissionsStore,
                              ClientStore clientStore)
                       throws Throwable

Throws:

Throwable

Method Detail

getName

public String getName()

Specified by:

getName in class edu.uiuc.ncsa.security.storage.cli.StoreCommands

print_help

public void print_help()
                throws Exception

Specified by:

print_help in interface edu.uiuc.ncsa.security.util.cli.Commands

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 Exception

Throws:

Exception

showCountClientsHelp

protected void showCountClientsHelp()

count_clients

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

Throws:

Exception

showListAdminsHelp

protected void showListAdminsHelp()

list_admins

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

Throws:

Exception

showDeserializeHelp

protected void showDeserializeHelp()

Overrides:

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

link

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

unlinkRS

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

unlink

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

list_provisioners

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

Throws:

Exception

list_ersatz

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

Throws:

Exception

set_ersatz

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

Throws:

Exception

bootstrap

public void bootstrap()
               throws Throwable

Specified by:

bootstrap in interface edu.uiuc.ncsa.security.util.cli.Commands

Overrides:

bootstrap in class edu.uiuc.ncsa.security.storage.cli.StoreCommands

Throws:

Throwable

approvalMods

protected BaseClient approvalMods(edu.uiuc.ncsa.security.util.cli.InputLine inputLine,
                                  BaseClient client)
                           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:

approvalMods in class BaseClientStoreCommands

Returns:

Throws:

IOException