com.vordel.api.adminusers.client

Class AdminUsersClient

java.lang.Object

com.vordel.api.nm.NodeManagerClient

com.vordel.api.adminusers.client.AdminUsersClient

public class AdminUsersClient
extends NodeManagerClient

Admin Users REST API Java client helper class. It invokes the Node Manager Admin User REST API. The Admin Users API is exposed by the Node Manager. Refer to REST API documentation for more information on the Admin Users API.

Field Summary

Fields inherited from class com.vordel.api.nm.NodeManagerClient

debug

Constructor Summary

Constructors

Constructor and Description
AdminUsersClient(ConnectionContext cc) Constructor.

Method Summary

Modifier and Type	Method and Description
com.vordel.api.adminusers.model.AdminUserStore	getAdminUserStore()
com.vordel.domain.rbac.AdminUsersVersion	getAdminUsersVersion() Gets the AdminUsersVersion by via the rest API
void	resetOwnPassword(java.lang.String newPassword) This method calls the Admin Users REST API in the Node Manager to reset the password of the logged in user.
com.vordel.security.password.PasswordStatus	strongPassword(java.lang.String userName, java.lang.String oldPassword, java.lang.String newPassword) Check if a given password matches the Node Managers password policy
com.vordel.api.adminusers.model.AdminUserStore	updateAdminUserStore(com.vordel.api.adminusers.model.AdminUserStore adminUserStore, boolean propagateStore) Use to update the Admin User Store

Methods inherited from class com.vordel.api.nm.NodeManagerClient

createConnectionContext, createConnectionContext, createConnectionContext, getRootWebResource, getUrl, handleError, logDebug, path, setConnectTimeout, setDebug, setReadTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminUsersClient

public AdminUsersClient(ConnectionContext cc)
                 throws NodeManagerAPIException

Constructor.

Parameters:

cc - The ConnectionContext, encapsulating all connectivity details to the Node Manager

Throws:

NodeManagerAPIException - If the client could not be instantiated.

Method Detail

resetOwnPassword

public void resetOwnPassword(java.lang.String newPassword)
                      throws NodeManagerAPIException

This method calls the Admin Users REST API in the Node Manager to reset the password of the logged in user. The old password is not passed to this method as it has already been passed to the constructor.

Parameters:

newPassword - The new pasword.

Throws:

NodeManagerAPIException - If the new password cannot be set.

getAdminUsersVersion

public com.vordel.domain.rbac.AdminUsersVersion getAdminUsersVersion()
                                                              throws NodeManagerAPIException

Gets the AdminUsersVersion by via the rest API

Returns:

The latest version of the Admin Users configuration.

Throws:

NodeManagerAPIException - If the version cannot be determined.

getAdminUserStore

public com.vordel.api.adminusers.model.AdminUserStore getAdminUserStore()
                                                                 throws NodeManagerAPIException

Throws:

NodeManagerAPIException

updateAdminUserStore

public com.vordel.api.adminusers.model.AdminUserStore updateAdminUserStore(com.vordel.api.adminusers.model.AdminUserStore adminUserStore,
                                                                           boolean propagateStore)
                                                                    throws NodeManagerAPIException

Use to update the Admin User Store

Parameters:

adminUserStore - The updated AdminUserStore

propagateStore - Set this to true if the Admin Node Manager should propagate the store to other Node Managers

Returns:

The latest copy of the AdminUserStore

Throws:

NodeManagerAPIException - If update failed

strongPassword

public com.vordel.security.password.PasswordStatus strongPassword(java.lang.String userName,
                                                                  java.lang.String oldPassword,
                                                                  java.lang.String newPassword)
                                                           throws NodeManagerAPIException

Check if a given password matches the Node Managers password policy

Parameters:

userName - The user whose new password is for verification

oldPassword - The old password for verification

newPassword - The new password to see if it conforms to password policy

Returns:

The Password Status

Throws:

NodeManagerAPIException - If the passwords strength could not be evaluated