org.gluu.credmanager.service.AuthnScriptsReloader クラス

org.gluu.credmanager.service.AuthnScriptsReloader の継承関係図

org.gluu.credmanager.service.AuthnScriptsReloader 連携図

公開メンバ関数
void	init ()
String	getName ()
void	jobToBeExecuted (JobExecutionContext context)

静的公開変数類
static final String	LOCATION_TYPE_PROPERTY = "location_type"
static final String	LOCATION_PATH_PROPERTY = "location_path"

非公開メンバ関数
void	inited ()
oxCustomScript	getScript (String acr)
void	copyToLibsDir (oxCustomScript script)
byte []	getScriptContents (oxCustomScript script)
Map< String, String >	modulePropertyMap (oxCustomScript script)

非公開変数類
Logger	logger
TimerService	timerService
ConfigurationHandler	confHandler
LdapService	ldapService
ExtensionsManager	extManager
String	scriptsJobName
Map< String, Integer >	scriptHashes
String	pythonLibLocation
ObjectMapper	mapper

静的非公開変数類
static final int	SCAN_INTERVAL = 45
static final String	FILENAME_TEMPLATE = "cred-manager-external_{0}.py"

詳解

著者

jgomer

関数詳解

copyToLibsDir()

void org.gluu.credmanager.service.AuthnScriptsReloader.copyToLibsDir ( oxCustomScript  script )

inlineprivate

                                                      {

        try {
            String acr = script.getDisplayName();
            byte[] contents = getScriptContents(script);
            if (contents != null) {
                Path destPath = Paths.get(pythonLibLocation, MessageFormat.format(FILENAME_TEMPLATE, acr));
                Files.write(destPath, contents);
                logger.trace("The script for acr '{}' has been copied to {}", acr, destPath.toString());
            } else {
                logger.warn("The script for acr '{}' was not copied to jython's lib path", acr);
            }
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }

    }

getName()

String org.gluu.credmanager.service.AuthnScriptsReloader.getName ( )

inline

                            {
        return scriptsJobName;
    }

getScript()

oxCustomScript org.gluu.credmanager.service.AuthnScriptsReloader.getScript ( String  acr )

inlineprivate

                                                 {

        oxCustomScript script = new oxCustomScript();
        script.setDisplayName(acr);
        List<oxCustomScript> scripts = ldapService.find(script, oxCustomScript.class, ldapService.getCustomScriptsDn());
        return  scripts.size() == 0 ? null : scripts.get(0);

    }

getScriptContents()

byte [] org.gluu.credmanager.service.AuthnScriptsReloader.getScriptContents ( oxCustomScript  script )

inlineprivate

                                                            {

        byte[] bytes = null;
        String acr = script.getDisplayName();
        try {
            Map<String, String> moduleProperties = modulePropertyMap(script);
            ScriptLocationType locType = ScriptLocationType.getByValue(moduleProperties.get(LOCATION_TYPE_PROPERTY));

            switch (locType) {
                case FILE:
                    bytes = Files.readAllBytes(Paths.get(moduleProperties.get(LOCATION_PATH_PROPERTY)));
                    break;
                case LDAP:
                    bytes = script.getScript().getBytes(Charset.forName("utf-8"));
                    break;
                default:
                    logger.warn("getScriptContents. Unknown 'location_type' value for script '{}'", acr);
            }
        } catch (Exception e) {
            logger.error("getScriptContents. There was an error reading the bytes of script '{}': {}", acr, e.getMessage());
        }
        return bytes;

    }

init()

void org.gluu.credmanager.service.AuthnScriptsReloader.init ( )

inline

                       {
        try {
            timerService.addListener(this, scriptsJobName);
            //Start in 2 seconds and repeat indefinitely
            timerService.schedule(scriptsJobName, 2, -1, SCAN_INTERVAL);
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
    }

inited()

void org.gluu.credmanager.service.AuthnScriptsReloader.inited ( )

inlineprivate

                          {
        scriptsJobName = getClass().getSimpleName() + "_scripts";
        scriptHashes = new HashMap<>();
        mapper = new ObjectMapper();

        //Inside chroot the env variable is not set... why?. TODO: really?
        //the following works fine in both windows dev environment, and linux VMs
        pythonLibLocation = Optional.ofNullable(System.getenv("PYTHON_HOME")).orElse("/opt/gluu/python");
        pythonLibLocation += File.separator + "lib";
        logger.info("Using {} as jython's lib path", pythonLibLocation);
    }

jobToBeExecuted()

void org.gluu.credmanager.service.AuthnScriptsReloader.jobToBeExecuted ( JobExecutionContext  context )

inline

                                                             {

        Integer prevHash, currHash;
        oxCustomScript script;

        boolean anyChanged = false;
        Set<String> acrs = confHandler.getEnabledAcrs();

        logger.info("AuthnScriptsReloader. Running timer job for acrs: {}", acrs.toString());
        for (String acr : acrs) {
            script = getScript(acr);

            if (script != null) {
                prevHash = scriptHashes.get(acr);
                currHash = script.hashCode();
                scriptHashes.put(acr, currHash);

                if (prevHash == null || !prevHash.equals(currHash)) {
                    //the script changed... Out-of-the-box methods' scripts must not be copied
                    if (!ConfigurationHandler.DEFAULT_SUPPORTED_METHODS.contains(acr)) {
                        copyToLibsDir(script);
                    }
                    //Force extension reloading (normally to re-read configuration properties)
                    extManager.getExtensionForAcr(acr).ifPresent(AuthnMethod::reloadConfiguration);
                    anyChanged = true;
                }
            }
        }

        if (anyChanged) {
            //"touch" main script so that it gets reloaded as well
            try {
                logger.info("Touching main interception script to trigger reload by oxAuth...");
                script = getScript(ConfigurationHandler.DEFAULT_ACR);
                Map<String, String> moduleProperties = modulePropertyMap(script);
                ScriptLocationType locType = ScriptLocationType.getByValue(moduleProperties.get(LOCATION_TYPE_PROPERTY));

                switch (locType) {
                    case FILE:
                        File f = Paths.get(moduleProperties.get(LOCATION_PATH_PROPERTY)).toFile();
                        if (f.setLastModified(System.currentTimeMillis())) {
                            logger.debug("Last modified timestamp of \"{}\" has been updated", f.getPath());
                        }
                        break;
                    case LDAP:
                        Long rev = Long.valueOf(script.getRevision());
                        rev = rev == Long.MAX_VALUE ? 0 : rev;
                        script.setRevision(Long.toString(rev + 1));
                        if (ldapService.modify(script, oxCustomScript.class)) {
                            logger.debug("oxRevision updated for script '{}'", script.getDisplayName());
                        }
                        break;
                    default:
                        //Added to pass checkstyle
                }
            } catch (Exception e) {
                logger.error(e.getMessage(), e);
                logger.warn("Main custom script could not be touched!");
                logger.info("Recent changes in dependant scripts won't take effect until a new successful reload of script succeeds");
            }
        }

    }

modulePropertyMap()

Map<String, String> org.gluu.credmanager.service.AuthnScriptsReloader.modulePropertyMap ( oxCustomScript  script )

inlineprivate

                                                                         {

        Map<String, String> map = new HashMap<>();
        for (String mprop : script.getModuleProperties()) {
            try {
                SimpleExtendedCustomProperty p = mapper.readValue(mprop, new TypeReference<SimpleExtendedCustomProperty>() {});
                map.put(p.getValue1(), p.getValue2());
            } catch (Exception e) {
                logger.error("modulePropertyMap. Error while parsing module properties of script '{}': {}", script.getDisplayName(), e.getMessage());
            }
        }
        return map;

    }

メンバ詳解

confHandler

ConfigurationHandler org.gluu.credmanager.service.AuthnScriptsReloader.confHandler

private

extManager

ExtensionsManager org.gluu.credmanager.service.AuthnScriptsReloader.extManager

private

FILENAME_TEMPLATE

final String org.gluu.credmanager.service.AuthnScriptsReloader.FILENAME_TEMPLATE = "cred-manager-external_{0}.py"

staticprivate

ldapService

LdapService org.gluu.credmanager.service.AuthnScriptsReloader.ldapService

private

LOCATION_PATH_PROPERTY

final String org.gluu.credmanager.service.AuthnScriptsReloader.LOCATION_PATH_PROPERTY = "location_path"

static

LOCATION_TYPE_PROPERTY

final String org.gluu.credmanager.service.AuthnScriptsReloader.LOCATION_TYPE_PROPERTY = "location_type"

static

logger

Logger org.gluu.credmanager.service.AuthnScriptsReloader.logger

private

mapper

ObjectMapper org.gluu.credmanager.service.AuthnScriptsReloader.mapper

private

pythonLibLocation

String org.gluu.credmanager.service.AuthnScriptsReloader.pythonLibLocation

private

SCAN_INTERVAL

final int org.gluu.credmanager.service.AuthnScriptsReloader.SCAN_INTERVAL = 45

staticprivate

scriptHashes

Map<String, Integer> org.gluu.credmanager.service.AuthnScriptsReloader.scriptHashes

private

scriptsJobName

String org.gluu.credmanager.service.AuthnScriptsReloader.scriptsJobName

private

timerService

TimerService org.gluu.credmanager.service.AuthnScriptsReloader.timerService

private

---

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

• D:/AppData/OpenId/gluu/src/cred-manager/app/src/main/java/org/gluu/credmanager/service/AuthnScriptsReloader.java