com.brightech.mb.workflow.js

Class JSUserManager

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.JSUserManager

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class JSUserManager
extends JSBaseScriptableObject

Provides access to UserManager from javascript objects. Is available in workflow context pre-initialized as "userManager"

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static JSMap	myUserStatusMap Map of the valid user status.
static JSMap	myUserTypesMap Map of the valid user types.

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
JSUserManager()

Method Summary

Modifier and Type	Method and Description
void	(JavaScript Function) addToGroup(java.lang.String theUserName, java.lang.String theGroupName) Adds a user to a group.
User	(JavaScript Function) createUser(java.lang.String theUserName, java.lang.String thePassword) Creates and returns a new user.
User	(JavaScript Function) duplicateUser(User theUserToDuplicate, java.lang.String theUserName) Duplicates the given user to create a new user.
User	(JavaScript Function) findByUserId(int theUserId) Finds user by numeric ID.
User	(JavaScript Function) findUserByUsername(java.lang.String theUsername) Finds user with the given user name.
User[]	(JavaScript Function) findUsersByPartialName(java.lang.String thePartialName, int theGroupId) Finds users that belong to group specified by id and contain given partial name.
java.lang.String	(JavaScript Function) generateRandomPassword() Generates a random password that meets the system's current password requirements.
ACL[]	(JavaScript Function) getACLs(int theId, boolean theGetUserACLs) Returns the list of user or group ACLs for the specified id, where theId is either a user id or group id depending on whether theGetUserACLs is true or false.
int	(JavaScript Function) getEditLevel(java.lang.String theUserName, java.lang.String theGroupName) Returns the edit level for the specified user/group.
Group[]	(JavaScript Function) getUserGroups(java.lang.String theUserName) Returns an array of Groups that the specified user is in.
int[]	(JavaScript Function) getUserIdsWithEmail(java.lang.String theEmail) Returns a list of user id's for users who have the specified email address.
int	(JavaScript Function) getViewLevel(java.lang.String theUserName, java.lang.String theGroupName) Returns the view level for the specified user/group.
void	(JavaScript Function) insertGroupMembership(java.lang.String theGroup, java.lang.String theUser, boolean thePrimary) Creates group membership entry for a user.
boolean	(JavaScript Function) isLDAPUser(int theUserId) Is the user an LDAP user?
boolean	(JavaScript Function) isLDAPUserExists(java.lang.String theUserName) Checks to see if a user with the given name exists on ldap server.
void	(JavaScript Function) removeFromGroup(java.lang.String theUserName, java.lang.String theGroupName) Removes a user from a group.
void	(JavaScript Function) setPrimaryGroup(java.lang.String theUserName, java.lang.String theGroupName) Sets the primary group for the user.
void	(JavaScript Function) updateContactInfo(java.lang.String theUserName, java.lang.String theFirstName, java.lang.String theLastName, java.lang.String theEmail) Updates basic contact info for the user specified by theUserName.
void	(JavaScript Function) updatePasswordChangeRequired(java.lang.String theUserName, java.lang.String theStatus) Update the password change required value for the specified user.
boolean	(JavaScript Function) userExists(java.lang.String theUserName) Checks to see if a user with the given user name exists.
JSMap	(JavaScript Getter) userStatus()
JSMap	(JavaScript Getter) userTypes()

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Field Detail

myUserStatusMap

public static JSMap myUserStatusMap

Map of the valid user status.

myUserTypesMap

public static JSMap myUserTypesMap

Map of the valid user types.

Constructor Detail

JSUserManager

public JSUserManager()

Method Detail

(JavaScript Getter) userStatus

public JSMap (JavaScript Getter) userStatus()

(JavaScript Getter) userTypes

public JSMap (JavaScript Getter) userTypes()

(JavaScript Function) generateRandomPassword

public java.lang.String (JavaScript Function) generateRandomPassword()

Generates a random password that meets the system's current password requirements.

Returns:

A random password that meets the system's current password requirements.

(JavaScript Function) findUserByUsername

public User (JavaScript Function) findUserByUsername(java.lang.String theUsername)

Finds user with the given user name.

Parameters:

theUsername - user name

Returns:

user or null if the user is not found

(JavaScript Function) findUsersByPartialName

public User[] (JavaScript Function) findUsersByPartialName(java.lang.String thePartialName,
                                                int theGroupId)

Finds users that belong to group specified by id and contain given partial name.

Parameters:

thePartialName - the partial user name

theGroupId - the group id, if group id equals -1, all users will be found that contain given partial name

Returns:

list of users

(JavaScript Function) findByUserId

public User (JavaScript Function) findByUserId(int theUserId)

Finds user by numeric ID.

Parameters:

theUserId - user ID

Returns:

user object or null

(JavaScript Function) getUserIdsWithEmail

public int[] (JavaScript Function) getUserIdsWithEmail(java.lang.String theEmail)

Returns a list of user id's for users who have the specified email address.

Parameters:

theEmail - the email

Returns:

returns a list of user id's for users that have the specified email address

(JavaScript Function) userExists

public boolean (JavaScript Function) userExists(java.lang.String theUserName)

Checks to see if a user with the given user name exists.

Parameters:

theUserName - user name

Returns:

user exists?

(JavaScript Function) isLDAPUserExists

public boolean (JavaScript Function) isLDAPUserExists(java.lang.String theUserName)

Checks to see if a user with the given name exists on ldap server. Note: this method is valid only if SSO is enabled.

Parameters:

theUserName - the user name

Returns:

ldap user exists?

(JavaScript Function) isLDAPUser

public boolean (JavaScript Function) isLDAPUser(int theUserId)

Is the user an LDAP user?

Parameters:

theUserId - user id to check for

Returns:

(JavaScript Function) insertGroupMembership

public void (JavaScript Function) insertGroupMembership(java.lang.String theGroup,
                                             java.lang.String theUser,
                                             boolean thePrimary)
                                      throws java.lang.Exception

Creates group membership entry for a user. Throws exception if the user or group does not exist

Parameters:

theGroup - group

theUser - user name

thePrimary - primary group or not

Throws:

java.lang.Exception

(JavaScript Function) createUser

public User (JavaScript Function) createUser(java.lang.String theUserName,
                                  java.lang.String thePassword)

Creates and returns a new user.

Parameters:

theUserName - username

thePassword - password

Returns:

the created user

(JavaScript Function) duplicateUser

public User (JavaScript Function) duplicateUser(User theUserToDuplicate,
                                     java.lang.String theUserName)

Duplicates the given user to create a new user.

Parameters:

theUserToDuplicate - The user to duplicate.

theUserName - The new user's name.

Returns:

The new user.

(JavaScript Function) updateContactInfo

public void (JavaScript Function) updateContactInfo(java.lang.String theUserName,
                                         java.lang.String theFirstName,
                                         java.lang.String theLastName,
                                         java.lang.String theEmail)

Updates basic contact info for the user specified by theUserName.

Parameters:

theUserName -

theFirstName -

theLastName -

theEmail -

(JavaScript Function) updatePasswordChangeRequired

public void (JavaScript Function) updatePasswordChangeRequired(java.lang.String theUserName,
                                                    java.lang.String theStatus)

Update the password change required value for the specified user.

Parameters:

theUserName - the user name

theStatus - the new status

(JavaScript Function) addToGroup

public void (JavaScript Function) addToGroup(java.lang.String theUserName,
                                  java.lang.String theGroupName)

Adds a user to a group.

Parameters:

theUserName - the user name

theGroupName - the name for the group

(JavaScript Function) setPrimaryGroup

public void (JavaScript Function) setPrimaryGroup(java.lang.String theUserName,
                                       java.lang.String theGroupName)

Sets the primary group for the user. If either is invalid, does nothing.

Parameters:

theUserName - the user name

theGroupName - the group name

(JavaScript Function) removeFromGroup

public void (JavaScript Function) removeFromGroup(java.lang.String theUserName,
                                       java.lang.String theGroupName)

Removes a user from a group.

Parameters:

theUserName - the user name

theGroupName - the name for the group

(JavaScript Function) getUserGroups

public Group[] (JavaScript Function) getUserGroups(java.lang.String theUserName)

Returns an array of Groups that the specified user is in.

Parameters:

theUserName -

Returns:

Array of Groups

(JavaScript Function) getACLs

public ACL[] (JavaScript Function) getACLs(int theId,
                                boolean theGetUserACLs)

Returns the list of user or group ACLs for the specified id, where theId is either a user id or group id depending on whether theGetUserACLs is true or false.

Parameters:

theId - the user id or group id for which to get either user or group ACLs

theGetUserACLs - specifies whether theId is for a user (for user ACLs) or group (for group ACLs)

Returns:

an Array of ACLs

(JavaScript Function) getViewLevel

public int (JavaScript Function) getViewLevel(java.lang.String theUserName,
                                   java.lang.String theGroupName)

Returns the view level for the specified user/group. Returns the user's view level, unless the group specifies one.

Parameters:

theUserName - the username.

theGroupName - the group name.

Returns:

the view level.

(JavaScript Function) getEditLevel

public int (JavaScript Function) getEditLevel(java.lang.String theUserName,
                                   java.lang.String theGroupName)

Returns the edit level for the specified user/group. Returns the user's edit level, unless the group specifies one.

Parameters:

theUserName - the username.

theGroupName - the group name.

Returns:

the edit level.