Class DummyPluginResource

  • All Implemented Interfaces:
    sailpoint.plugin.PluginContext, sailpoint.web.UserContext

    public class DummyPluginResource
    extends sailpoint.rest.plugin.BasePluginResource
    implements sailpoint.web.UserContext, sailpoint.plugin.PluginContext
    Creates a fake plugin context for use outside of a plugin.
    • Field Summary

      • Fields inherited from class sailpoint.rest.BaseListResource

        CALCULATED_COLUMN_PREFIX, colKey, exclude, excludedIds, filters, groupBy, limit, PARAM_COL_KEY, PARAM_DIR, PARAM_EXCLUDED_IDS, PARAM_GROUP_BY, PARAM_LIMIT, PARAM_QUERY, PARAM_SELECT_ALL, PARAM_SELECTED, PARAM_SORT, PARAM_START, query, selectAll, selectedIds, sortBy, sortDirection, STANDARD_PARAMS, start
      • Fields inherited from class sailpoint.rest.BaseResource

        authnPassword, authnUsername, headers, request, uriInfo
    • Constructor Summary

      Constructors 
      Constructor Description
      DummyPluginResource​(sailpoint.api.SailPointContext context, sailpoint.object.Identity loggedInUser, String pluginName)
      Constructs a new DummyPluginResource with the given auth data
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      sailpoint.api.SailPointContext getContext()  
      sailpoint.object.Identity getLoggedInUser()  
      List<sailpoint.object.Capability> getLoggedInUserCapabilities()  
      String getLoggedInUserName()  
      Collection<String> getLoggedInUserRights()  
      String getPluginName()  
      boolean getSettingBool​(String settingName)  
      int getSettingInt​(String settingName)  
      String getSettingString​(String settingName)  
      • Methods inherited from class sailpoint.rest.plugin.BasePluginResource

        authorize, getConnection, prepareStatement
      • Methods inherited from class sailpoint.rest.BaseListResource

        calculateColumn, calculateColumns, convertColumn, convertObject, convertObject, convertRow, convertRow, countResults, fixSortBy, getColKey, getColumnKey, getColumns, getExcludedIds, getFilters, getGroupBy, getLimit, getListResult, getListResultFromObjects, getListResultFromObjects, getOtherQueryParams, getProjectionColumns, getQuery, getQueryOptions, getQueryOptions, getRawResults, getResults, getSelectAll, getSelectedIds, getSelectionQuery, getSingleFormValue, getSortBy, getSortDirection, getSorters, getStart, handleOrdering, init, objectToMap, parseSorters, processForm, setColKey, setExcludedIds, setFilters, setGroupBy, setLimit, setQuery, setSelectAll, setSelectedIds, setSortBy, setSortDirection, setStart, trimAndSortResults
      • Methods inherited from class sailpoint.rest.BaseResource

        convertIdentity, createListResult, createListResult, decodeRestUriComponent, decodeRestUriComponent, fixCSV, getContext, getCredentials, getHandler, getHandler, getLocale, getLoggedInUserDynamicScopeNames, getMatchedUri, getNotary, getQueryParamMap, getRequest, getSession, getSignature, getSignatureAccountId, getUserTimeZone, isAuthorized, isMobileLogin, isObjectInUserScope, isObjectInUserScope, isPreAuth, isScopingEnabled, isSsoAuthenticated, localize, makeJsonSafeKeys, parseDateRange, reportDetailedLoginErrors, saveSignatureAccountId, setPreAuth, throwWebApplicationException
      • Methods inherited from interface sailpoint.plugin.PluginContext

        getConnection, getSettingLong, getSettingMultiObject, getSettingMultiString, getSettingObject, getSettingSecret
      • Methods inherited from interface sailpoint.web.UserContext

        getLocale, getLoggedInUserDynamicScopeNames, getUserTimeZone, isMobileLogin, isObjectInUserScope, isObjectInUserScope, isScopingEnabled
    • Constructor Detail

      • DummyPluginResource

        public DummyPluginResource​(sailpoint.api.SailPointContext context,
                                   sailpoint.object.Identity loggedInUser,
                                   String pluginName)
        Constructs a new DummyPluginResource with the given auth data
        Parameters:
        context - The SailPointContext to return from BaseResource.getContext()
        loggedInUser - The Identity to return from various getLoggedIn… methods
        pluginName - The name of the plugin
    • Method Detail

      • getContext

        public sailpoint.api.SailPointContext getContext()
        Specified by:
        getContext in interface sailpoint.web.UserContext
        Overrides:
        getContext in class sailpoint.rest.BaseResource
        See Also:
        BaseResource.getContext()
      • getLoggedInUser

        public sailpoint.object.Identity getLoggedInUser()
                                                  throws sailpoint.tools.GeneralException
        Specified by:
        getLoggedInUser in interface sailpoint.web.UserContext
        Overrides:
        getLoggedInUser in class sailpoint.rest.BaseResource
        Throws:
        sailpoint.tools.GeneralException
        See Also:
        BaseResource.getLoggedInUser()
      • getLoggedInUserCapabilities

        public List<sailpoint.object.Capability> getLoggedInUserCapabilities()
        Specified by:
        getLoggedInUserCapabilities in interface sailpoint.web.UserContext
        Overrides:
        getLoggedInUserCapabilities in class sailpoint.rest.BaseResource
        See Also:
        BaseResource.getLoggedInUserCapabilities()
      • getLoggedInUserName

        public String getLoggedInUserName()
                                   throws sailpoint.tools.GeneralException
        Specified by:
        getLoggedInUserName in interface sailpoint.web.UserContext
        Overrides:
        getLoggedInUserName in class sailpoint.rest.BaseResource
        Throws:
        sailpoint.tools.GeneralException
        See Also:
        BaseResource.getLoggedInUserName()
      • getLoggedInUserRights

        public Collection<StringgetLoggedInUserRights()
        Specified by:
        getLoggedInUserRights in interface sailpoint.web.UserContext
        Overrides:
        getLoggedInUserRights in class sailpoint.rest.BaseResource
        See Also:
        BaseResource.getLoggedInUserRights()
      • getPluginName

        public String getPluginName()
        Specified by:
        getPluginName in interface sailpoint.plugin.PluginContext
        Specified by:
        getPluginName in class sailpoint.rest.plugin.BasePluginResource
        See Also:
        BasePluginResource.getPluginName()
      • getSettingBool

        public boolean getSettingBool​(String settingName)
        Specified by:
        getSettingBool in interface sailpoint.plugin.PluginContext
        See Also:
        PluginContext.getSettingBool(String)
      • getSettingInt

        public int getSettingInt​(String settingName)
        Specified by:
        getSettingInt in interface sailpoint.plugin.PluginContext
        See Also:
        PluginContext.getSettingInt(String)
      • getSettingString

        public String getSettingString​(String settingName)
        Specified by:
        getSettingString in interface sailpoint.plugin.PluginContext
        See Also:
        PluginContext.getSettingString(String)