Package org.cilogon.oauth2.admin

Class UserStoreCommands

  • All Implemented Interfaces:
    edu.uiuc.ncsa.security.core.Logable, edu.uiuc.ncsa.security.util.cli.Commands, Serializable
    public class UserStoreCommands
extends org.oa4mp.server.admin.oauth2.base.OA4MPStoreCommands

    Created by Jeff Gaynor
    on 5/23/13 at 9:47 AM

    See Also:
    Serialized Form

    • Nested Class Summary

      • 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 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, SIZE_ALL_FLAG, SIZE_VERSIONS_FLAG, SKIP_UPDATE_PERMISSIONS_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.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
      UserStoreCommands​(edu.uiuc.ncsa.security.util.cli.CLIDriver driver, String defaultIndent, edu.uiuc.ncsa.security.core.Store userStore, ArchivedUserStore archivedUserStore)  
      UserStoreCommands​(edu.uiuc.ncsa.security.util.cli.CLIDriver driver, UserStore userStore)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void archiveUser​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)  
      void change_id​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)  
      protected User createEntry​(int magicNumber)  
      void dn​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)  
      edu.uiuc.ncsa.security.storage.cli.StoreCommands2.ChangeIDRecord doChangeID​(edu.uiuc.ncsa.security.core.Identifiable updatedUser, edu.uiuc.ncsa.security.core.Identifier newID, boolean updatePermissions)
      This will update any current transactions to the new user id.
      void extraUpdates​(edu.uiuc.ncsa.security.core.Identifiable identifiable, int magicNumber)  
      protected String format​(edu.uiuc.ncsa.security.core.Identifiable identifiable)  
      ArchivedUserStore getArchivedUserStore()  
      protected void getEPPN​(User user)  
      protected void getEPTID​(User user)  
      String getName()  
      protected void getOpenID​(User user)  
      protected void getOpenIDConnect​(User user)  
      protected String getPersonPrompt​(String prompt, PersonName person)  
      protected void getRemoteUser​(User user)  
      protected UserStore getUserStore()  
      void initHelp()  
      protected int longFormat​(edu.uiuc.ncsa.security.core.Identifiable identifiable, boolean isVerbose)  
      void setArchivedUserStore​(ArchivedUserStore archivedUserStore)  
      protected void showArchiveUserHelp()  
      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.OA4MPStoreCommands

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

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

        actualCreate, addEntry, addEntry, archive, archiveFormat, bootstrap, clear_id, clear_store, clearEntries, copy, create, create, create, deserialize, doCopy, edit, extractRawList, findByIDOrRS, findItem, findItem, findItem, findSingleton, findSingleton, formatLongLine, fromXMLMap, get_id, getAndCheckKeyArg, getArgList, getEditorEntry, getID, getIdentifierfromIndex, getKeyArg, getKeyArg, getKeys, getMapConverter, getPrompt, getResultSets, getSerializationKeys, getSortable, getStore, getStoreArchiver, getTempDir, hasEntries, hasId, hasID, hasKey, inputJSON, isBadID, isMonitored, list_keys, listEntries, loadAllEntries, loadQDLScript, longFormat, longFormat, ls, multiLineInput, multiLinePropertyInput, oldls1, oldrm, oldUpdate, preCreation, print_help, printRS, rangeHelpSnippet, removeEntries, removeEntry, rm, rmCleanup, rs, search, serialize, serialize, set_id, setEnvironment, setID, setIDFromInputLine, setResultSets, setSortable, setStore, showArchiveHelp, showCommandLineSwitchesHelp, showCreateHelp, showDeserializeHelp, showEntry, showEntrySubset, showKeyShorthandHelp, showListKeysHelp, showLSHelp, showLSHelp3, showResultSetHelp, showRMHelp, showSearchHelp, showSearchHelpExamples, showSerializeHelp, showSizeHelp, showUpdateHelp, showUpkeepHelp, size, 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

    • Constructor Detail

      • UserStoreCommands

        public UserStoreCommands​(edu.uiuc.ncsa.security.util.cli.CLIDriver driver,
                         String defaultIndent,
                         edu.uiuc.ncsa.security.core.Store userStore,
                         ArchivedUserStore archivedUserStore)
                  throws Throwable
        Throws:
        Throwable

      • UserStoreCommands

        public UserStoreCommands​(edu.uiuc.ncsa.security.util.cli.CLIDriver driver,
                         UserStore userStore)
                  throws Throwable
        Throws:
        Throwable

    • Method Detail

      • getUserStore

        protected UserStore getUserStore()

      • setArchivedUserStore

        public void setArchivedUserStore​(ArchivedUserStore archivedUserStore)

      • createEntry

        protected User createEntry​(int magicNumber)
        Overrides:
        createEntry in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

      • format

        protected String format​(edu.uiuc.ncsa.security.core.Identifiable identifiable)
        Specified by:
        format in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

      • getName

        public String getName()

      • showArchiveUserHelp

        protected void showArchiveUserHelp()

      • archiveUser

        public void archiveUser​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                 throws Throwable
        Throws:
        Throwable

      • extraUpdates

        public void extraUpdates​(edu.uiuc.ncsa.security.core.Identifiable identifiable,
                         int magicNumber)
                  throws IOException
        Overrides:
        extraUpdates in class org.oa4mp.server.admin.oauth2.base.OA4MPStoreCommands
        Throws:
        IOException

      • longFormat

        protected int longFormat​(edu.uiuc.ncsa.security.core.Identifiable identifiable,
                         boolean isVerbose)
        Overrides:
        longFormat in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2

      • dn

        public void dn​(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

      • change_id

        public void change_id​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
               throws Throwable
        Overrides:
        change_id in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2
        Throws:
        Throwable

      • doChangeID

        public edu.uiuc.ncsa.security.storage.cli.StoreCommands2.ChangeIDRecord doChangeID​(edu.uiuc.ncsa.security.core.Identifiable updatedUser,
                                                                                   edu.uiuc.ncsa.security.core.Identifier newID,
                                                                                   boolean updatePermissions)
        This will update any current transactions to the new user id.
        Overrides:
        doChangeID in class edu.uiuc.ncsa.security.storage.cli.StoreCommands2
        Parameters:
        updatedUser -
        newID -
        updatePermissions -
        Returns:

      • 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