org.xdi.oxauth.service.UserService クラス

org.xdi.oxauth.service.UserService 連携図

公開メンバ関数
User	getUserByDn (String dn, String... returnAttributes)
User	getUserByInum (String inum, String... returnAttributes)
User	getUser (String userId, String... returnAttributes)
String	getUserInum (User user)
String	getUserInum (String userId)
String	getUserNameByInum (String inum)
User	updateUser (User user)
User	addDefaultUser (String uid)
User	addUser (User user, boolean active)
User	getUserByAttribute (String attributeName, String attributeValue)
List< User >	getUsersBySample (User user, int limit)
User	addUserAttributeByUserInum (String userInum, String attributeName, String attributeValue)
User	addUserAttribute (String userId, String attributeName, String attributeValue)
boolean	addUserAttribute (User user, String attributeName, String attributeValue)
User	removeUserAttribute (String userId, String attributeName, String attributeValue)
User	replaceUserAttribute (String userId, String attributeName, String oldAttributeValue, String newAttributeValue)
CustomAttribute	getCustomAttribute (User user, String attributeName)
void	setCustomAttribute (User user, String attributeName, String attributeValue)
boolean	saveLongLivedToken (String userId, PersistentJwt longLivedToken)
List< User >	getUsersWithPersistentJwts ()
String	getDnForUser (String inum)
String	getUserInumByDn (String dn)
String	encodeGeneralizedTime (Date date)
Date	decodeGeneralizedTime (String date)

静的公開変数類
static final String []	USER_OBJECT_CLASSES = new String[] { "gluuPerson" }

非公開変数類
Logger	log
PersistenceEntryManager	ldapEntryManager
InumService	inumService
StaticConfiguration	staticConfiguration
AppConfiguration	appConfiguration

詳解

Provides operations with users.

著者

Javier Rojas Blum Date: 11.30.2011

関数詳解

addDefaultUser()

User org.xdi.oxauth.service.UserService.addDefaultUser ( String  uid )

inline

                                           {
        String peopleBaseDN = staticConfiguration.getBaseDn().getPeople();

        String inum = inumService.generatePeopleInum();

        User user = new User();
        user.setDn("inum=" + inum + "," + peopleBaseDN);
        user.setCustomAttributes(Arrays.asList(
                        new CustomAttribute("inum", inum),
                        new CustomAttribute("gluuStatus", GluuStatus.ACTIVE.getValue()),
                                new CustomAttribute("displayName", "User " + uid + " added via oxAuth custom plugin")));
        user.setUserId(uid);

        List<String> personCustomObjectClassList = appConfiguration.getPersonCustomObjectClassList();
        if ((personCustomObjectClassList != null) && !personCustomObjectClassList.isEmpty()) {
                user.setCustomObjectClasses(personCustomObjectClassList.toArray(new String[personCustomObjectClassList.size()]));
        }
        
                ldapEntryManager.persist(user);
                
                return getUser(uid);
        }

addUser()

User org.xdi.oxauth.service.UserService.addUser ( User  user, boolean  active  )

inline

                                                   {
        String peopleBaseDN = staticConfiguration.getBaseDn().getPeople();

        String inum = inumService.generatePeopleInum();

        user.setDn("inum=" + inum + "," + peopleBaseDN);
        user.setAttribute("inum", inum);

        GluuStatus status = active ? GluuStatus.ACTIVE : GluuStatus.REGISTER;
        user.setAttribute("gluuStatus",  status.getValue());

        List<String> personCustomObjectClassList = appConfiguration.getPersonCustomObjectClassList();
        if ((personCustomObjectClassList != null) && !personCustomObjectClassList.isEmpty()) {
                Set<String> allObjectClasses = new HashSet<String>();
                allObjectClasses.addAll(personCustomObjectClassList);

                String currentObjectClasses[] = user.getCustomObjectClasses();
                if (ArrayHelper.isNotEmpty(currentObjectClasses)) {
                        allObjectClasses.addAll(Arrays.asList(currentObjectClasses));
                }

                user.setCustomObjectClasses(allObjectClasses.toArray(new String[allObjectClasses.size()]));
        }

        ldapEntryManager.persist(user);

                return getUserByDn(user.getDn());
        }

addUserAttribute() [1/2]

User org.xdi.oxauth.service.UserService.addUserAttribute ( String  userId, String  attributeName, String  attributeValue  )

inline

                                                                                             {
        log.debug("Add user attribute to LDAP: attributeName = '{}', attributeValue = '{}'", attributeName, attributeValue);

        User user = getUser(userId);
        if (user == null) {
                // We uses this result in Person Authentication Scripts
                return null;
        }
        
        boolean result = addUserAttribute(user, attributeName, attributeValue);
        if (!result) {
                // We uses this result in Person Authentication Scripts
                return null;
        }

        return updateUser(user);
    }

addUserAttribute() [2/2]

boolean org.xdi.oxauth.service.UserService.addUserAttribute ( User  user, String  attributeName, String  attributeValue  )

inline

                                                                                            {
                CustomAttribute customAttribute = getCustomAttribute(user, attributeName);
        if (customAttribute == null) {
                customAttribute = new CustomAttribute(attributeName, attributeValue);
            user.getCustomAttributes().add(customAttribute);
        } else {
                List<String> currentAttributeValues = customAttribute.getValues();

                List<String> newAttributeValues = new ArrayList<String>();
                newAttributeValues.addAll(currentAttributeValues);

                if (newAttributeValues.contains(attributeValue)) {
                        return false;
                } else {
                        newAttributeValues.add(attributeValue);
                }
                
                customAttribute.setValues(newAttributeValues);
        }
        
        return true;
        }

addUserAttributeByUserInum()

User org.xdi.oxauth.service.UserService.addUserAttributeByUserInum ( String  userInum, String  attributeName, String  attributeValue  )

inline

                                                                                                         {
        log.debug("Add user attribute by user inum  to LDAP: attributeName = '{}', attributeValue = '{}'", attributeName, attributeValue);

        User user = getUserByInum(userInum);
        if (user == null) {
                return null;
        }
  
        boolean result = addUserAttribute(user, attributeName, attributeValue);
        if (!result) {
                // We uses this result in Person Authentication Scripts
                addUserAttribute(user, attributeName, attributeValue);
        }

        return updateUser(user);
        
    }

decodeGeneralizedTime()

Date org.xdi.oxauth.service.UserService.decodeGeneralizedTime ( String  date )

inline

                                                       {
                return ldapEntryManager.decodeTime(date);
        }

encodeGeneralizedTime()

String org.xdi.oxauth.service.UserService.encodeGeneralizedTime ( Date  date )

inline

                                                       {
                return ldapEntryManager.encodeTime(date);
        }

getCustomAttribute()

CustomAttribute org.xdi.oxauth.service.UserService.getCustomAttribute ( User  user, String  attributeName  )

inline

                                                                                   {
                for (CustomAttribute customAttribute : user.getCustomAttributes()) {
                        if (StringHelper.equalsIgnoreCase(attributeName, customAttribute.getName())) {
                                return customAttribute;
                        }
                }

                return null;
        }

getDnForUser()

String org.xdi.oxauth.service.UserService.getDnForUser ( String  inum )

inline

                                            {
                String peopleDn = staticConfiguration.getBaseDn().getPeople();
                if (StringHelper.isEmpty(inum)) {
                        return peopleDn;
                }

                return String.format("inum=%s,%s", inum, peopleDn);
        }

getUser()

User org.xdi.oxauth.service.UserService.getUser ( String  userId, String...  returnAttributes  )

inline

                                                                       {
                log.debug("Getting user information from LDAP: userId = {}", userId);

                if (StringHelper.isEmpty(userId)) {
                        return null;
                }

                Filter userUidFilter = Filter.createEqualityFilter("uid", userId);

                List<User> entries = ldapEntryManager.findEntries(staticConfiguration.getBaseDn().getPeople(), User.class, userUidFilter, returnAttributes);
                log.debug("Found {} entries for user id = {}", entries.size(), userId);

                if (entries.size() > 0) {
                        return entries.get(0);
                } else {
                        return null;
                }
        }

getUserByAttribute()

User org.xdi.oxauth.service.UserService.getUserByAttribute ( String  attributeName, String  attributeValue  )

inline

                                                                                {
        log.debug("Getting user information from LDAP: attributeName = '{}', attributeValue = '{}'", attributeName, attributeValue);

        User user = new User();
        user.setDn(staticConfiguration.getBaseDn().getPeople());

        List<CustomAttribute> customAttributes =  new ArrayList<CustomAttribute>();
        customAttributes.add(new CustomAttribute(attributeName, attributeValue));

        user.setCustomAttributes(customAttributes);

        List<User> entries = ldapEntryManager.findEntries(user);
        log.debug("Found '{}' entries", entries.size());

        if (entries.size() > 0) {
            return entries.get(0);
        } else {
            return null;
        }
    }

getUserByDn()

User org.xdi.oxauth.service.UserService.getUserByDn ( String  dn, String...  returnAttributes  )

inline

returns User by Dn

戻り値

User

                                                                   {
        if (Util.isNullOrEmpty(dn)) {
            return null;
        }
        return ldapEntryManager.find(User.class, dn, returnAttributes);
    }

getUserByInum()

User org.xdi.oxauth.service.UserService.getUserByInum ( String  inum, String...  returnAttributes  )

inline

                                                                           {
                if (StringHelper.isEmpty(inum)) {
                        return null;
                }
                
                String userDn = getDnForUser(inum);
                User user = getUserByDn(userDn, returnAttributes);
                if (user == null) {
                        return null;
                }

                return user;
        }

getUserInum() [1/2]

String org.xdi.oxauth.service.UserService.getUserInum ( User  user )

inline

                                             {
                if (user == null) {
                        return null;
                }
                
                String inum = user.getAttribute("inum");

                return inum;
        }

getUserInum() [2/2]

String org.xdi.oxauth.service.UserService.getUserInum ( String  userId )

inline

                                                 {
                User user = getUser(userId, "inum");

                return getUserInum(user);
        }

getUserInumByDn()

String org.xdi.oxauth.service.UserService.getUserInumByDn ( String  dn )

inline

                                                 {
                if (StringHelper.isEmpty(dn)) {
                        return null;
                }

                String peopleDn = staticConfiguration.getBaseDn().getPeople();
                if (!dn.toLowerCase().endsWith(peopleDn.toLowerCase())) {
                        return null;
                }
                String firstDnPart = dn.substring(0, dn.length() - peopleDn.length());
                
                String[] dnParts = firstDnPart.split(",");
                if (dnParts.length == 0) {
                        return null;
                }
                
                String userInumPart = dnParts[dnParts.length - 1];
                String[] userInumParts = userInumPart.split("=");
                if ((userInumParts.length == 2) && StringHelper.equalsIgnoreCase(userInumParts[0], "inum")) {
                        return userInumParts[1];
                }

                return null;
        }

getUserNameByInum()

String org.xdi.oxauth.service.UserService.getUserNameByInum ( String  inum )

inline

                                                     {
                if (StringHelper.isEmpty(inum)) {
                        return null;
                }
                
                String userDn = getDnForUser(inum);
                User user = getUserByDn(userDn, "uid");
                if (user == null) {
                        return null;
                }

                return user.getUserId();
        }

getUsersBySample()

List<User> org.xdi.oxauth.service.UserService.getUsersBySample ( User  user, int  limit  )

inline

                                                             {
        log.debug("Getting user by sample");

        List<User> entries = ldapEntryManager.findEntries(user, limit);
        log.debug("Found '{}' entries", entries.size());

        return entries;
    }

getUsersWithPersistentJwts()

List<User> org.xdi.oxauth.service.UserService.getUsersWithPersistentJwts ( )

inline

                                                   {
        String baseDN = staticConfiguration.getBaseDn().getPeople();
        Filter filter = Filter.createPresenceFilter("oxAuthPersistentJWT");

        return ldapEntryManager.findEntries(baseDN, User.class, filter);
    }

removeUserAttribute()

User org.xdi.oxauth.service.UserService.removeUserAttribute ( String  userId, String  attributeName, String  attributeValue  )

inline

                                                                                                {
        log.debug("Remove user attribute from LDAP: attributeName = '{}', attributeValue = '{}'", attributeName, attributeValue);

        User user = getUser(userId);
        if (user == null) {
                return null;
        }
        
        CustomAttribute customAttribute = getCustomAttribute(user, attributeName);
        if (customAttribute != null) {
                List<String> currentAttributeValues = customAttribute.getValues();
                if (currentAttributeValues.contains(attributeValue)) {

                        List<String> newAttributeValues = new ArrayList<String>();
                newAttributeValues.addAll(currentAttributeValues);
                        if (currentAttributeValues.contains(attributeValue)) {
                        newAttributeValues.remove(attributeValue);
                } else {
                        return null;
                }

                        customAttribute.setValues(newAttributeValues);
                }
        }

                return updateUser(user);
    }

replaceUserAttribute()

User org.xdi.oxauth.service.UserService.replaceUserAttribute ( String  userId, String  attributeName, String  oldAttributeValue, String  newAttributeValue  )

inline

                                                                                                                              {
        log.debug("Replace user attribute in LDAP: attributeName = '{}', oldAttributeValue = '{}', newAttributeValue = '{}'", attributeName, oldAttributeValue, newAttributeValue);

        User user = getUser(userId);
        if (user == null) {
                return null;
        }
        
        CustomAttribute customAttribute = getCustomAttribute(user, attributeName);
        if (customAttribute != null) {
                List<String> currentAttributeValues = customAttribute.getValues();
                List<String> newAttributeValues = new ArrayList<String>();
                newAttributeValues.addAll(currentAttributeValues);

                if (currentAttributeValues.contains(oldAttributeValue)) {
                        newAttributeValues.remove(oldAttributeValue);
                }

                if (!newAttributeValues.contains(newAttributeValue)) {
                        newAttributeValues.add(newAttributeValue);
                }

                customAttribute.setValues(newAttributeValues);
        }

                return updateUser(user);
    }

saveLongLivedToken()

boolean org.xdi.oxauth.service.UserService.saveLongLivedToken ( String  userId, PersistentJwt  longLivedToken  )

inline

                                                                                   {
        log.debug("Saving long-lived access token: userId = {}", userId);
        boolean succeed = false;

        User user = getUser(userId);
        if (user != null) {
            int nTokens = 0;
            if (user.getOxAuthPersistentJwt() != null) {
                nTokens = user.getOxAuthPersistentJwt().length;
            }
            nTokens++;
            String[] persistentJwts = new String[nTokens];
            if (user.getOxAuthPersistentJwt() != null) {
                for (int i = 0; i < user.getOxAuthPersistentJwt().length; i++) {
                    persistentJwts[i] = user.getOxAuthPersistentJwt()[i];
                }
            }
            persistentJwts[nTokens - 1] = longLivedToken.toString();

            user.setOxAuthPersistentJwt(persistentJwts);
            ldapEntryManager.merge(user);
            succeed = true;
        }

        return succeed;
    }

setCustomAttribute()

void org.xdi.oxauth.service.UserService.setCustomAttribute ( User  user, String  attributeName, String  attributeValue  )

inline

                                                                                               {
                CustomAttribute customAttribute = getCustomAttribute(user, attributeName);
                
                if (customAttribute == null) {
                        customAttribute = new CustomAttribute(attributeName);
                        user.getCustomAttributes().add(customAttribute);
                }
                
                customAttribute.setValue(attributeValue);
        }

updateUser()

User org.xdi.oxauth.service.UserService.updateUser ( User  user )

inline

                                      {
                return ldapEntryManager.merge(user);
        }

メンバ詳解

appConfiguration

AppConfiguration org.xdi.oxauth.service.UserService.appConfiguration

private

inumService

InumService org.xdi.oxauth.service.UserService.inumService

private

ldapEntryManager

PersistenceEntryManager org.xdi.oxauth.service.UserService.ldapEntryManager

private

log

Logger org.xdi.oxauth.service.UserService.log

private

staticConfiguration

StaticConfiguration org.xdi.oxauth.service.UserService.staticConfiguration

private

USER_OBJECT_CLASSES

final String [] org.xdi.oxauth.service.UserService.USER_OBJECT_CLASSES = new String[] { "gluuPerson" }

static

---

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

• D:/AppData/OpenId/gluu/src/oxAuth/Server/src/main/java/org/xdi/oxauth/service/UserService.java