org.gluu.oxtrust.service.scim2.Scim2UserService クラス

org.gluu.oxtrust.service.scim2.Scim2UserService の継承関係図

org.gluu.oxtrust.service.scim2.Scim2UserService 連携図

公開メンバ関数
void	transferAttributesToUserResource (GluuCustomPerson person, UserResource res, String url)
void	createUser (UserResource user, String url) throws Exception
UserResource	updateUser (String id, UserResource user, String url) throws InvalidAttributeValueException
void	replacePersonInfo (GluuCustomPerson gluuPerson, UserResource user, String url)
void	deleteUser (GluuCustomPerson gluuPerson) throws Exception
PagedResult< BaseScimResource >	searchUsers (String filter, String sortBy, SortOrder sortOrder, int startIndex, int count, String url, int maxCount) throws Exception
void	removePPIDsBranch (String dn)

関数
private< T > List< T >	getAttributeListValue (GluuCustomPerson source, Class< T > clazz, String attrName)

非公開メンバ関数
String []	getComplexMultivaluedAsArray (List items)
void	transferAttributesToPerson (UserResource res, GluuCustomPerson person)
void	transferExtendedAttributesToPerson (BaseScimResource resource, GluuCustomPerson person)
void	transferExtendedAttributesToResource (GluuCustomPerson person, BaseScimResource resource)
void	writeCommonName (GluuCustomPerson person)
void	assignComputedAttributesToPerson (GluuCustomPerson person)

非公開変数類
Logger	log
AppConfiguration	appConfiguration
MemberService	memberService
IPersonService	personService
IGroupService	groupService
GroupWebService	groupWS
ExternalScimService	externalScimService
ServiceUtil	serviceUtil
ExtensionService	extService
ScimFilterParserService	scimFilterParserService
PersistenceEntryManager	ldapEntryManager

詳解

This class holds the most important business logic of the SCIM service for the resource type "User". It's devoted to taking objects of class UserResource, feeding instances of GluuCustomPerson, and do persistence to LDAP. The converse is also done: querying LDAP, and transforming GluuCustomPerson into UserResource

著者

Val Pecaoco Re-engineered by jgomer on 2017-09-15.

関数詳解

assignComputedAttributesToPerson()

void org.gluu.oxtrust.service.scim2.Scim2UserService.assignComputedAttributesToPerson ( GluuCustomPerson  person )

inlineprivate

                                                                          {

        String inum = personService.generateInumForNewPerson();
        String dn = personService.getDnForPerson(inum);

        person.setInum(inum);
        person.setDn(dn);
        person.setIname(personService.generateInameForNewPerson(person.getUid()));
        writeCommonName(person);

    }

createUser()

void org.gluu.oxtrust.service.scim2.Scim2UserService.createUser ( UserResource  user, String  url  ) throws Exception

inline

Inserts a new user in LDAP based on the SCIM Resource passed

引数

user	A UserResource object with all info as received by the web service

例外

Exception

                                                                           {

        String userName=user.getUserName();
        log.info("Preparing to create user {}", userName);

        //There is no need to check attributes mutability in this case as there are no original attributes
        //(the resource does not exist yet)
        GluuCustomPerson gluuPerson=new GluuCustomPerson();
        transferAttributesToPerson(user, gluuPerson);
        assignComputedAttributesToPerson(gluuPerson);

        String location=url + "/" + gluuPerson.getInum();
        gluuPerson.setAttribute("oxTrustMetaLocation", location);

        log.info("Persisting user {}", userName);
        personService.addCustomObjectClass(gluuPerson);

        if (externalScimService.isEnabled()){
            boolean result = externalScimService.executeScimCreateUserMethods(gluuPerson);
            if (!result) {
                throw new WebApplicationException("Failed to execute SCIM script successfully", Status.PRECONDITION_FAILED);
            }

            personService.addPerson(gluuPerson);
            //Copy back to user the info from gluuPerson
            transferAttributesToUserResource(gluuPerson, user, url);
            externalScimService.executeScimPostCreateUserMethods(gluuPerson);
        }
        else {
            personService.addPerson(gluuPerson);
            user.getMeta().setLocation(location);
            //We are ignoring the id value received (user.getId())
            user.setId(gluuPerson.getInum());
        }

    }

deleteUser()

void org.gluu.oxtrust.service.scim2.Scim2UserService.deleteUser ( GluuCustomPerson  gluuPerson ) throws Exception

inline

                                                                         {

        String dn = gluuPerson.getDn();
        if (gluuPerson.getMemberOf()!= null && gluuPerson.getMemberOf().size()>0) {
            log.info("Removing user {} from groups", gluuPerson.getUid());
            serviceUtil.deleteUserFromGroup(gluuPerson, dn);
        }
        log.info("Removing user entry {}", dn);

        if (externalScimService.isEnabled()) {
            boolean result = externalScimService.executeScimDeleteUserMethods(gluuPerson);
            if (!result) {
                throw new WebApplicationException("Failed to execute SCIM script successfully", Status.PRECONDITION_FAILED);
            }
        }

        personService.removePerson(gluuPerson);

        if (externalScimService.isEnabled())
            externalScimService.executeScimPostDeleteUserMethods(gluuPerson);

    }

getAttributeListValue()

private<T> List<T> org.gluu.oxtrust.service.scim2.Scim2UserService.getAttributeListValue ( GluuCustomPerson  source, Class< T >  clazz, String  attrName  )

inlinepackage

                                                                                                        {

        List<T> items = null;
        try {
            ObjectMapper mapper = ServiceUtil.getObjectMapper();
            //This is already disabled in ServiceUtil
            //mapper.disable(DeserializationConfig.Feature.FAIL_ON_UNKNOWN_PROPERTIES);

            String[] attributeArray = source.getAttributeArray(attrName);
            if (attributeArray != null) {
                items = new ArrayList<T>();
                for (String attribute : attributeArray) {
                    T item = mapper.readValue(attribute, clazz);
                    items.add(item);
                }
            }
        }
        catch (Exception e){
            log.error(e.getMessage(), e);
        }
        return items;

    }

getComplexMultivaluedAsArray()

String [] org.gluu.oxtrust.service.scim2.Scim2UserService.getComplexMultivaluedAsArray ( List  items )

inlineprivate

                                                             {

        String array[]=null;

        try {
            if (items!=null && items.size()>0) {
                ObjectMapper mapper = ServiceUtil.getObjectMapper();
                List<String> itemList = new ArrayList<String>();

                for (Object item : items)
                    itemList.add(mapper.writeValueAsString(item));

                array = itemList.toArray(new String[]{});
            }
        }
        catch (Exception e){
            log.error(e.getMessage(), e);
        }
        return array;

    }

removePPIDsBranch()

void org.gluu.oxtrust.service.scim2.Scim2UserService.removePPIDsBranch ( String  dn )

inline

                                             {
        try {
            ldapEntryManager.removeRecursively(String.format("ou=pairwiseIdentifiers,%s", dn));
        }
        catch (Exception e){
            log.error(e.getMessage(), e);
        }
    }

replacePersonInfo()

void org.gluu.oxtrust.service.scim2.Scim2UserService.replacePersonInfo ( GluuCustomPerson  gluuPerson, UserResource  user, String  url  )

inline

                                                                                             {
        transferAttributesToPerson(user, gluuPerson);
        writeCommonName(gluuPerson);

        log.debug("replacePersonInfo. Updating person info in LDAP");
        personService.addCustomObjectClass(gluuPerson);

        if (externalScimService.isEnabled()){
            boolean result = externalScimService.executeScimUpdateUserMethods(gluuPerson);
            if (!result) {
                throw new WebApplicationException("Failed to execute SCIM script successfully", Status.PRECONDITION_FAILED);
            }

            personService.updatePerson(gluuPerson);
            //Copy back to user the info from gluuPerson
            transferAttributesToUserResource(gluuPerson, user, url);
            externalScimService.executeScimPostUpdateUserMethods(gluuPerson);
        }
        else {
            personService.updatePerson(gluuPerson);
        }

    }

searchUsers()

PagedResult<BaseScimResource> org.gluu.oxtrust.service.scim2.Scim2UserService.searchUsers ( String  filter, String  sortBy, SortOrder  sortOrder, int  startIndex, int  count, String  url, int  maxCount  ) throws Exception

inline

                                                                                        {

        Filter ldapFilter=scimFilterParserService.createLdapFilter(filter, "inum=*", UserResource.class);
        log.info("Executing search for users using: ldapfilter '{}', sortBy '{}', sortOrder '{}', startIndex '{}', count '{}'",
                ldapFilter.toString(), sortBy, sortOrder.getValue(), startIndex, count);

        PagedResult<GluuCustomPerson> list=ldapEntryManager.findPagedEntries(personService.getDnForPerson(null),
                GluuCustomPerson.class, ldapFilter, null, sortBy, sortOrder, startIndex, count, maxCount);
        List<BaseScimResource> resources=new ArrayList<BaseScimResource>();

        for (GluuCustomPerson person : list.getEntries()){
            UserResource scimUsr=new UserResource();
            transferAttributesToUserResource(person, scimUsr, url);
            resources.add(scimUsr);
        }
        log.info ("Found {} matching entries - returning {}", list.getTotalEntriesCount(), list.getEntries().size());

        PagedResult<BaseScimResource> result = new PagedResult<BaseScimResource>();
        result.setEntries(resources);
        result.setTotalEntriesCount(list.getTotalEntriesCount());

        return result;

    }

transferAttributesToPerson()

void org.gluu.oxtrust.service.scim2.Scim2UserService.transferAttributesToPerson ( UserResource  res, GluuCustomPerson  person  )

inlineprivate

                                                                                       {

        log.debug("transferAttributesToPerson");

        //Set values trying to follow the order found in BaseScimResource class
        person.setAttribute("oxTrustExternalId", res.getExternalId());
        person.setAttribute("oxTrustMetaCreated", res.getMeta().getCreated());
        person.setAttribute("oxTrustMetaLastModified", res.getMeta().getLastModified());
        //When creating user, location will be set again when having an inum
        person.setAttribute("oxTrustMetaLocation", res.getMeta().getLocation());

        //Set values trying to follow the order found in UserResource class
        person.setUid(res.getUserName());

        if (res.getName()!=null){
            person.setGivenName(res.getName().getGivenName());
            person.setSurname(res.getName().getFamilyName());
            person.setAttribute("middleName", res.getName().getMiddleName());
            person.setAttribute("oxTrusthonorificPrefix", res.getName().getHonorificPrefix());
            person.setAttribute("oxTrusthonorificSuffix", res.getName().getHonorificSuffix());
            person.setAttribute("oxTrustNameFormatted", res.getName().computeFormattedName());
        }
        person.setDisplayName(res.getDisplayName());

        person.setAttribute("nickname", res.getNickName());
        person.setAttribute("oxTrustProfileURL", res.getProfileUrl());
        person.setAttribute("oxTrustTitle", res.getTitle());
        person.setAttribute("oxTrustUserType", res.getUserType());

        person.setPreferredLanguage(res.getPreferredLanguage());
        person.setAttribute("locale", res.getLocale());
        person.setTimezone(res.getTimezone());

        //Why are both gluuStatus and oxTrustActive used for active? it's for active being used in filter queries?
        Boolean active=res.getActive()!=null && res.getActive();
        person.setAttribute("oxTrustActive", active.toString());
        person.setAttribute("gluuStatus", active ? GluuStatus.ACTIVE.getValue() : GluuStatus.INACTIVE.getValue());
        person.setUserPassword(res.getPassword());

        person.setAttribute("oxTrustEmail", getComplexMultivaluedAsArray(res.getEmails()));
        try {
            person = serviceUtil.syncEmailForward(person, true);
        }
        catch (Exception e){
            log.error("Problem syncing emails forward", e);
        }

        person.setAttribute("oxTrustPhoneValue", getComplexMultivaluedAsArray(res.getPhoneNumbers()));
        person.setAttribute("oxTrustImsValue", getComplexMultivaluedAsArray(res.getIms()));
        person.setAttribute("oxTrustPhotos", getComplexMultivaluedAsArray(res.getPhotos()));
        person.setAttribute("oxTrustAddresses", getComplexMultivaluedAsArray(res.getAddresses()));

        //group membership changes MUST be applied via the "Group" Resource (Section 4.1.2 & 8.7.1 RFC 7643) only

        person.setAttribute("oxTrustEntitlements", getComplexMultivaluedAsArray(res.getEntitlements()));
        person.setAttribute("oxTrustRole", getComplexMultivaluedAsArray(res.getRoles()));
        person.setAttribute("oxTrustx509Certificate", getComplexMultivaluedAsArray(res.getX509Certificates()));

        //Pairwise identifiers must not be supplied here... (they are mutability = readOnly)

        transferExtendedAttributesToPerson(res, person);

    }

transferAttributesToUserResource()

void org.gluu.oxtrust.service.scim2.Scim2UserService.transferAttributesToUserResource ( GluuCustomPerson  person, UserResource  res, String  url  )

inline

                                                                                                        {

        log.debug("transferAttributesToUserResource");

        res.setId(person.getInum());
        res.setExternalId(person.getAttribute("oxTrustExternalId"));

        Meta meta=new Meta();
        meta.setResourceType(ScimResourceUtil.getType(res.getClass()));

        meta.setCreated(person.getAttribute("oxTrustMetaCreated"));
        if (meta.getCreated() == null) {
            Date tmpDate = person.getCreationDate();
            meta.setCreated(tmpDate == null ? null : ISODateTimeFormat.dateTime().withZoneUTC().print(tmpDate.getTime()));
        }

        meta.setLastModified(person.getAttribute("oxTrustMetaLastModified"));
        if (meta.getLastModified() == null) {
            Date tmpDate = person.getUpdatedAt();
            meta.setLastModified(tmpDate == null ? null : ISODateTimeFormat.dateTime().withZoneUTC().print(tmpDate.getTime()));
        }

        meta.setLocation(person.getAttribute("oxTrustMetaLocation"));
        if (meta.getLocation()==null)
            meta.setLocation(url + "/" + person.getInum());

        res.setMeta(meta);

        //Set values in order of appearance in UserResource class
        res.setUserName(person.getUid());

        Name name=new Name();
        name.setGivenName(person.getGivenName());
        name.setFamilyName(person.getSurname());
        name.setMiddleName(person.getAttribute("middleName"));
        name.setHonorificPrefix(person.getAttribute("oxTrusthonorificPrefix"));
        name.setHonorificSuffix(person.getAttribute("oxTrusthonorificSuffix"));

        String formatted=person.getAttribute("oxTrustNameFormatted");
        if (formatted==null)    //recomputes the formatted name if absent in LDAP
            name.computeFormattedName();
        else
            name.setFormatted(formatted);

        res.setName(name);
        res.setDisplayName(person.getDisplayName());

        res.setNickName(person.getAttribute("nickname"));
        res.setProfileUrl(person.getAttribute("oxTrustProfileURL"));
        res.setTitle(person.getAttribute("oxTrustTitle"));
        res.setUserType(person.getAttribute("oxTrustUserType"));

        res.setPreferredLanguage(person.getPreferredLanguage());
        res.setLocale(person.getAttribute("locale"));
        res.setTimezone(person.getTimezone());

        res.setActive(Boolean.valueOf(person.getAttribute("oxTrustActive"))
                || GluuBoolean.getByValue(person.getAttribute("gluuStatus")).isBooleanValue());
        res.setPassword(person.getUserPassword());

        res.setEmails(getAttributeListValue(person, Email.class, "oxTrustEmail"));
        res.setPhoneNumbers(getAttributeListValue(person, PhoneNumber.class, "oxTrustPhoneValue"));
        res.setIms(getAttributeListValue(person, InstantMessagingAddress.class, "oxTrustImsValue"));
        res.setPhotos(getAttributeListValue(person, Photo.class, "oxTrustPhotos"));
        res.setAddresses(getAttributeListValue(person, Address.class, "oxTrustAddresses"));

        List<String> listOfGroups = person.getMemberOf();
        if (listOfGroups!= null && listOfGroups.size()>0) {
            List<Group> groupList = new ArrayList<Group>();

            for (String groupDN : listOfGroups) {
                try {
                    GluuGroup gluuGroup = groupService.getGroupByDn(groupDN);

                    Group group = new Group();
                    group.setValue(gluuGroup.getInum());
                    String reference = groupWS.getEndpointUrl() + "/" + gluuGroup.getInum();
                    group.setRef(reference);
                    group.setDisplay(gluuGroup.getDisplayName());
                    group.setType(Group.Type.DIRECT);   //Only support direct membership: see section 4.1.2 of RFC 7644

                    groupList.add(group);
                }
                catch (Exception e){
                    log.warn("transferAttributesToUserResource. Group with dn {} could not be added to User Resource. {}", groupDN, person.getUid());
                    log.error(e.getMessage(), e);
                }
            }
            if (groupList.size()>0)
                res.setGroups(groupList);
        }

        res.setEntitlements(getAttributeListValue(person, Entitlement.class, "oxTrustEntitlements"));
        res.setRoles(getAttributeListValue(person, Role.class, "oxTrustRole"));
        res.setX509Certificates(getAttributeListValue(person, X509Certificate.class, "oxTrustx509Certificate"));

        res.setPairwiseIdentitifers(person.getOxPPID());

        transferExtendedAttributesToResource(person, res);
    }

transferExtendedAttributesToPerson()

void org.gluu.oxtrust.service.scim2.Scim2UserService.transferExtendedAttributesToPerson ( BaseScimResource  resource, GluuCustomPerson  person  )

inlineprivate

Takes all extended attributes found in the SCIM resource and copies them to a GluuCustomPerson This method is called after validations take place (see associated decorator for User Service), so all inputs are OK and can go straight to LDAP with no runtime surprises

引数

resource	A SCIM resource used as origin of data
person	a GluuCustomPerson used as destination

                                                                                                       {

        try {
            //Gets all the extended attributes for this resource
            Map<String, Object> extendedAttrs= resource.getCustomAttributes();
            
            //Iterates over all extensions this type of resource might have
            for (Extension extension : extService.getResourceExtensions(resource.getClass())){
                Object val=extendedAttrs.get(extension.getUrn());

                if (val!=null) {
                    //Obtains the attribute/value(s) pairs in the current extension
                    Map<String, Object> attrsMap = IntrospectUtil.strObjMap(val);

                    for (String attribute : attrsMap.keySet()) {
                        Object value = attrsMap.get(attribute);

                        //Ignore if the attribute is unassigned in this resource: destination will not be changed in this regard
                        if (value != null) {
                            //Get properly formatted string representations for the value(s) associated to the attribute
                            List<String> values=extService.getStringAttributeValues(extension.getFields().get(attribute), value);
                            log.debug("transferExtendedAttributesToPerson. Setting attribute '{}' with values {}", attribute, values.toString());
                            person.setAttribute(attribute, values.toArray(new String[]{}));
                        }
                    }
                }
            }
        }
        catch (Exception e){
            log.error(e.getMessage(), e);
        }

    }

transferExtendedAttributesToResource()

void org.gluu.oxtrust.service.scim2.Scim2UserService.transferExtendedAttributesToResource ( GluuCustomPerson  person, BaseScimResource  resource  )

inlineprivate

                                                                                                         {

        log.debug("transferExtendedAttributesToResource of type {}", ScimResourceUtil.getType(resource.getClass()));

        //Gets the list of extensions associated to the resource passed. In practice, this will be at most a singleton list
        List<Extension> extensions=extService.getResourceExtensions(resource.getClass());

        //Iterate over every extension to copy extended attributes from person to resource
        for (Extension extension : extensions){
            Map<String, ExtensionField> fields=extension.getFields();
            //Create empty map to store the values of the extended attributes found for current extension in object person
            Map<String, Object> map=new HashMap<String, Object>();

            log.debug("transferExtendedAttributesToResource. Revising attributes of extension '{}'", extension.getUrn());

            //Iterate over every attribute part of this extension
            for (String attr : fields.keySet()){
                //Gets the values associated to this attribute that were found in LDAP
                String values[]=person.getAttributes(attr);

                if (values!=null){
                    log.debug("transferExtendedAttributesToResource. Copying to resource the value(s) for attribute '{}'", attr);

                    ExtensionField field=fields.get(attr);
                    if (field.isMultiValued())
                        map.put(attr, extService.convertValues(field, values));
                    else
                        map.put(attr, extService.convertValues(field, values).get(0));
                }
            }
            //Stores all extended attributes (with their values) in the resource object
            if (map.size()>0) {
                resource.addCustomAttributes(extension.getUrn(), map);
            }
        }
        for (String urn : resource.getCustomAttributes().keySet())
            resource.getSchemas().add(urn);

    }

updateUser()

UserResource org.gluu.oxtrust.service.scim2.Scim2UserService.updateUser ( String  id, UserResource  user, String  url  ) throws InvalidAttributeValueException

inline

                                                                                                                   {

        GluuCustomPerson gluuPerson = personService.getPersonByInum(id);    //This is never null (see decorator involved)
        UserResource tmpUser=new UserResource();

        transferAttributesToUserResource(gluuPerson, tmpUser, url);

        long now=System.currentTimeMillis();
        tmpUser.getMeta().setLastModified(ISODateTimeFormat.dateTime().withZoneUTC().print(now));

        tmpUser=(UserResource) ScimResourceUtil.transferToResourceReplace(user, tmpUser, extService.getResourceExtensions(user.getClass()));
        replacePersonInfo(gluuPerson, tmpUser, url);

        return tmpUser;

    }

writeCommonName()

void org.gluu.oxtrust.service.scim2.Scim2UserService.writeCommonName ( GluuCustomPerson  person )

inlineprivate

                                                         {

        if (StringUtils.isNotEmpty(person.getGivenName()) && StringUtils.isNotEmpty(person.getSurname()))
            person.setCommonName(person.getGivenName() + " " + person.getSurname());

    }

メンバ詳解

appConfiguration

AppConfiguration org.gluu.oxtrust.service.scim2.Scim2UserService.appConfiguration

private

externalScimService

ExternalScimService org.gluu.oxtrust.service.scim2.Scim2UserService.externalScimService

private

extService

ExtensionService org.gluu.oxtrust.service.scim2.Scim2UserService.extService

private

groupService

IGroupService org.gluu.oxtrust.service.scim2.Scim2UserService.groupService

private

groupWS

GroupWebService org.gluu.oxtrust.service.scim2.Scim2UserService.groupWS

private

ldapEntryManager

PersistenceEntryManager org.gluu.oxtrust.service.scim2.Scim2UserService.ldapEntryManager

private

log

Logger org.gluu.oxtrust.service.scim2.Scim2UserService.log

private

memberService

MemberService org.gluu.oxtrust.service.scim2.Scim2UserService.memberService

private

personService

IPersonService org.gluu.oxtrust.service.scim2.Scim2UserService.personService

private

scimFilterParserService

ScimFilterParserService org.gluu.oxtrust.service.scim2.Scim2UserService.scimFilterParserService

private

serviceUtil

ServiceUtil org.gluu.oxtrust.service.scim2.Scim2UserService.serviceUtil

private

---

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

• D:/AppData/OpenId/gluu/src/oxTrust/server/src/main/java/org/gluu/oxtrust/service/scim2/Scim2UserService.java