org.gluu.credmanager.ui.vm.admin.PluginViewModel クラス

org.gluu.credmanager.ui.vm.admin.PluginViewModel の継承関係図

org.gluu.credmanager.ui.vm.admin.PluginViewModel 連携図

公開メンバ関数
List< PluginData >	getPluginList ()
PluginData	getPluginToShow ()
boolean	isUiAdding ()
void	init ()
void	showPlugin (@BindingParam("id") String pluginId)
void	hidePluginDetails ()
void	uploaded (@BindingParam("uplEvent") UploadEvent evt)
void	deletePlugin (@BindingParam("id") String pluginId, @BindingParam("provider") String provider)
void	addPlugin ()
void	cancelAdd ()
void	startPlugin (@BindingParam("id") String pluginId)
void	stopPlugin (@BindingParam("id") String pluginId)
String	getSubpage ()
List< AdminConsoleMenuItem >	getExtraButtons ()
void	loadSubPage (@BindingParam("page") String page)
MainSettings	getSettings ()

関数
boolean	updateMainSettings (String sucessMessage)
boolean	updateMainSettings ()

非公開メンバ関数
void	reloadPluginList ()
PluginData	buildPluginData (PluginWrapper pw)
List< String >	buildExtensionList (PluginWrapper wrapper)
String	getExtensionLabel (String clsName, Object ...args)
Path	getPluginDestinationPath (String fileName)

非公開変数類
Logger	logger = LoggerFactory.getLogger(getClass())
ExtensionsManager	extManager
List< PluginData >	pluginList
PluginData	pluginToShow
boolean	uiAdding

静的非公開変数類
static final Class< AuthnMethod >	AUTHN_METHOD = AuthnMethod.class

詳解

著者

jgomer

関数詳解

addPlugin()

void org.gluu.credmanager.ui.vm.admin.PluginViewModel.addPlugin ( )

inline

                            {
        String id = pluginToShow.getDescriptor().getPluginId();
        boolean success = extManager.startPlugin(id);

        if (success) {
            String started = PluginState.STARTED.toString();
            pluginToShow.setState(Labels.getLabel("adm.plugins_state." + started));
            pluginList.add(pluginToShow);

            //Update backend config file
            PluginInfo info = new PluginInfo();
            info.setId(id);
            info.setRelativePath(Paths.get(pluginToShow.getPath()).getFileName().toString());
            info.setState(started);

            List<PluginInfo> list = Optional.ofNullable(getSettings().getKnownPlugins()).orElse(new ArrayList<>());
            list.add(info);

            getSettings().setKnownPlugins(list);
            updateMainSettings();
            hidePluginDetails();
        } else {
            UIUtils.showMessageUI(false);
        }

    }

buildExtensionList()

List<String> org.gluu.credmanager.ui.vm.admin.PluginViewModel.buildExtensionList ( PluginWrapper  wrapper )

inlineprivate

                                                                   {

        List<String> extList = new ArrayList<>();
        PluginManager manager = wrapper.getPluginManager();
        String pluginId = wrapper.getPluginId();

        for (String clsName : manager.getExtensionClassNames(pluginId)) {
            if (!clsName.equals(AUTHN_METHOD.getName())) {
                extList.add(getExtensionLabel(clsName));
            }
        }
        for (AuthnMethod method : manager.getExtensions(AUTHN_METHOD, pluginId)) {
            String text = getExtensionLabel(AUTHN_METHOD.getName(), Labels.getLabel(method.getUINameKey()));
            String acr = method.getAcr();

            if (Optional.ofNullable(getSettings().getAcrPluginMap())
                    .map(mapping -> mapping.get(acr).equals(pluginId)).orElse(false)) {
                text += Labels.getLabel("adm.plugins_acr_handler", new String[]{ acr });
            }
            extList.add(text);
        }

        return extList;

    }

buildPluginData()

PluginData org.gluu.credmanager.ui.vm.admin.PluginViewModel.buildPluginData ( PluginWrapper  pw )

inlineprivate

                                                         {

        PluginDescriptor pluginDescriptor = pw.getDescriptor();
        PluginData pl = new PluginData();

        //In practice resolved (that is, just loaded not started) could be seen as stopped
        String state = (pw.getPluginState().equals(PluginState.RESOLVED) ? PluginState.STOPPED : pw.getPluginState()).toString();

        pl.setState(Labels.getLabel("adm.plugins_state." + state));
        pl.setExtensions(buildExtensionList(pw));
        pl.setPath(pw.getPluginPath().toString());
        pl.setDescriptor(pluginDescriptor);

        return pl;

    }

cancelAdd()

void org.gluu.credmanager.ui.vm.admin.PluginViewModel.cancelAdd ( )

inline

                            {

        String plugId = pluginToShow.getDescriptor().getPluginId();
        hidePluginDetails();
        if (!extManager.unloadPlugin(plugId)) {
            UIUtils.showMessageUI(false, Labels.getLabel("adm.plugins_error_unloaded"));
        }
        /*
        //IMPORTANT: See note at method getPluginDestinationPath
        try {
            String path = pluginToShow.getPath();
            Files.delete(Paths.get(path));
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
            String message = Labels.getLabel("adm.plugins_error_delete", new String[] { path });
            Messagebox.show(message, Labels.getLabel("general.warning"), Messagebox.OK, Messagebox.INFORMATION);
        }
        */

    }

deletePlugin()

void org.gluu.credmanager.ui.vm.admin.PluginViewModel.deletePlugin ( @BindingParam("id") String  pluginId, @BindingParam("provider") String  provider  )

inline

                                                                                                             {

        provider = Utils.isEmpty(provider) ? Labels.getLabel("adm.plugins_nodata") : provider;
        String msg = Labels.getLabel("adm.plugins_confirm_del", new String[] {pluginId, provider});

        Messagebox.show(msg, null, Messagebox.YES | Messagebox.NO, Messagebox.QUESTION,
                event -> {
                    if (Messagebox.ON_YES.equals(event.getName())) {
                        boolean success = extManager.unloadPlugin(pluginId);
                        //boolean success = extManager.deletePlugin(pluginId);    //IMPORTANT: See note at method getPluginDestinationPath
                        if (success) {
                            PluginData pluginData = pluginList.stream()
                                    .filter(pl -> pl.getDescriptor().getPluginId().equals(pluginId)).findAny().get();
                            pluginList.remove(pluginData);

                            PluginInfo pl = getSettings().getKnownPlugins().stream().filter(apl -> apl.getId().equals(pluginId)).findAny().get();
                            getSettings().getKnownPlugins().remove(pl);
                            updateMainSettings();
                            BindUtils.postNotifyChange(null, null, PluginViewModel.this, "pluginList");
                        } else {
                            UIUtils.showMessageUI(false);
                        }
                        hidePluginDetails();
                        BindUtils.postNotifyChange(null, null, PluginViewModel.this, "pluginToShow");
                        BindUtils.postNotifyChange(null, null, PluginViewModel.this, "uiAdding");
                    }
                }
        );
    }

getExtensionLabel()

String org.gluu.credmanager.ui.vm.admin.PluginViewModel.getExtensionLabel ( String  clsName, Object ...  args  )

inlineprivate

                                                                     {
        String text = Labels.getLabel("adm.plugins_extension." + clsName, args);
        return text == null ? clsName.substring(clsName.lastIndexOf(".") + 1) : text;
    }

getExtraButtons()

List<AdminConsoleMenuItem> org.gluu.credmanager.ui.vm.admin.MainViewModel.getExtraButtons ( )

inlineinherited

                                                        {
        return extraButtons;
    }

getPluginDestinationPath()

Path org.gluu.credmanager.ui.vm.admin.PluginViewModel.getPluginDestinationPath ( String  fileName )

inlineprivate

                                                           {
        /*
        Add some "random" suffix since the same file can be uploaded multiples because as it's explained at
        https://github.com/pf4j/pf4j/issues/217 there is no effective means to delete a plugin jar file
        */
        String suffix = Long.toString(System.currentTimeMillis());
        int aux = suffix.length();
        suffix = "_" +  suffix.substring(aux - 5, aux);

        aux = fileName.lastIndexOf(".");
        aux = aux == -1 ? fileName.length() : aux;
        fileName = fileName.substring(0, aux) + suffix + ".jar";
        return Paths.get(extManager.getPluginsRoot().toString(), fileName);

    }

getPluginList()

List<PluginData> org.gluu.credmanager.ui.vm.admin.PluginViewModel.getPluginList ( )

inline

                                            {
        return pluginList;
    }

getPluginToShow()

PluginData org.gluu.credmanager.ui.vm.admin.PluginViewModel.getPluginToShow ( )

inline

                                        {
        return pluginToShow;
    }

getSettings()

MainSettings org.gluu.credmanager.ui.vm.admin.MainViewModel.getSettings ( )

inlineinherited

                                      {
        return confHandler.getSettings();
    }

getSubpage()

String org.gluu.credmanager.ui.vm.admin.MainViewModel.getSubpage ( )

inlineinherited

                               {
        return subpage;
    }

hidePluginDetails()

void org.gluu.credmanager.ui.vm.admin.PluginViewModel.hidePluginDetails ( )

inline

                                    {
        pluginToShow = null;
        uiAdding = false;
    }

init()

void org.gluu.credmanager.ui.vm.admin.PluginViewModel.init ( )

inline

                       {
        reloadPluginList();
    }

isUiAdding()

boolean org.gluu.credmanager.ui.vm.admin.PluginViewModel.isUiAdding ( )

inline

                                {
        return uiAdding;
    }

loadSubPage()

void org.gluu.credmanager.ui.vm.admin.MainViewModel.loadSubPage ( @BindingParam("page") String  page )

inlineinherited

Changes the page loaded in the content area. Also sets values needed in the UI (these are taken directly from calls to AdminService's getConfigSettings method.

引数

page	The (string) url of the page that must be loaded (by default /admin/default.zul is being shown)

                                                               {
        subpage = page;
    }

reloadPluginList()

void org.gluu.credmanager.ui.vm.admin.PluginViewModel.reloadPluginList ( )

inlineprivate

                                    {
        //a grid row might look like this: id version (details), state, implements + buttons to stop
        pluginList = new ArrayList<>();
        //extManager.getPlugins().stream().forEach(w -> logger.debug("Found {} {} ",w.getPluginId(), w.getPluginState().toString()));
        extManager.getPlugins().forEach(wrapper -> pluginList.add(buildPluginData(wrapper)));
    }

showPlugin()

void org.gluu.credmanager.ui.vm.admin.PluginViewModel.showPlugin ( @BindingParam("id") String  pluginId )

inline

                                                                {
        pluginToShow = pluginList.stream().filter(pl -> pl.getDescriptor().getPluginId().equals(pluginId)).findAny().orElse(null);
        uiAdding = false;
    }

startPlugin()

void org.gluu.credmanager.ui.vm.admin.PluginViewModel.startPlugin ( @BindingParam("id") String  pluginId )

inline

                                                                 {

        boolean success = extManager.startPlugin(pluginId);
        if (success) {
            String started = PluginState.STARTED.toString();
            PluginData pluginData = pluginList.stream().filter(pl -> pl.getDescriptor().getPluginId().equals(pluginId))
                    .findAny().get();
            pluginData.setState(Labels.getLabel("adm.plugins_state." + started));

            PluginInfo pl = getSettings().getKnownPlugins().stream().filter(apl -> apl.getId().equals(pluginId)).findAny().get();
            pl.setState(started);
            updateMainSettings();
        } else {
            UIUtils.showMessageUI(false);
        }
        hidePluginDetails();

    }

stopPlugin()

void org.gluu.credmanager.ui.vm.admin.PluginViewModel.stopPlugin ( @BindingParam("id") String  pluginId )

inline

                                                                {

        if (getSettings().getAcrPluginMap().values().contains(pluginId)) {
            Messagebox.show(Labels.getLabel("adm.plugin_plugin_bound_method"), null, Messagebox.OK, Messagebox.EXCLAMATION);
        } else {
            boolean success = extManager.stopPlugin(pluginId);
            if (success) {
                String stopped = PluginState.STOPPED.toString();
                PluginData pluginData = pluginList.stream().filter(pl -> pl.getDescriptor().getPluginId().equals(pluginId))
                        .findAny().get();
                pluginData.setState(Labels.getLabel("adm.plugins_state." + stopped));

                PluginInfo pl = getSettings().getKnownPlugins().stream().filter(apl -> apl.getId().equals(pluginId)).findAny().get();
                pl.setState(stopped);
                updateMainSettings();
            } else {
                UIUtils.showMessageUI(false);
            }
        }
        hidePluginDetails();

    }

updateMainSettings() [1/2]

boolean org.gluu.credmanager.ui.vm.admin.MainViewModel.updateMainSettings ( String  sucessMessage )

inlinepackageinherited

                                                     {

        boolean success = false;
        try {
            //update app-level config and persist
            getSettings().save();
            if (sucessMessage == null) {
                UIUtils.showMessageUI(true);
            } else {
                Messagebox.show(sucessMessage, null, Messagebox.OK, Messagebox.INFORMATION);
            }
            success = true;
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
            UIUtils.showMessageUI(false, Labels.getLabel("adm.conffile_error_update"));
        }
        return success;

    }

updateMainSettings() [2/2]

boolean org.gluu.credmanager.ui.vm.admin.MainViewModel.updateMainSettings ( )

inlinepackageinherited

                                 {
        return updateMainSettings(null);
    }

uploaded()

void org.gluu.credmanager.ui.vm.admin.PluginViewModel.uploaded ( @BindingParam("uplEvent") UploadEvent  evt )

inline

                                                                    {
        try {
            pluginToShow = null;
            byte[] blob = evt.getMedia().getByteData();
            logger.debug("Size of blob received: {} bytes", blob.length);

            try (JarInputStream jis = new JarInputStream(new ByteArrayInputStream(blob), false)) {

                Manifest m = jis.getManifest();
                if (m != null) {
                    String id = m.getMainAttributes().getValue("Plugin-Id");
                    String version = m.getMainAttributes().getValue("Plugin-Version");

                    if (pluginList.stream().anyMatch(pl -> pl.getDescriptor().getPluginId().equals(id))) {
                        UIUtils.showMessageUI(false, Labels.getLabel("adm.plugins_already_existing", new String[] { id }));
                    } else if (Stream.of(id, version).allMatch(Utils::isNotEmpty)) {
                        //Copy the jar to plugins dir
                        try {
                            Path path = Files.write(getPluginDestinationPath(evt.getMedia().getName()), blob, StandardOpenOption.CREATE_NEW);
                            String pluginId = extManager.loadPlugin(path);

                            if (pluginId == null) {
                                logger.warn("Loading plugin from {} returned no pluginId.", path.toString());
                                //Files.delete(path); //IMPORTANT: See note at method getPluginDestinationPath
                                UIUtils.showMessageUI(false);
                            } else {
                                Optional<PluginWrapper> owrp = extManager.getPlugins().stream()
                                        .filter(wrapper -> wrapper.getPluginId().equals(pluginId)).findAny();
                                if (owrp.isPresent()) {
                                    pluginToShow = buildPluginData(owrp.get());
                                    uiAdding = true;
                                } else {
                                    UIUtils.showMessageUI(false);
                                }
                            }
                        } catch (Exception e) {
                            logger.error(e.getMessage(), e);
                            UIUtils.showMessageUI(false);
                        }
                    } else {
                        UIUtils.showMessageUI(false, Labels.getLabel("adm.plugins_invalid_plugin"));
                    }

                } else {
                    UIUtils.showMessageUI(false, Labels.getLabel("adm.plugins_invalid_plugin"));
                }
            }
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
    }

メンバ詳解

AUTHN_METHOD

final Class<AuthnMethod> org.gluu.credmanager.ui.vm.admin.PluginViewModel.AUTHN_METHOD = AuthnMethod.class

staticprivate

extManager

ExtensionsManager org.gluu.credmanager.ui.vm.admin.PluginViewModel.extManager

private

logger

Logger org.gluu.credmanager.ui.vm.admin.PluginViewModel.logger = LoggerFactory.getLogger(getClass())

private

pluginList

List<PluginData> org.gluu.credmanager.ui.vm.admin.PluginViewModel.pluginList

private

pluginToShow

PluginData org.gluu.credmanager.ui.vm.admin.PluginViewModel.pluginToShow

private

uiAdding

boolean org.gluu.credmanager.ui.vm.admin.PluginViewModel.uiAdding

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/cred-manager/app/src/main/java/org/gluu/credmanager/ui/vm/admin/PluginViewModel.java