Inherits com.boschrexroth.mlpi.MlpiComponent.

Classes | |
| class | ExpirationDetails |
| enum | ExpirationTimeUnit |
| class | GroupDetails |
| class | GroupInfo |
| class | GroupPolicies |
| class | PasswordPolicies |
| enum | PersistenceType |
| class | UserDetails |
| class | UserInfo |
| class | UserPolicies |
Public Member Functions | |
| native UserPolicies | getUserPolicies () |
| UserPolicies | GetUserPolicies () |
| native PasswordPolicies | getPasswordPolicies () |
| PasswordPolicies | GetPasswordPolicies () |
| native UserInfo[] | getAllUserInfos () |
| UserInfo[] | GetAllUserInfos () |
| native void | addUser (UserDetails userDetails, String tmpPassword) |
| void | AddUser (UserDetails userDetails, String tmpPassword) |
| native UserDetails | getUser (String username) |
| UserDetails | GetUser (String username) |
| native void | setUser (UserDetails userDetails) |
| void | SetUser (UserDetails userDetails) |
| native void | deleteUser (String username) |
| void | DeleteUser (String username) |
| native void | changePassword (String username, String oldPassword, String newPassword) |
| void | ChangePassword (String username, String oldPassword, String newPassword) |
| native GroupInfo[] | getAllGroupInfos () |
| GroupInfo[] | GetAllGroupInfos () |
| native String[] | getAllGroupsOfUser (String username) |
| String[] | GetAllGroupsOfUser (String username) |
| native String[] | getAllUsersOfGroup (String groupName) |
| String[] | GetAllUsersOfGroup (String groupName) |
| native void | addUserToGroup (String groupName, String username) |
| void | AddUserToGroup (String groupName, String username) |
| native void | removeUserFromGroup (String groupName, String username) |
| void | RemoveUserFromGroup (String groupName, String username) |
| native void | setUsersOfGroup (String groupName, String[] usernames) |
| void | SetUsersOfGroup (String groupName, String[] usernames) |
| native void | setGroupsOfUser (String username, String[] groupNames) |
| void | SetGroupsOfUser (String username, String[] groupNames) |
| native GroupPolicies | getGroupPolicies () |
| GroupPolicies | GetGroupPolicies () |
| native void | resetPassword (String username, String newPassword) |
| void | ResetPassword (String username, String newPassword) |
| native void | addGroup (GroupDetails groupDetails) |
| void | AddGroup (GroupDetails groupDetails) |
| native GroupDetails | getGroup (String groupName) |
| GroupDetails | GetGroup (String groupName) |
| native void | setGroup (GroupDetails groupDetails) |
| void | SetGroup (GroupDetails groupDetails) |
| native void | deleteGroup (String groupName) |
| void | DeleteGroup (String groupName) |
| native String[] | getAllPermissions () |
| String[] | GetAllPermissions () |
| native void | setPermissionsOfGroup (String groupName, String[] permissions) |
| void | SetPermissionsOfGroup (String groupName, String[] permissions) |
| native String[] | getAllPermissionsOfGroup (String groupName) |
| String[] | GetAllPermissionsOfGroup (String groupName) |
| native void | setAuthorizedGroupsOfPermission (String permission, String[] groupNames) |
| void | SetAuthorizedGroupsOfPermission (String permission, String[] groupNames) |
| native String[] | getAllAuthorizedGroupsOfPermission (String permission) |
| String[] | GetAllAuthorizedGroupsOfPermission (String permission) |
| native void | addPermissionToGroup (String groupName, String permission) |
| void | AddPermissionToGroup (String groupName, String permission) |
| native void | removePermissionFromGroup (String groupName, String permission) |
| void | RemovePermissionFromGroup (String groupName, String permission) |
Class definition of the AccessControlLib.
Definition at line 63 of file AccessControl.java.
| native UserPolicies com.boschrexroth.mlpi.AccessControl.getUserPolicies | ( | ) |
This method returns information regarding the policies that apply to all users.
mlpiAccessControlGetUserPolicies, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetUserPolicies().

|
inline |
Definition at line 321 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getPasswordPolicies(), and com.boschrexroth.mlpi.AccessControl.getUserPolicies().

| native PasswordPolicies com.boschrexroth.mlpi.AccessControl.getPasswordPolicies | ( | ) |
This method returns information regarding the password policies that apply to all users.
mlpiAccessControlGetPasswordPolicies, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetPasswordPolicies(), and com.boschrexroth.mlpi.AccessControl.GetUserPolicies().

|
inline |
Definition at line 337 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getAllUserInfos(), and com.boschrexroth.mlpi.AccessControl.getPasswordPolicies().

| native UserInfo [] com.boschrexroth.mlpi.AccessControl.getAllUserInfos | ( | ) |
This method returns information regarding all the users currently found within the user manager located on the target device.
mlpiAccessControlGetAllUserInfos, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetAllUserInfos(), and com.boschrexroth.mlpi.AccessControl.GetPasswordPolicies().

|
inline |
Definition at line 353 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.addUser(), and com.boschrexroth.mlpi.AccessControl.getAllUserInfos().

| native void com.boschrexroth.mlpi.AccessControl.addUser | ( | UserDetails | userDetails, |
| String | tmpPassword | ||
| ) |
This method adds a new user in the target that can be used for authentication. Once the user is added, the password shall be changed immediately by logging in using the temporary password.
| [in] | userDetails | Object that contains the information of the new user. |
| [in] | temporaryPassword | Temporary password that is suggested to be modified during first login. |
mlpiAccessControlAddUser, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.AddUser(), and com.boschrexroth.mlpi.AccessControl.GetAllUserInfos().

|
inline |
Definition at line 370 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.addUser(), and com.boschrexroth.mlpi.AccessControl.getUser().

| native UserDetails com.boschrexroth.mlpi.AccessControl.getUser | ( | String | username | ) |
This method returns the user details of a specific user.
| [in] | username | Username that identifies the user, whose information will be retrieved.. |
mlpiAccessControlGetUser, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.AddUser(), and com.boschrexroth.mlpi.AccessControl.GetUser().

|
inline |
Definition at line 387 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getUser(), and com.boschrexroth.mlpi.AccessControl.setUser().

| native void com.boschrexroth.mlpi.AccessControl.setUser | ( | UserDetails | userDetails | ) |
This method allows to modify the information of a user. Within the userDetails argument, the correct Id of the user (if known) or username must be given.
| [in] | userDetails | Object that contains the information of the user to be modified. |
mlpiAccessControlSetUser, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetUser(), and com.boschrexroth.mlpi.AccessControl.SetUser().

|
inline |
Definition at line 403 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.deleteUser(), and com.boschrexroth.mlpi.AccessControl.setUser().

| native void com.boschrexroth.mlpi.AccessControl.deleteUser | ( | String | username | ) |
This method allows to delete a user specified by a given username.
| [in] | username | Username that identifies the user that is to be deleted. |
mlpiAccessControlDeleteUser, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.DeleteUser(), and com.boschrexroth.mlpi.AccessControl.SetUser().

|
inline |
Definition at line 419 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.changePassword(), and com.boschrexroth.mlpi.AccessControl.deleteUser().

| native void com.boschrexroth.mlpi.AccessControl.changePassword | ( | String | username, |
| String | oldPassword, | ||
| String | newPassword | ||
| ) |
This method allows to change the password of a specific user.
| [in] | username | Username that identifies the user, whose password will be changed. |
| [in] | oldPassword | String that identifies the current password of the specified user. |
| [in] | newPassword | String that identifies the new password to be set for the specified user. |
mlpiAccessControlChangePassword, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.ChangePassword(), and com.boschrexroth.mlpi.AccessControl.DeleteUser().

|
inline |
Definition at line 437 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.changePassword(), and com.boschrexroth.mlpi.AccessControl.getAllGroupInfos().

| native GroupInfo [] com.boschrexroth.mlpi.AccessControl.getAllGroupInfos | ( | ) |
This method returns information regarding all the groups of users currently supported by the user manager located on the target device.
mlpiAccessControlGetAllGroupInfos, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.ChangePassword(), and com.boschrexroth.mlpi.AccessControl.GetAllGroupInfos().

|
inline |
Definition at line 453 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getAllGroupInfos(), and com.boschrexroth.mlpi.AccessControl.getAllGroupsOfUser().

| native String [] com.boschrexroth.mlpi.AccessControl.getAllGroupsOfUser | ( | String | username | ) |
This method returns the group name of all the groups assigned to the specified user.
| [in] | username | Username that identifies the user from which the group names will be retrieved. |
mlpiAccessControlGetAllGroupsOfUser, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetAllGroupInfos(), and com.boschrexroth.mlpi.AccessControl.GetAllGroupsOfUser().

|
inline |
Definition at line 470 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getAllGroupsOfUser(), and com.boschrexroth.mlpi.AccessControl.getAllUsersOfGroup().

| native String [] com.boschrexroth.mlpi.AccessControl.getAllUsersOfGroup | ( | String | groupName | ) |
This method returns the username of all the users assigned to the specified group.
| [in] | groupName | Group name that identifies the group from which the usernames will be retrieved. |
mlpiAccessControlGetAllUsersOfGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetAllGroupsOfUser(), and com.boschrexroth.mlpi.AccessControl.GetAllUsersOfGroup().

|
inline |
Definition at line 487 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.addUserToGroup(), and com.boschrexroth.mlpi.AccessControl.getAllUsersOfGroup().

| native void com.boschrexroth.mlpi.AccessControl.addUserToGroup | ( | String | groupName, |
| String | username | ||
| ) |
This method allows to add a user to a specified group. In other words, the user will be identified as a member of the assigned group.
| [in] | groupName | Name that identifies the group to which the user will be assigned. |
| [in] | username | Name that identifies the user that is to be assigned to the specified group. |
mlpiAccessControlAddUserToGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.AddUserToGroup(), and com.boschrexroth.mlpi.AccessControl.GetAllUsersOfGroup().

|
inline |
Definition at line 504 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.addUserToGroup(), and com.boschrexroth.mlpi.AccessControl.removeUserFromGroup().

| native void com.boschrexroth.mlpi.AccessControl.removeUserFromGroup | ( | String | groupName, |
| String | username | ||
| ) |
This method allows to remove a user from a specified group. In other words, the user will not be identified as a member of the assigned group and hence, it won't have the group permissions anymore.
| [in] | groupName | Name that identifies the group from which the user will be removed. |
| [in] | username | Name that identifies the user that is to be removed from the specified group |
mlpiAccessControlRemoveUserFromGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.AddUserToGroup(), and com.boschrexroth.mlpi.AccessControl.RemoveUserFromGroup().

|
inline |
Definition at line 521 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.removeUserFromGroup(), and com.boschrexroth.mlpi.AccessControl.setUsersOfGroup().

| native void com.boschrexroth.mlpi.AccessControl.setUsersOfGroup | ( | String | groupName, |
| String[] | usernames | ||
| ) |
This method allows to set the Users members of a Group. It is capable of adding multiple new users to a group or deleting pre-existing ones in the group. It is recommended to first use the function GetAllUsersOfGroup().
| [in] | groupName | Name that identifies the group to which the users will be assigned. |
| [in] | usernames | Array of usernames that will be assigned to the group. |
mlpiAccessControlSetUsersOfGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.RemoveUserFromGroup(), and com.boschrexroth.mlpi.AccessControl.SetUsersOfGroup().

|
inline |
Definition at line 538 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.setGroupsOfUser(), and com.boschrexroth.mlpi.AccessControl.setUsersOfGroup().

| native void com.boschrexroth.mlpi.AccessControl.setGroupsOfUser | ( | String | username, |
| String[] | groupNames | ||
| ) |
This method allows to set the Groups of a User. It is capable of adding multiple new groups to a user or deleting pre-existing ones in the user. It is recommended to first use the function GetAllGroupsOfUser().
| [in] | username | Name that identifies the user to which the groups will be assigned. |
| [in] | groupNames | Array of group names that will be assigned to the user. |
mlpiAccessControlSetGroupsOfUser, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.SetGroupsOfUser(), and com.boschrexroth.mlpi.AccessControl.SetUsersOfGroup().

|
inline |
Definition at line 555 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getGroupPolicies(), and com.boschrexroth.mlpi.AccessControl.setGroupsOfUser().

| native GroupPolicies com.boschrexroth.mlpi.AccessControl.getGroupPolicies | ( | ) |
This method returns information regarding the policies that apply to all groups.
mlpiAccessControlGetGroupPolicies, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetGroupPolicies(), and com.boschrexroth.mlpi.AccessControl.SetGroupsOfUser().

|
inline |
Definition at line 571 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getGroupPolicies(), and com.boschrexroth.mlpi.AccessControl.resetPassword().

| native void com.boschrexroth.mlpi.AccessControl.resetPassword | ( | String | username, |
| String | newPassword | ||
| ) |
This method allows to reset the password of a specific user. It is recommended that only a user acting as an administrator has the permission to use this method.
| [in] | username | Username that identifies the user, whose password will be reset. |
| [in] | newPassword | String that identifies the new password for the specified user. |
mlpiAccessControlResetPassword, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetGroupPolicies(), and com.boschrexroth.mlpi.AccessControl.ResetPassword().

|
inline |
Definition at line 588 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.addGroup(), and com.boschrexroth.mlpi.AccessControl.resetPassword().

| native void com.boschrexroth.mlpi.AccessControl.addGroup | ( | GroupDetails | groupDetails | ) |
This method adds a new group in the target. Users can be members of groups. This membership is used to manage permissions of groups and hence, the member users.
| [in] | groupDetails | Object that contains the information of the new group. |
mlpiAccessControlAddGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.AddGroup(), and com.boschrexroth.mlpi.AccessControl.ResetPassword().

|
inline |
Definition at line 604 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.addGroup(), and com.boschrexroth.mlpi.AccessControl.getGroup().

| native GroupDetails com.boschrexroth.mlpi.AccessControl.getGroup | ( | String | groupName | ) |
This method returns the user details of a specific group.
| [in] | groupName | Group name that identifies the group, whose information will be retrieved.. |
mlpiAccessControlGetGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.AddGroup(), and com.boschrexroth.mlpi.AccessControl.GetGroup().

|
inline |
Definition at line 621 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getGroup(), and com.boschrexroth.mlpi.AccessControl.setGroup().

| native void com.boschrexroth.mlpi.AccessControl.setGroup | ( | GroupDetails | groupDetails | ) |
This method allows to modify the information of a group. Within the groupDetails argument, the correct Id of the group (if known) or group name must be given.
| [in] | groupDetails | Object that contains the information of the group to be modified. |
mlpiAccessControlSetGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetGroup(), and com.boschrexroth.mlpi.AccessControl.SetGroup().

|
inline |
Definition at line 637 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.deleteGroup(), and com.boschrexroth.mlpi.AccessControl.setGroup().

| native void com.boschrexroth.mlpi.AccessControl.deleteGroup | ( | String | groupName | ) |
This method allows to delete a group specified by a given group name.
| [in] | groupName | Group name that identifies the group that is to be deleted. |
mlpiAccessControlDeleteGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.DeleteGroup(), and com.boschrexroth.mlpi.AccessControl.SetGroup().

|
inline |
Definition at line 653 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.deleteGroup(), and com.boschrexroth.mlpi.AccessControl.getAllPermissions().

| native String [] com.boschrexroth.mlpi.AccessControl.getAllPermissions | ( | ) |
This method returns all the permissions that can be assigned to the groups.
mlpiAccessControlGetAllPermissions, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.DeleteGroup(), and com.boschrexroth.mlpi.AccessControl.GetAllPermissions().

|
inline |
Definition at line 669 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getAllPermissions(), and com.boschrexroth.mlpi.AccessControl.setPermissionsOfGroup().

| native void com.boschrexroth.mlpi.AccessControl.setPermissionsOfGroup | ( | String | groupName, |
| String[] | permissions | ||
| ) |
This method allows to set the Permissions of a Group. It is capable of assigning multiple new permissions to a group or deleting previously assigned ones. It is recommended to first use the function GetAllPermissionsOfGroup().
| [in] | groupName | Name that identifies the group to which the permissions will be assigned. |
| [in] | permissions | Array of permissions that will be assigned to the group. |
mlpiAccessControlSetPermissionsOfGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetAllPermissions(), and com.boschrexroth.mlpi.AccessControl.SetPermissionsOfGroup().

|
inline |
Definition at line 686 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getAllPermissionsOfGroup(), and com.boschrexroth.mlpi.AccessControl.setPermissionsOfGroup().

| native String [] com.boschrexroth.mlpi.AccessControl.getAllPermissionsOfGroup | ( | String | groupName | ) |
This method returns all the permissions assigned to the specified group.
| [in] | groupName | Group name that identifies the group from which the permissions will be retrieved. |
mlpiAccessControlGetAllPermissionsOfGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetAllPermissionsOfGroup(), and com.boschrexroth.mlpi.AccessControl.SetPermissionsOfGroup().

|
inline |
Definition at line 703 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getAllPermissionsOfGroup(), and com.boschrexroth.mlpi.AccessControl.setAuthorizedGroupsOfPermission().

| native void com.boschrexroth.mlpi.AccessControl.setAuthorizedGroupsOfPermission | ( | String | permission, |
| String[] | groupNames | ||
| ) |
This method allows to set the authorized groups of a permission. It is capable of authorizing multiple new groups for a permission or deleting previously authorized ones. It is recommended to first use the function GetAllAuthorizedGroupsOfPermission().
| [in] | permission | Name that identifies the permission for which the groups will be given authorization. |
| [in] | groupNames | Array of group names that will be authorized for the given permission. |
mlpiAccessControlSetAuthorizedGroupsOfPermission, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetAllPermissionsOfGroup(), and com.boschrexroth.mlpi.AccessControl.SetAuthorizedGroupsOfPermission().

|
inline |
Definition at line 720 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.getAllAuthorizedGroupsOfPermission(), and com.boschrexroth.mlpi.AccessControl.setAuthorizedGroupsOfPermission().

| native String [] com.boschrexroth.mlpi.AccessControl.getAllAuthorizedGroupsOfPermission | ( | String | permission | ) |
This method returns all the groups authorized for a specific permission.
| [in] | permission | Name that identifies the permission from which the groups will be retrieved. |
mlpiAccessControlGetAllAuthorizedGroupsOfPermission, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.GetAllAuthorizedGroupsOfPermission(), and com.boschrexroth.mlpi.AccessControl.SetAuthorizedGroupsOfPermission().

|
inline |
Definition at line 737 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.addPermissionToGroup(), and com.boschrexroth.mlpi.AccessControl.getAllAuthorizedGroupsOfPermission().

| native void com.boschrexroth.mlpi.AccessControl.addPermissionToGroup | ( | String | groupName, |
| String | permission | ||
| ) |
This method allows to assign a permission to a specified group. In other words, the users members of the group will be authorized for the given permission.
| [in] | groupName | Name that identifies the group to which the user will be assigned. |
| [in] | permission | Name that identifies the permission that is to be assigned to the specified group. |
mlpiAccessControlAddPermissionToGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.AddPermissionToGroup(), and com.boschrexroth.mlpi.AccessControl.GetAllAuthorizedGroupsOfPermission().

|
inline |
Definition at line 754 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.addPermissionToGroup(), and com.boschrexroth.mlpi.AccessControl.removePermissionFromGroup().

| native void com.boschrexroth.mlpi.AccessControl.removePermissionFromGroup | ( | String | groupName, |
| String | permission | ||
| ) |
This method allows to remove a permission from a specified group. In other words, the users members of the group will not be authorized anymore for the specified permission.
| [in] | groupName | Name that identifies the group from which the user will be removed. |
| [in] | permission | Name that identifies the permission that is to be removed from the specified group |
mlpiAccessControlRemovePermissionFromGroup, where you can find further documentation. Referenced by com.boschrexroth.mlpi.AccessControl.AddPermissionToGroup(), and com.boschrexroth.mlpi.AccessControl.RemovePermissionFromGroup().

|
inline |
Definition at line 771 of file AccessControl.java.
References com.boschrexroth.mlpi.AccessControl.removePermissionFromGroup().
