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

Class ClientApprovalStoreCommands

  • All Implemented Interfaces:
    edu.uiuc.ncsa.security.core.Logable, edu.uiuc.ncsa.security.util.cli.Commands, Serializable
    public class ClientApprovalStoreCommands
extends OA4MPStoreCommands

    Created by Jeff Gaynor
    on 5/22/13 at 1:51 PM

    See Also:
    Serialized Form

    • Nested Class Summary

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

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String SHOW_UNAPPROVED_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, 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.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
      ClientApprovalStoreCommands​(edu.uiuc.ncsa.security.core.util.MyLoggingFacade logger, edu.uiuc.ncsa.security.core.Store store)  
      ClientApprovalStoreCommands​(edu.uiuc.ncsa.security.core.util.MyLoggingFacade logger, String defaultIndent, edu.uiuc.ncsa.security.core.Store store)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void approve​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)  
      boolean approve​(ClientApproval ca)  
      protected boolean approve​(ClientApproval ca, boolean isapproved, String approver)  
      void bootstrap()  
      void change_id​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)  
      protected String format​(edu.uiuc.ncsa.security.core.Identifiable identifiable)  
      String getName()  
      void set_status​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)  
      static void setupApprovalRecord​(ClientApproval ca, boolean isapproved, String approver)
      Does the work of setting the approval status, approver etc.
      static ClientApproval setupApprovalRecord​(ClientApprovalStore caStore, edu.uiuc.ncsa.security.core.Identifier identifier, boolean isapproved, String approver)
      For thoses cases where the record needs to me fetched or created then set to the right values.
      protected void show​(boolean showApproved, String regex)  
      void show​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)  
      void showApproveHelp()  
      boolean update​(edu.uiuc.ncsa.security.core.Identifiable identifiable)  
      protected int updateStorePermissions​(edu.uiuc.ncsa.security.core.Identifier newID, edu.uiuc.ncsa.security.core.Identifier oldID, boolean copy)  

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

        actualCreate, addEntry, addEntry, archive, archiveFormat, clear_id, clear_store, clearEntries, copy, create, create, create, createEntry, deserialize, doChangeID, 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, 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, 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

    • Constructor Detail

      • ClientApprovalStoreCommands

        public ClientApprovalStoreCommands​(edu.uiuc.ncsa.security.core.util.MyLoggingFacade logger,
                                   String defaultIndent,
                                   edu.uiuc.ncsa.security.core.Store store)
                            throws Throwable
        Throws:
        Throwable

      • ClientApprovalStoreCommands

        public ClientApprovalStoreCommands​(edu.uiuc.ncsa.security.core.util.MyLoggingFacade logger,
                                   edu.uiuc.ncsa.security.core.Store store)
                            throws Throwable
        Throws:
        Throwable

    • Method Detail

      • format

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

      • getName

        public String getName()

      • update

        public boolean update​(edu.uiuc.ncsa.security.core.Identifiable identifiable)
               throws IOException
        Overrides:
        update in class edu.uiuc.ncsa.security.storage.cli.StoreCommands
        Throws:
        IOException

      • showApproveHelp

        public void showApproveHelp()

      • approve

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

      • set_status

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

      • setupApprovalRecord

        public static ClientApproval setupApprovalRecord​(ClientApprovalStore caStore,
                                                 edu.uiuc.ncsa.security.core.Identifier identifier,
                                                 boolean isapproved,
                                                 String approver)
                                          throws IOException
        For thoses cases where the record needs to me fetched or created then set to the right values. This and setupApprovalRecord(ClientApproval, boolean, String) are called in this class and are exposed as static methods to be called by other classes to central approvals. This does do the save of this record since it has the logic to invoke Store.update(Identifiable) versus Store.save(Identifiable)
        Parameters:
        identifier -
        isapproved -
        approver -
        Throws:
        IOException

      • setupApprovalRecord

        public static void setupApprovalRecord​(ClientApproval ca,
                                       boolean isapproved,
                                       String approver)
        Does the work of setting the approval status, approver etc. Does not save it.
        Parameters:
        ca -
        isapproved -
        approver -

      • show

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

      • 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.StoreCommands
        Throws:
        Throwable

      • 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.StoreCommands