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

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

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

公開メンバ関数
void	transferAttributesToGroupResource (GluuGroup gluuGroup, GroupResource res, String groupsUrl, String usersUrl)
void	createGroup (GroupResource group, String groupsUrl, String usersUrl) throws Exception
GroupResource	updateGroup (String id, GroupResource group, String groupsUrl, String usersUrl) throws Exception
void	deleteGroup (GluuGroup gluuGroup) throws Exception
void	replaceGroupInfo (GluuGroup gluuGroup, GroupResource group, String groupsUrl, String usersUrl) throws Exception
PagedResult< BaseScimResource >	searchGroups (String filter, String sortBy, SortOrder sortOrder, int startIndex, int count, String groupsUrl, String usersUrl, int maxCount) throws Exception

非公開メンバ関数
void	transferAttributesToGroup (GroupResource res, GluuGroup group, String usersUrl)
void	assignComputedAttributesToGroup (GluuGroup gluuGroup) throws Exception
void	syncMemberAttributeInPerson (String groupDn, List< String > beforeMemberDns, List< String > afterMemberDns)

非公開変数類
Logger	log
IPersonService	personService
IGroupService	groupService
ExternalScimService	externalScimService
OrganizationService	organizationService
ExtensionService	extService
ScimFilterParserService	scimFilterParserService
PersistenceEntryManager	ldapEntryManager

詳解

著者

Val Pecaoco Re-engineered by jgomer on 2017-10-18.

関数詳解

assignComputedAttributesToGroup()

void org.gluu.oxtrust.service.scim2.Scim2GroupService.assignComputedAttributesToGroup ( GluuGroup  gluuGroup ) throws Exception

inlineprivate

                                                                                      {

        String inum = groupService.generateInumForNewGroup();
        String dn = groupService.getDnForGroup(inum);

        gluuGroup.setInum(inum);
        gluuGroup.setDn(dn);
        gluuGroup.setIname(groupService.generateInameForNewGroup(gluuGroup.getDisplayName().replaceAll(" ", "")));

    }

createGroup()

void org.gluu.oxtrust.service.scim2.Scim2GroupService.createGroup ( GroupResource  group, String  groupsUrl, String  usersUrl  ) throws Exception

inline

Inserts a new group in LDAP based on the SCIM Resource passed There is no need to check attributes mutability in this case as there are no original attributes (the resource does not exist yet)

引数

group

A GroupResource object with all info as received by the web service

例外

Exception

                                                                                                     {

        String groupName=group.getDisplayName();
        log.info("Preparing to create group {}", groupName);

        GluuGroup gluuGroup=new GluuGroup();
        transferAttributesToGroup(group, gluuGroup, usersUrl);
        assignComputedAttributesToGroup(gluuGroup);

        String location= groupsUrl + "/" + gluuGroup.getInum();
        gluuGroup.setAttribute("oxTrustMetaLocation", location);

        log.info("Persisting group {}", groupName);

        if (externalScimService.isEnabled()){
            boolean result = externalScimService.executeScimCreateGroupMethods(gluuGroup);
            if (!result) {
                throw new WebApplicationException("Failed to execute SCIM script successfully", Status.PRECONDITION_FAILED);
            }
            groupService.addGroup(gluuGroup);
            syncMemberAttributeInPerson(gluuGroup.getDn(), null, gluuGroup.getMembers());

            //Copy back to group the info from gluuGroup
            transferAttributesToGroupResource(gluuGroup, group, groupsUrl, usersUrl);
            externalScimService.executeScimPostCreateGroupMethods(gluuGroup);
        }
        else {
            groupService.addGroup(gluuGroup);
            group.getMeta().setLocation(location);
            //We are ignoring the id value received (group.getId())
            group.setId(gluuGroup.getInum());
            syncMemberAttributeInPerson(gluuGroup.getDn(), null, gluuGroup.getMembers());
        }

    }

deleteGroup()

void org.gluu.oxtrust.service.scim2.Scim2GroupService.deleteGroup ( GluuGroup  gluuGroup ) throws Exception

inline

                                                                  {
        log.info("Removing group and updating user's entries");

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

        groupService.removeGroup(gluuGroup);

        if (externalScimService.isEnabled())
            externalScimService.executeScimPostDeleteGroupMethods(gluuGroup);

    }

replaceGroupInfo()

void org.gluu.oxtrust.service.scim2.Scim2GroupService.replaceGroupInfo ( GluuGroup  gluuGroup, GroupResource  group, String  groupsUrl, String  usersUrl  ) throws Exception

inline

                                                                                                                              {

        List<String> olderMembers=new ArrayList<String>();
        if (gluuGroup.getMembers()!=null)
            olderMembers.addAll(gluuGroup.getMembers());

        transferAttributesToGroup(group, gluuGroup, usersUrl);
        log.debug("replaceGroupInfo. Updating group info in LDAP");

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

            groupService.updateGroup(gluuGroup);
            syncMemberAttributeInPerson(gluuGroup.getDn(), olderMembers, gluuGroup.getMembers());

            //Copy back to user the info from gluuGroup
            transferAttributesToGroupResource(gluuGroup, group, groupsUrl, usersUrl);
            externalScimService.executeScimPostUpdateGroupMethods(gluuGroup);
        }
        else{
            groupService.updateGroup(gluuGroup);
            syncMemberAttributeInPerson(gluuGroup.getDn(), olderMembers, gluuGroup.getMembers());
        }

    }

searchGroups()

PagedResult<BaseScimResource> org.gluu.oxtrust.service.scim2.Scim2GroupService.searchGroups ( String  filter, String  sortBy, SortOrder  sortOrder, int  startIndex, int  count, String  groupsUrl, String  usersUrl, int  maxCount  ) throws Exception

inline

                                                                                                                {

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

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

        for (GluuGroup group: list.getEntries()){
            GroupResource scimGroup=new GroupResource();
            transferAttributesToGroupResource(group, scimGroup, groupsUrl, usersUrl);
            //TODO: Delete this IF in the future - added for backwards compatibility with SCIM-Client <= 3.1.2.
            if (scimGroup.getMembers()==null)
                scimGroup.setMembers(new HashSet<Member>());

            resources.add(scimGroup);
        }
        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;

    }

syncMemberAttributeInPerson()

void org.gluu.oxtrust.service.scim2.Scim2GroupService.syncMemberAttributeInPerson ( String  groupDn, List< String >  beforeMemberDns, List< String >  afterMemberDns  )

inlineprivate

                                                                                                                       {

        log.debug("syncMemberAttributeInPerson. Updating memberOf attribute in user LDAP entries");
        log.trace("Before member dns {}; After member dns {}", beforeMemberDns, afterMemberDns);

        //Build 2 sets of DNs
        Set<String> before=new HashSet<String>();
        if (beforeMemberDns!=null)
            before.addAll(beforeMemberDns);

        Set<String> after=new HashSet<String>();
        if (afterMemberDns!=null)
            after.addAll(afterMemberDns);

        //Do removals
        for (String dn : before){
            if (!after.contains(dn)){
                try{
                    GluuCustomPerson gluuPerson = personService.getPersonByDn(dn);

                    List<String> memberOf=new ArrayList<String>();
                    memberOf.addAll(gluuPerson.getMemberOf());
                    memberOf.remove(groupDn);

                    gluuPerson.setMemberOf(memberOf);
                    personService.updatePerson(gluuPerson);
                }
                catch (Exception e){
                    log.error("An error occurred while removing user {} from group {}", dn, groupDn);
                    log.error(e.getMessage(), e);
                }
            }
        }

        //Do insertions
        for (String dn : after){
            if (!before.contains(dn)){
                try{
                    GluuCustomPerson gluuPerson = personService.getPersonByDn(dn);

                    List<String> memberOf=new ArrayList<String>();
                    memberOf.add(groupDn);

                    if (gluuPerson.getMemberOf()!=null)
                        memberOf.addAll(gluuPerson.getMemberOf());

                    gluuPerson.setMemberOf(memberOf);
                    personService.updatePerson(gluuPerson);
                }
                catch (Exception e){
                    log.error("An error occurred while adding user {} to group {}", dn, groupDn);
                    log.error(e.getMessage(), e);
                }
            }
        }

    }

transferAttributesToGroup()

void org.gluu.oxtrust.service.scim2.Scim2GroupService.transferAttributesToGroup ( GroupResource  res, GluuGroup  group, String  usersUrl  )

inlineprivate

                                                                                                {

        //externalId (so oxTrustExternalId) not part of LDAP schema
        group.setAttribute("oxTrustMetaCreated", res.getMeta().getCreated());
        group.setAttribute("oxTrustMetaLastModified", res.getMeta().getLastModified());
        //When creating group, location will be set again when having an inum
        group.setAttribute("oxTrustMetaLocation", res.getMeta().getLocation());

        group.setDisplayName(res.getDisplayName());
        group.setStatus(GluuStatus.ACTIVE);
        group.setOrganization(organizationService.getDnForOrganization());

        //Add the members, and complement the $refs and users' display names in res
        Set<Member> members=res.getMembers();
        if (members!=null && members.size()>0){
            List<String> listMembers = new ArrayList<String>();
            List<Member> invalidMembers = new ArrayList<Member>();

            for (Member member : members){
                String inum=member.getValue();  //it's not null as it is required in GroupResource
                GluuCustomPerson person=personService.getPersonByInum(inum);

                if (person == null) {
                    log.info("Member identified by {} does not exist. Ignored", inum);
                    invalidMembers.add(member);
                } else {
                    member.setDisplay(person.getDisplayName());
                    member.setRef(usersUrl + "/" + inum);
                    member.setType(ScimResourceUtil.getType(UserResource.class));

                    listMembers.add(person.getDn());
                }
            }
            group.setMembers(listMembers);

            members.removeAll(invalidMembers);
            members = members.size() == 0 ? null : members;
            res.setMembers(members);
        }
    }

transferAttributesToGroupResource()

void org.gluu.oxtrust.service.scim2.Scim2GroupService.transferAttributesToGroupResource ( GluuGroup  gluuGroup, GroupResource  res, String  groupsUrl, String  usersUrl  )

inline

                                                                                                                             {

        res.setId(gluuGroup.getInum());

        Meta meta=new Meta();
        meta.setResourceType(ScimResourceUtil.getType(res.getClass()));
        meta.setCreated(gluuGroup.getAttribute("oxTrustMetaCreated"));
        meta.setLastModified(gluuGroup.getAttribute("oxTrustMetaLastModified"));
        meta.setLocation(gluuGroup.getAttribute("oxTrustMetaLocation"));
        if (meta.getLocation()==null)
            meta.setLocation(groupsUrl + "/" + gluuGroup.getInum());

        res.setMeta(meta);
        res.setDisplayName(gluuGroup.getDisplayName());

        //Transfer members from GluuGroup to GroupResource
        List<String> memberDNs =gluuGroup.getMembers();
        if (memberDNs !=null){
            Set<Member> members=new HashSet<Member>();

            for (String dn : memberDNs){
                GluuCustomPerson person=null;
                try{
                    person=personService.getPersonByDn(dn);
                }
                catch (Exception e){
                    log.warn("Wrong member entry {} found in group {}", dn, gluuGroup.getDisplayName());
                }
                if (person!=null){
                    Member aMember=new Member();
                    aMember.setValue(person.getInum());
                    aMember.setRef(usersUrl + "/" + person.getInum());
                    aMember.setType(ScimResourceUtil.getType(UserResource.class));
                    aMember.setDisplay(person.getDisplayName());

                    members.add(aMember);
                }
            }
            res.setMembers(members);
        }
    }

updateGroup()

GroupResource org.gluu.oxtrust.service.scim2.Scim2GroupService.updateGroup ( String  id, GroupResource  group, String  groupsUrl, String  usersUrl  ) throws Exception

inline

                                                                                                                         {

        GluuGroup gluuGroup = groupService.getGroupByInum(id);    //This is never null (see decorator involved)
        GroupResource tmpGroup=new GroupResource();
        transferAttributesToGroupResource(gluuGroup, tmpGroup, groupsUrl, usersUrl);

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

        tmpGroup=(GroupResource) ScimResourceUtil.transferToResourceReplace(group, tmpGroup, extService.getResourceExtensions(group.getClass()));
        replaceGroupInfo(gluuGroup, tmpGroup, groupsUrl, usersUrl);

        return tmpGroup;

    }

メンバ詳解

externalScimService

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

private

extService

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

private

groupService

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

private

ldapEntryManager

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

private

log

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

private

organizationService

OrganizationService org.gluu.oxtrust.service.scim2.Scim2GroupService.organizationService

private

personService

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

private

scimFilterParserService

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

private

---

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

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