ext.sulis.usermagic

Class UserMagic

Object

UserMagic

All Implemented Interfaces:

RemoteAccess

public class UserMagic
extends Object
implements RemoteAccess

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTPGWHOSTNAME
static int	MAJOR
static int	MINOR
static String	RMIHOSTNAME
static boolean	SERVER
static boolean	VERBOSE
static String	WEBAPPNAME
static String	WTHOME

Fields inherited from interface RemoteAccess

versionID

Constructor Summary

Constructors

Constructor and Description
UserMagic()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	askUserYesNo(String questionTxt)
static void	changeDN(String curDN, String newDN, boolean updateGroups)
static boolean	checkRemoteObjectID(WTUser wtu, String userDN, boolean update)
static void	cmdAddWTPrincipalsToContainerRoles(Map params)
static void	cmdAddWTPrincipalToContainerRole(Map params)
static void	cmdCreateUserCSV(String csvFilename)
static void	cmdDeleteUser(boolean force, String uid) delete or disable a user within windchill/ldap
static void	cmdDeleteUserCSV(boolean force, String csvFilename)
static void	cmdExportUserCSV(Map exportParams)
static void	cmdRemoveAllFromContainerRoles(Map params)
static void	cmdRemoveWTPrincipalFromContainerRole(Map params)
static void	cmdRemoveWTPrincipalsFromContainerRoles(Map params)
static void	cmdReportContainerRoleMembers(Map params)
static void	cmdUpdateUserGroups(String csvFilename, String mode)
static HashMap<String,Object>	convertLDAPEntryTopLDAPUserData(LDAPEntry user) add the data from a ldapentry object (should be a user...) to a hashmap.
static WTGroup	createGroup(String grpName, String orgDN)
static void	createLDAPGroup(String grpName, String groupDN)
static void	createLDAPUser(HashMap<String,Object> userData)
static void	createMissingLDAPUser(WTUser user, String dn)
static void	createUser(Map data, String dn)
static WTUser	createWTUser(String username, String dn)
static boolean	deleteUser(String username)
static boolean	deleteUser(WTUser user2delete, boolean delLDAP)
static void	deleteUsers(Vector<String> usernames)
static void	delLDAPEntry(String entryDN)
static void	delLDAPUser(String userDN)
static boolean	disableWTUser(WTUser wtUser)
static void	exportUserCSV(Map exportParams)
static void	findDoppelgaenger(boolean tryToFix)
static List<WTUser>	findUsers(String userNameRegex)
static void	fixRemoteObjectID(WTUser wtu) use before changeDN.
static Vector<String>	getAllLDAPGroups()
static HashMap<String,Object>	getLDAPUserByUID(String uid) search ldap for a given uid
static Map<String,HashMap>	getLDAPUsers(String baseDN) query ldap db for all users
static Vector<String>	getOrganizations()
static Vector<String>	getPeopleDNs() queries for all available ou=people trees in ldap.
static String	getPeopleTreeDN(String csvDirectory)
static String	getUIDFromDN(String dn) extract the uid part from the dn string
static Vector<String>	getUserLDAPGroups(String fqUserDN)
static List	getUserRoleReport(WTUser u, Map listOfContainers, Map<String,HashMap<String,HashMap<String,String>>> userAndRoles)
static WTUser	getWTUser(String uid) get a wtuser obj by given uid.
static Map<String,WTUser>	getWTUsers() query windchill db for wtusers
static void	main(String[] args)
static void	modifyLDAPUser(HashMap<String,Object> userData)
static void	moveWTPrincipalRole(String containerName, String oldRoleName, String newRoleName, String principalName, boolean cleanCache)
static void	printLDAPSettings() print ldap settings.
static void	printUsage() print usage.
static void	printUserData(Map<String,Object> userData) print ldapuserdata.
static List<Map>	readCSV(File aCSVFile, boolean hasHeader, String fieldDelim, boolean hasQuotes, String recordDelim) read a csv file into a vector of maps.
static Properties	readLDAPSettings()
static boolean	removeUser(WTUser wtUser) removes a wtuser object from database.
static String	selectPeopleTree() display list of available ou=people trees in ldap.
static void	setPassword(String userDN, String newPassword)
static void	updateUser(Map data, HashMap<String,Object> existingLDAPData)
static void	updateUserGroups(List<Map> csvData, boolean createMissing)
static void	validateUsers(boolean tryToFix) validate plausibility of all users - check if all ldap users have a corresponding wtuser obj - check if all wtuser objs have a corresponding ldap entry

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAJOR

public static final int MAJOR

See Also:

Constant Field Values

MINOR

public static final int MINOR

See Also:

Constant Field Values

SERVER

public static final boolean SERVER

RMIHOSTNAME

public static final String RMIHOSTNAME

HTTPGWHOSTNAME

public static final String HTTPGWHOSTNAME

WEBAPPNAME

public static final String WEBAPPNAME

WTHOME

public static final String WTHOME

VERBOSE

public static final boolean VERBOSE

See Also:

Constant Field Values

Constructor Detail

UserMagic

public UserMagic()

Method Detail

askUserYesNo

public static boolean askUserYesNo(String questionTxt)

readLDAPSettings

public static Properties readLDAPSettings()

delLDAPEntry

public static void delLDAPEntry(String entryDN)

delLDAPUser

public static void delLDAPUser(String userDN)

createLDAPUser

public static void createLDAPUser(HashMap<String,Object> userData)

modifyLDAPUser

public static void modifyLDAPUser(HashMap<String,Object> userData)

createMissingLDAPUser

public static void createMissingLDAPUser(WTUser user,
                         String dn)
                                  throws Exception

Throws:

Exception

createWTUser

public static WTUser createWTUser(String username,
                  String dn)
                           throws WTException

Throws:

WTException

deleteUser

public static boolean deleteUser(WTUser user2delete,
                 boolean delLDAP)
                          throws WTException

Throws:

WTException

deleteUser

public static boolean deleteUser(String username)
                          throws Exception

Throws:

Exception

disableWTUser

public static boolean disableWTUser(WTUser wtUser)
                             throws Exception

Throws:

Exception

removeUser

public static boolean removeUser(WTUser wtUser)
                          throws Exception

removes a wtuser object from database. handle with care! delete can't be undone. method won't check for references to this user. invalid references due to deleted wtuser objects may damage your windchill installation. purpose: in case of duplicate wtuser entries (caused by bad usage of loadfiles) you may use this function to delete duplicate entries.

Parameters:

wtUser -

Returns:

true if succeeded

Throws:

Exception

deleteUsers

public static void deleteUsers(Vector<String> usernames)
                        throws Exception

Throws:

Exception

readCSV

public static List<Map> readCSV(File aCSVFile,
                boolean hasHeader,
                String fieldDelim,
                boolean hasQuotes,
                String recordDelim)
                         throws Exception

read a csv file into a vector of maps. each map represents one line of the csv file.

Parameters:

aCSVFile -

hasHeader -

fieldDelim -

hasQuotes -

recordDelim -

Returns:

List with key/value Maps

Throws:

Exception

getWTUser

public static WTUser getWTUser(String uid)
                        throws Exception

get a wtuser obj by given uid. uid is case-insensitive matched against name.

Parameters:

uid -

Returns:

the WTUser

Throws:

Exception

getWTUsers

public static Map<String,WTUser> getWTUsers()
                                     throws WTException

query windchill db for wtusers

Returns:

map of wtusers. key is uid

Throws:

WTException

getUserLDAPGroups

public static Vector<String> getUserLDAPGroups(String fqUserDN)

getOrganizations

public static Vector<String> getOrganizations()

getAllLDAPGroups

public static Vector<String> getAllLDAPGroups()

getPeopleDNs

public static Vector<String> getPeopleDNs()

queries for all available ou=people trees in ldap.

Returns:

vector of ou=people tree dns

convertLDAPEntryTopLDAPUserData

public static HashMap<String,Object> convertLDAPEntryTopLDAPUserData(LDAPEntry user)

add the data from a ldapentry object (should be a user...) to a hashmap.

Parameters:

user -

Returns:

Map with attributes

getLDAPUserByUID

public static HashMap<String,Object> getLDAPUserByUID(String uid)
                                               throws WTException

search ldap for a given uid

Parameters:

uid -

Returns:

Map with attributes or null

Throws:

WTException

getLDAPUsers

public static Map<String,HashMap> getLDAPUsers(String baseDN)

query ldap db for all users

Returns:

map of ldap entries

printUserData

public static void printUserData(Map<String,Object> userData)

print ldapuserdata.

Parameters:

userData -

validateUsers

public static void validateUsers(boolean tryToFix)
                          throws Exception

validate plausibility of all users - check if all ldap users have a corresponding wtuser obj - check if all wtuser objs have a corresponding ldap entry

Throws:

WTException

Exception

selectPeopleTree

public static String selectPeopleTree()

display list of available ou=people trees in ldap. *

Returns:

String with dn of selected people tree

printLDAPSettings

public static void printLDAPSettings()

print ldap settings.

printUsage

public static void printUsage()

print usage.

main

public static void main(String[] args)
                 throws Exception

Parameters:

args -

Throws:

Exception

findUsers

public static List<WTUser> findUsers(String userNameRegex)

exportUserCSV

public static void exportUserCSV(Map exportParams)
                          throws Exception

Throws:

Exception

cmdExportUserCSV

public static void cmdExportUserCSV(Map exportParams)
                             throws Exception

Throws:

Exception

getUserRoleReport

public static List getUserRoleReport(WTUser u,
                     Map listOfContainers,
                     Map<String,HashMap<String,HashMap<String,String>>> userAndRoles)
                              throws WTException

Throws:

WTException

updateUserGroups

public static void updateUserGroups(List<Map> csvData,
                    boolean createMissing)
                             throws Exception

Throws:

Exception

createGroup

public static WTGroup createGroup(String grpName,
                  String orgDN)
                           throws WTException

Throws:

WTException

createLDAPGroup

public static void createLDAPGroup(String grpName,
                   String groupDN)

cmdUpdateUserGroups

public static void cmdUpdateUserGroups(String csvFilename,
                       String mode)
                                throws Exception

Throws:

Exception

createUser

public static void createUser(Map data,
              String dn)
                       throws Exception

Throws:

Exception

updateUser

public static void updateUser(Map data,
              HashMap<String,Object> existingLDAPData)
                       throws Exception

Throws:

Exception

setPassword

public static void setPassword(String userDN,
               String newPassword)
                        throws Exception

Throws:

Exception

getPeopleTreeDN

public static String getPeopleTreeDN(String csvDirectory)

cmdCreateUserCSV

public static void cmdCreateUserCSV(String csvFilename)
                             throws Exception

Throws:

Exception

fixRemoteObjectID

public static void fixRemoteObjectID(WTUser wtu)
                              throws Exception

use before changeDN. fixes ufid issues

Parameters:

wtu -

Throws:

Exception

checkRemoteObjectID

public static boolean checkRemoteObjectID(WTUser wtu,
                          String userDN,
                          boolean update)
                                   throws Exception

Throws:

Exception

changeDN

public static void changeDN(String curDN,
            String newDN,
            boolean updateGroups)
                     throws Exception

Throws:

Exception

cmdDeleteUserCSV

public static void cmdDeleteUserCSV(boolean force,
                    String csvFilename)
                             throws Exception

Throws:

Exception

cmdDeleteUser

public static void cmdDeleteUser(boolean force,
                 String uid)
                          throws Exception

delete or disable a user within windchill/ldap

Parameters:

force - : if true, the wtuser object and the ldap entry WILL BE DELETED. HANDLE WITH CARE!

uid -

Throws:

Exception

getUIDFromDN

public static String getUIDFromDN(String dn)

extract the uid part from the dn string

Parameters:

dn -

Returns:

the UID

findDoppelgaenger

public static void findDoppelgaenger(boolean tryToFix)
                              throws Exception

Throws:

Exception

moveWTPrincipalRole

public static void moveWTPrincipalRole(String containerName,
                       String oldRoleName,
                       String newRoleName,
                       String principalName,
                       boolean cleanCache)

cmdAddWTPrincipalToContainerRole

public static void cmdAddWTPrincipalToContainerRole(Map params)
                                             throws Exception

Throws:

Exception

cmdRemoveWTPrincipalFromContainerRole

public static void cmdRemoveWTPrincipalFromContainerRole(Map params)
                                                  throws Exception

Throws:

Exception

cmdAddWTPrincipalsToContainerRoles

public static void cmdAddWTPrincipalsToContainerRoles(Map params)
                                               throws Exception

Throws:

Exception

cmdRemoveWTPrincipalsFromContainerRoles

public static void cmdRemoveWTPrincipalsFromContainerRoles(Map params)
                                                    throws Exception

Throws:

Exception

cmdRemoveAllFromContainerRoles

public static void cmdRemoveAllFromContainerRoles(Map params)
                                           throws Exception

Throws:

Exception

cmdReportContainerRoleMembers

public static void cmdReportContainerRoleMembers(Map params)
                                          throws Exception

Throws:

Exception