org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService クラス

org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService の継承関係図

org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService 連携図

公開メンバ関数
void	reloadConfiguration ()
boolean	isNumberRegistered (String number)
SendCode	sendSMS (String number, String body)
boolean	updateMobilePhonesAdd (String userId, List< VerifiedMobile > mobiles, VerifiedMobile newPhone)
boolean	addPhone (String userId, VerifiedMobile newPhone)
int	getPhonesTotal (String userId)
List< VerifiedMobile >	getVerifiedPhones (String userId)

変数
LdapService	ldapService
ObjectMapper	mapper

非公開メンバ関数
void	inited ()
VerifiedMobile	getExtraPhoneInfo (String number, List< VerifiedMobile > list)

非公開変数類
Logger	logger
String	fromNumber
MessageFactory	messageFactory

詳解

An app. scoped bean to serve the purpose of sending SMS using the Twilio service

著者

jgomer

関数詳解

addPhone()

boolean org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.addPhone ( String  userId, VerifiedMobile  newPhone  )

inline

                                                                    {
        return updateMobilePhonesAdd(userId, getVerifiedPhones(userId), newPhone);
    }

getExtraPhoneInfo()

VerifiedMobile org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.getExtraPhoneInfo ( String  number, List< VerifiedMobile >  list  )

inlineprivate

Creates an instance of VerifiedMobile by looking up in the list of VerifiedPhones passed. If the item is not found in the list, it means the user had already that phone added by means of another application, ie. oxTrust. In this case the resulting object will not have properties like nickname, etc. Just the phone number

引数

number	Phone number (LDAP attribute "mobile" inside a user entry)
list	List of existing phones enrolled. Ideally, there is an item here corresponding to the uid number passed

戻り値

VerifiedMobile object

                                                                                       {
        //Complements current phone with extra info in the list if any
        VerifiedMobile phone = new VerifiedMobile(number);

        Optional<VerifiedMobile> extraInfoPhone = list.stream().filter(ph -> number.equals(ph.getNumber())).findFirst();
        if (extraInfoPhone.isPresent()) {
            phone.setAddedOn(extraInfoPhone.get().getAddedOn());
            phone.setNickName(extraInfoPhone.get().getNickName());
        }
        return phone;
    }

getPhonesTotal()

int org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.getPhonesTotal ( String  userId )

inline

                                             {

        int total = 0;
        try {
            PersonMobile person = ldapService.get(PersonMobile.class, ldapService.getPersonDn(userId));
            total = person.getMobileAsList().size();
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return total;

    }

getVerifiedPhones()

List<VerifiedMobile> org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.getVerifiedPhones ( String  userId )

inline

                                                                 {

        List<VerifiedMobile> phones = new ArrayList<>();
        try {
            PersonMobile person = ldapService.get(PersonMobile.class, ldapService.getPersonDn(userId));
            String json = person.getMobileDevices();
            json = Utils.isEmpty(json) ? "[]" : mapper.readTree(json).get("phones").toString();

            List<VerifiedMobile> vphones = mapper.readValue(json, new TypeReference<List<VerifiedMobile>>() { });
            phones = person.getMobileAsList().stream().map(str -> getExtraPhoneInfo(str, vphones)).sorted()
                    .collect(Collectors.toList());
            logger.trace("getVerifiedPhones. User '{}' has {}", userId, phones.stream().map(VerifiedMobile::getNumber).collect(Collectors.toList()));
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return phones;

    }

inited()

void org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.inited ( )

inlineprivate

                          {
        reloadConfiguration();
    }

isNumberRegistered()

boolean org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.isNumberRegistered ( String  number )

inline

                                                     {

        PersonMobile person = new PersonMobile();
        person.setMobile(number);
        List<PersonMobile> matchingPeople = ldapService.find(person, PersonMobile.class, ldapService.getPeopleDn());
        return Utils.isNotEmpty(matchingPeople);

    }

reloadConfiguration()

void org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.reloadConfiguration ( )

inline

                                      {

        Map<String, String> props = ldapService.getCustScriptConfigProperties(OTPSmsExtension.ACR);

        if (props == null) {
            logger.warn("Config. properties for custom script '{}' could not be read. Features related to {} will not be accessible",
                    OTPSmsExtension.ACR, OTPSmsExtension.ACR.toUpperCase());
        } else {
            String sid = props.get("twilio_sid");
            String token = props.get("twilio_token");
            fromNumber = props.get("from_number");

            if (Stream.of(sid, token, fromNumber).anyMatch(Utils::isEmpty)) {
                logger.warn("Error parsing SMS settings. Please check LDAP entry of SMS custom script");
            } else {
                TwilioRestClient client = new TwilioRestClient(sid, token);
                messageFactory = client.getAccount().getMessageFactory();
            }
        }

    }

sendSMS()

SendCode org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.sendSMS ( String  number, String  body  )

inline

                                                        {

        SendCode status;
        if (messageFactory != null) {

            try {
                List<NameValuePair> messageParams = new ArrayList<>();
                messageParams.add(new BasicNameValuePair("From", fromNumber));
                messageParams.add(new BasicNameValuePair("To", number));
                messageParams.add(new BasicNameValuePair("Body", body));
                //TODO: uncomment
                //Message message = messageFactory.create(messageParams);

                //String statusMsg = message.getStatus().toLowerCase();
                String statusMsg = "ok";
                logger.info("Message delivery status was {}", statusMsg);
                switch (statusMsg) {
                    case "failed":
                        status = SendCode.DELIVERY_FAILED;
                        break;
                    case "undelivered":
                        status = SendCode.UNDELIVERED;
                        break;
                    default:
                        status = SendCode.SUCCESS;
                        logger.info("Message \"{}\" sent to #{}", body, number);
                }
            } catch (Exception e) {
                status = SendCode.SMS_SERVICE_ERROR;
                logger.error("No message was sent, error was: {}", e.getMessage());
            }
        } else {
            status = SendCode.APP_SETUP_ERROR;
            logger.info("No message was sent, messageFactory was not initialized properly");
        }
        return status;

    }

updateMobilePhonesAdd()

boolean org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.updateMobilePhonesAdd ( String  userId, List< VerifiedMobile >  mobiles, VerifiedMobile  newPhone  )

inline

                                                                                                               {

        boolean success = false;
        try {
            List<VerifiedMobile> vphones = new ArrayList<>(mobiles);
            if (newPhone != null) {
                vphones.add(newPhone);
            }

            String[] numbers = vphones.stream().map(VerifiedMobile::getNumber).toArray(String[]::new);
            String json = numbers.length > 0 ? mapper.writeValueAsString(Collections.singletonMap("phones", vphones)) : null;

            logger.debug("Updating phones for user '{}'", userId);
            PersonMobile person = ldapService.get(PersonMobile.class, ldapService.getPersonDn(userId));
            person.setMobileDevices(json);
            person.setMobile(numbers);

            success = ldapService.modify(person, PersonMobile.class);

            if (success && newPhone != null) {
                //modify list only if LDAP update took place
                mobiles.add(newPhone);
                logger.debug("Added {}", newPhone.getNumber());
            }
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return success;

    }

メンバ詳解

fromNumber

String org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.fromNumber

private

ldapService

LdapService org.gluu.credmanager.plugins.authnmethod.service.BaseService.ldapService

packageinherited

logger

Logger org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.logger

private

mapper

ObjectMapper org.gluu.credmanager.plugins.authnmethod.service.BaseService.mapper

packageinherited

messageFactory

MessageFactory org.gluu.credmanager.plugins.authnmethod.service.MobilePhoneService.messageFactory

private

---

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

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