com.emc.vipr.client

Class AuthClient

java.lang.Object

com.emc.vipr.client.AuthClient

public class AuthClient
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AuthClient(ClientConfig config)
AuthClient(RestClient client)
AuthClient(java.lang.String host) Convenience method for calling constructor with new ClientConfig().withHost(host)
AuthClient(java.lang.String host, boolean ignoreCertificates) Convenience method for calling constructor with new ClientConfig().withHost(host).withIgnoringCertificates(ignoreCertificates)

Method Summary

Modifier and Type	Method and Description
void	changePassword(java.lang.String username, java.lang.String oldPassword, java.lang.String password)
void	forceLogout()
RestClient	getClient()
boolean	isLoggedIn()
java.lang.String	login(java.lang.String username, java.lang.String password) Performs a login operation.
void	logout()
void	logoutUser(java.lang.String username, boolean force, boolean includeProxyTokens)
java.lang.String	proxyToken()
void	validatePasswordChange(java.lang.String username, java.lang.String oldPassword, java.lang.String password)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthClient

public AuthClient(RestClient client)

AuthClient

public AuthClient(java.lang.String host)

Convenience method for calling constructor with new ClientConfig().withHost(host)

Parameters:

host - Hostname or IP address for the Virtual IP of the target environment.

AuthClient

public AuthClient(java.lang.String host,
                  boolean ignoreCertificates)

Convenience method for calling constructor with new ClientConfig().withHost(host).withIgnoringCertificates(ignoreCertificates)

Parameters:

host - Hostname or IP address for the Virtual IP of the target environment.

ignoreCertificates - True if SSL certificates should be ignored.

AuthClient

public AuthClient(ClientConfig config)

Method Detail

getClient

public RestClient getClient()

login

public java.lang.String login(java.lang.String username,
                              java.lang.String password)

Performs a login operation. The token is automatically associated with this client connection.

Parameters:

username - The username.

password - The password.

Returns:

The authentication token.

proxyToken

public java.lang.String proxyToken()

logout

public void logout()

forceLogout

public void forceLogout()

logoutUser

public void logoutUser(java.lang.String username,
                       boolean force,
                       boolean includeProxyTokens)

isLoggedIn

public boolean isLoggedIn()

changePassword

public void changePassword(java.lang.String username,
                           java.lang.String oldPassword,
                           java.lang.String password)

validatePasswordChange

public void validatePasswordChange(java.lang.String username,
                                   java.lang.String oldPassword,
                                   java.lang.String password)