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 com.vordel.api.nm.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

client, debug, loggingFilter, password, rootWebResource, trustStoreFilename, trustStorePassword, url, username

Constructor Summary

Constructors

Constructor and Description
AdminUsersClient(java.lang.String url, java.lang.String username, java.lang.String password, boolean debug) Constructor.
AdminUsersClient(java.lang.String url, java.lang.String username, java.lang.String password, java.lang.String trustStoreFilename, java.lang.String trustStorePassword, boolean debug) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.vordel.api.adminusers.model.AdminUserStore	getAdminUserStore()
com.vordel.api.adminusers.model.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

getUrl, handleError, logDebug, 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(java.lang.String url,
                java.lang.String username,
                java.lang.String password,
                java.lang.String trustStoreFilename,
                java.lang.String trustStorePassword,
                boolean debug)
                 throws com.vordel.api.nm.NodeManagerAPIException

Constructor.

Parameters:

url - The Node Manager URL, e.g. https://localhost:8090/api.

username - The username

password - The password

trustStoreFilename - SSL trust store

trustStorePassword - SSL trust store password

debug - Debug trace on/off

Throws:

com.vordel.api.nm.NodeManagerAPIException

AdminUsersClient

public AdminUsersClient(java.lang.String url,
                java.lang.String username,
                java.lang.String password,
                boolean debug)
                 throws com.vordel.api.nm.NodeManagerAPIException

Constructor.

Parameters:

url - The Node Manager URL, e.g. https://localhost:8090/api.

username - The username

password - The password

debug - Debug trace on/off

Throws:

com.vordel.api.nm.NodeManagerAPIException

Method Detail

resetOwnPassword

public void resetOwnPassword(java.lang.String newPassword)
                      throws com.vordel.api.nm.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:

com.vordel.api.nm.NodeManagerAPIException

getAdminUsersVersion

public com.vordel.api.adminusers.model.AdminUsersVersion getAdminUsersVersion()
                                                                       throws com.vordel.api.nm.NodeManagerAPIException

Gets the AdminUsersVersion by via the rest API

Throws:

com.vordel.api.nm.NodeManagerAPIException

getAdminUserStore

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

Throws:

com.vordel.api.nm.NodeManagerAPIException

updateAdminUserStore

public com.vordel.api.adminusers.model.AdminUserStore updateAdminUserStore(com.vordel.api.adminusers.model.AdminUserStore adminUserStore,
                                                                  boolean propagateStore)
                                                                    throws com.vordel.api.nm.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:

Throws:

com.vordel.api.nm.NodeManagerAPIException

strongPassword

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

Check if a given password matches the Node Managers password policy

Parameters:

userName - The user whose new password is for verification

newPassword - The old password for verification

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

Returns:

The Password Status

Throws:

com.vordel.api.nm.NodeManagerAPIException