com.openkm.sdk4j.impl

Class AuthImpl

java.lang.Object

com.openkm.sdk4j.impl.ClientImpl

com.openkm.sdk4j.impl.AuthImpl

All Implemented Interfaces:

BaseAuth, Serializable

public class AuthImpl
extends ClientImpl
implements BaseAuth, Serializable

Auth

Author:

jllort

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuthImpl(String host) OKMAuth

Method Summary

Modifier and Type	Method and Description
void	assignRole(String userId, String roleId) Method to assign a role
void	changeSecurity(String uuid, ChangeSecurity changeSecurity) Change several security permissions in the same call.
void	createRole(String roleId, boolean active) Method to create a new role
void	createUser(String userId, String password, String email, String name, boolean active) Method to create a new user
void	deleteRole(String roleId) Method to create a delete a role
void	deleteUser(String userId) Method to delete a user
String	disable2FA() Disable 2FA
String	generate2FASecret() Generate 2FA secret
Map<String,Integer>	getGrantedRoles(String uuid) Get roles permissions from am item (document or folder).
Map<String,Integer>	getGrantedUsers(String uuid) Get user permissions from am item (document or folder).
GrantedUsersAndRolesItem	getGrantedUsersAndRoles(String uuid) Get granted users and roles
List<Profile>	getProfiles(boolean filterByActive) Get all profiles
String	getRefreshToken()
List<String>	getRoles(boolean showAll) Retrieves a list of repository roles.
List<String>	getRolesByUser(String userId) Retrieves a list of roles by user.
String	getSessionId() Get session
InputStream	getTwoFactorQR(String secret) Get 2FA
CommonUser	getUser(String userId) Retrieve information of a given user
Profile	getUserProfile(String userId) Get user profile
List<CommonUser>	getUsers(boolean showAll) Retrieve information of a given user
List<CommonUser>	getUsersByRole(String roleId) Retrieves a list of users by role.
List<Tenant>	getUserTenants() Get a list of available tenants for a user.
String	getUserToken(String userId) Get user token
void	grantRole(String uuid, String roleId, int permissions, boolean recursive) Grant role permissions for a node.
void	grantUser(String uuid, String userId, int permissions, boolean recursive) Add user permissions to a node.
boolean	hasSecurityRecursive() Has security recursive
boolean	isAdmin() Is admin
boolean	isLoginLowercase() Is login lowercase
boolean	isPasswordExpired() Check the password of the user expiration
boolean	isTwoFactorAuthentication() Is two factor authentication
protected String	login(String user, String password)
protected String	login(String user, String password, int expiration, boolean restrictIp)
protected void	logout()
void	overwriteSecurity(String uuid, ChangeSecurity changeSecurity) Change several security permissions in the same call.
void	removeRole(String userId, String roleId) Method to remove a role
void	revokeRole(String uuid, String roleId, int permissions, boolean recursive) Revoke role permissions from a node.
void	revokeUser(String uuid, String userId, int permissions, boolean recursive) Revoke user permissions from a node.
void	setAuthorizationToken(String authorizationToken) setAuthenticationToken
void	setRolePermissions(String uuid, String roleId, int permissions, boolean recursive) Set role permissions for a node.
void	setUserPermissions(String uuid, String userId, int permissions, boolean recursive) Set user permissions to a node
void	setUserProfile(String userId, long profileId) Set the user profile
void	setUserTenant(long tenantId) Update user tenant.
void	updateRole(String roleId, boolean active) Update role information
void	updateUser(String userId, String password, String email, String name, boolean active) Update user information
String	validate2FAAndSaveSecret(String secret, int code) Validate 2FA and save secret
String	verify2FACode(int code) Verify 2FA code

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

getClient, resource, resource, resource

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthImpl

public AuthImpl(String host)

OKMAuth

Method Detail

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

Specified by:

setAuthorizationToken in interface BaseAuth

Parameters:

authorizationToken - the authorization token

login

protected String login(String user,
                       String password)
                throws UnknownException,
                       WebserviceException,
                       AuthenticationException

Throws:

UnknownException

WebserviceException

AuthenticationException

login

protected String login(String user,
                       String password,
                       int expiration,
                       boolean restrictIp)
                throws UnknownException,
                       WebserviceException,
                       AuthenticationException

Throws:

UnknownException

WebserviceException

AuthenticationException

logout

protected void logout()
               throws UnknownException,
                      WebserviceException

Throws:

UnknownException

WebserviceException

getSessionId

public String getSessionId()

Description copied from interface: BaseAuth

Get session

Specified by:

getSessionId in interface BaseAuth

Returns:

String session id

getRefreshToken

public String getRefreshToken()
                       throws UnknownException,
                              WebserviceException

Throws:

UnknownException

WebserviceException

getGrantedUsersAndRoles

public GrantedUsersAndRolesItem getGrantedUsersAndRoles(String uuid)
                                                 throws AccessDeniedException,
                                                        RepositoryException,
                                                        DatabaseException,
                                                        PathNotFoundException,
                                                        UnknownException,
                                                        WebserviceException

Description copied from interface: BaseAuth

Get granted users and roles

Specified by:

getGrantedUsersAndRoles in interface BaseAuth

Parameters:

uuid - Node uuid.

Returns:

GrantedUsersAndRolesItem An object with list the users and roles

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getGrantedRoles

public Map<String,Integer> getGrantedRoles(String uuid)
                                    throws AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException,
                                           PathNotFoundException,
                                           WebserviceException,
                                           UnknownException

Description copied from interface: BaseAuth

Get roles permissions from am item (document or folder).

Specified by:

getGrantedRoles in interface BaseAuth

Parameters:

uuid - Node uuid.

Returns:

Map A hashmap with pairs of role / permissions.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getGrantedUsers

public Map<String,Integer> getGrantedUsers(String uuid)
                                    throws AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException,
                                           PathNotFoundException,
                                           WebserviceException,
                                           UnknownException

Description copied from interface: BaseAuth

Get user permissions from am item (document or folder).

Specified by:

getGrantedUsers in interface BaseAuth

Parameters:

uuid - Node uuid.

Returns:

Map A hashmap with pairs of user / permissions.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getRoles

public List<String> getRoles(boolean showAll)
                      throws AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             PrincipalAdapterException,
                             WebserviceException,
                             UnknownException

Description copied from interface: BaseAuth

Retrieves a list of repository roles.

Specified by:

getRoles in interface BaseAuth

Parameters:

showAll - If should only return active roles or all them

Returns:

List A collection of repository roles.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PrincipalAdapterException - the principal adapter exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getRolesByUser

public List<String> getRolesByUser(String userId)
                            throws AccessDeniedException,
                                   RepositoryException,
                                   DatabaseException,
                                   PrincipalAdapterException,
                                   WebserviceException,
                                   UnknownException

Description copied from interface: BaseAuth

Retrieves a list of roles by user.

Specified by:

getRolesByUser in interface BaseAuth

Parameters:

userId - A user id.

Returns:

List A repository roles.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PrincipalAdapterException - the principal adapter exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUsers

public List<CommonUser> getUsers(boolean showAll)
                          throws AccessDeniedException,
                                 RepositoryException,
                                 DatabaseException,
                                 PrincipalAdapterException,
                                 UnknownException,
                                 WebserviceException

Description copied from interface: BaseAuth

Retrieve information of a given user

Specified by:

getUsers in interface BaseAuth

Parameters:

showAll - If should only return active users or all them

Returns:

List A collection of repository users.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getUser

public CommonUser getUser(String userId)
                   throws AccessDeniedException,
                          RepositoryException,
                          DatabaseException,
                          PrincipalAdapterException,
                          UnknownException,
                          WebserviceException

Description copied from interface: BaseAuth

Retrieve information of a given user

Specified by:

getUser in interface BaseAuth

Parameters:

userId - A user id.

Returns:

CommonUser The data user

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getUsersByRole

public List<CommonUser> getUsersByRole(String roleId)
                                throws AccessDeniedException,
                                       RepositoryException,
                                       DatabaseException,
                                       PrincipalAdapterException,
                                       UnknownException,
                                       WebserviceException

Description copied from interface: BaseAuth

Retrieves a list of users by role.

Specified by:

getUsersByRole in interface BaseAuth

Parameters:

roleId - A role id.

Returns:

List A repository users.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

revokeRole

public void revokeRole(String uuid,
                       String roleId,
                       int permissions,
                       boolean recursive)
                throws AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       PathNotFoundException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseAuth

Revoke role permissions from a node.

Specified by:

revokeRole in interface BaseAuth

Parameters:

uuid - Node uuid.

roleId - Role name which permissions are changed.

permissions - A mask with the permissions to be removed.

recursive - If the nodePath indicates a folder, the permissions can be applied recursively.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

revokeUser

public void revokeUser(String uuid,
                       String userId,
                       int permissions,
                       boolean recursive)
                throws AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       PathNotFoundException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseAuth

Revoke user permissions from a node.

Specified by:

revokeUser in interface BaseAuth

Parameters:

uuid - Node uuid.

userId - User name which permissions are changed.

permissions - A mask with the permissions to be removed.

recursive - If the nodePath indicates a folder, the permissions can be revoked recursively.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

grantRole

public void grantRole(String uuid,
                      String roleId,
                      int permissions,
                      boolean recursive)
               throws AccessDeniedException,
                      RepositoryException,
                      DatabaseException,
                      PathNotFoundException,
                      UnknownException,
                      WebserviceException

Description copied from interface: BaseAuth

Grant role permissions for a node.

Specified by:

grantRole in interface BaseAuth

Parameters:

uuid - Node uuid.

roleId - Role name which permissions are changed.

permissions - A mask with the permissions to be removed.

recursive - If the nodePath indicates a folder, the permissions can be applied recursively.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

grantUser

public void grantUser(String uuid,
                      String userId,
                      int permissions,
                      boolean recursive)
               throws AccessDeniedException,
                      RepositoryException,
                      DatabaseException,
                      PathNotFoundException,
                      UnknownException,
                      WebserviceException

Description copied from interface: BaseAuth

Add user permissions to a node.

Specified by:

grantUser in interface BaseAuth

Parameters:

uuid - Node uuid.

userId - User name which permissions are changed.

permissions - A mask with the permissions to be added.

recursive - If the nodePath indicated a folder, the permissions can be applied recursively.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createUser

public void createUser(String userId,
                       String password,
                       String email,
                       String name,
                       boolean active)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseAuth

Method to create a new user

Specified by:

createUser in interface BaseAuth

Parameters:

userId - A user id.

password - the password

email - the email

name - the name

active - the active

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteUser

public void deleteUser(String userId)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseAuth

Method to delete a user

Specified by:

deleteUser in interface BaseAuth

Parameters:

userId - A user id.

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

updateUser

public void updateUser(String userId,
                       String password,
                       String email,
                       String name,
                       boolean active)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseAuth

Update user information

Specified by:

updateUser in interface BaseAuth

Parameters:

userId - A user id.

password - the password

email - the email

name - the name

active - the active

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createRole

public void createRole(String roleId,
                       boolean active)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseAuth

Method to create a new role

Specified by:

createRole in interface BaseAuth

Parameters:

roleId - A role id.

active - the active

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteRole

public void deleteRole(String roleId)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseAuth

Method to create a delete a role

Specified by:

deleteRole in interface BaseAuth

Parameters:

roleId - A role id.

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

updateRole

public void updateRole(String roleId,
                       boolean active)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseAuth

Update role information

Specified by:

updateRole in interface BaseAuth

Parameters:

roleId - A role id

active - the active

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

assignRole

public void assignRole(String userId,
                       String roleId)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseAuth

Method to assign a role

Specified by:

assignRole in interface BaseAuth

Parameters:

userId - A user id.

roleId - A role id.

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

removeRole

public void removeRole(String userId,
                       String roleId)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseAuth

Method to remove a role

Specified by:

removeRole in interface BaseAuth

Parameters:

userId - A user id.

roleId - A role id.

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

changeSecurity

public void changeSecurity(String uuid,
                           ChangeSecurity changeSecurity)
                    throws PathNotFoundException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException,
                           UnknownException,
                           WebserviceException

Description copied from interface: BaseAuth

Change several security permissions in the same call.

Specified by:

changeSecurity in interface BaseAuth

Parameters:

uuid - Node uuid.

changeSecurity - the change security

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

overwriteSecurity

public void overwriteSecurity(String uuid,
                              ChangeSecurity changeSecurity)
                       throws PathNotFoundException,
                              AccessDeniedException,
                              RepositoryException,
                              DatabaseException,
                              UnknownException,
                              WebserviceException

Description copied from interface: BaseAuth

Change several security permissions in the same call.

Specified by:

overwriteSecurity in interface BaseAuth

Parameters:

uuid - Node uuid.

changeSecurity - the change security

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getProfiles

public List<Profile> getProfiles(boolean filterByActive)
                          throws PrincipalAdapterException,
                                 WebserviceException,
                                 UnknownException

Description copied from interface: BaseAuth

Get all profiles

Specified by:

getProfiles in interface BaseAuth

Parameters:

filterByActive - the filter by active

Returns:

List A list with all the registered profiles.

Throws:

PrincipalAdapterException - the principal adapter exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserProfile

public Profile getUserProfile(String userId)
                       throws PrincipalAdapterException,
                              WebserviceException,
                              UnknownException

Description copied from interface: BaseAuth

Get user profile

Specified by:

getUserProfile in interface BaseAuth

Parameters:

userId - A user id.

Returns:

Profile Return the profile assigned to a user.

Throws:

PrincipalAdapterException - the principal adapter exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

setUserProfile

public void setUserProfile(String userId,
                           long profileId)
                    throws PrincipalAdapterException,
                           WebserviceException,
                           UnknownException

Description copied from interface: BaseAuth

Set the user profile

Specified by:

setUserProfile in interface BaseAuth

Parameters:

userId - The user id.

profileId - The profile to be assigned.

Throws:

PrincipalAdapterException - the principal adapter exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getUserToken

public String getUserToken(String userId)
                    throws PrincipalAdapterException,
                           WebserviceException,
                           UnknownException

Description copied from interface: BaseAuth

Get user token

Specified by:

getUserToken in interface BaseAuth

Parameters:

userId - A user id.

Returns:

String Return the token to a user.

Throws:

PrincipalAdapterException - the principal adapter exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

setUserPermissions

public void setUserPermissions(String uuid,
                               String userId,
                               int permissions,
                               boolean recursive)
                        throws AccessDeniedException,
                               RepositoryException,
                               DatabaseException,
                               PathNotFoundException,
                               UnknownException,
                               WebserviceException

Description copied from interface: BaseAuth

Set user permissions to a node

Specified by:

setUserPermissions in interface BaseAuth

Parameters:

uuid - Node uuid.

userId - User name which permissions are set.

permissions - User name which permissions are set.

recursive - recursive – If the nodePath indicated a folder, the permissions can be applied recursively.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setRolePermissions

public void setRolePermissions(String uuid,
                               String roleId,
                               int permissions,
                               boolean recursive)
                        throws AccessDeniedException,
                               RepositoryException,
                               DatabaseException,
                               PathNotFoundException,
                               UnknownException,
                               WebserviceException

Description copied from interface: BaseAuth

Set role permissions for a node.

Specified by:

setRolePermissions in interface BaseAuth

Parameters:

uuid - Node uuid.

roleId - Role name which permissions are set.

permissions - A mask with the permissions to be set.

recursive - If the nodePath indicates a folder, the permissions can be applied recursively.

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getUserTenants

public List<Tenant> getUserTenants()
                            throws AccessDeniedException,
                                   RepositoryException,
                                   DatabaseException,
                                   PathNotFoundException,
                                   UnknownException,
                                   WebserviceException

Description copied from interface: BaseAuth

Get a list of available tenants for a user.

Specified by:

getUserTenants in interface BaseAuth

Returns:

List the list of tenants

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setUserTenant

public void setUserTenant(long tenantId)
                   throws AccessDeniedException,
                          RepositoryException,
                          DatabaseException,
                          PathNotFoundException,
                          UnknownException,
                          WebserviceException

Description copied from interface: BaseAuth

Update user tenant.

Specified by:

setUserTenant in interface BaseAuth

Parameters:

tenantId - tenantId tenant id

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

isAdmin

public boolean isAdmin()
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseAuth

Is admin

Specified by:

isAdmin in interface BaseAuth

Returns:

boolean boolean

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

hasSecurityRecursive

public boolean hasSecurityRecursive()
                             throws UnknownException,
                                    WebserviceException

Description copied from interface: BaseAuth

Has security recursive

Specified by:

hasSecurityRecursive in interface BaseAuth

Returns:

boolean boolean

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception

isLoginLowercase

public boolean isLoginLowercase()
                         throws UnknownException,
                                WebserviceException

Description copied from interface: BaseAuth

Is login lowercase

Specified by:

isLoginLowercase in interface BaseAuth

Returns:

boolean boolean

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception

isPasswordExpired

public boolean isPasswordExpired()
                          throws UnknownException,
                                 WebserviceException

Description copied from interface: BaseAuth

Check the password of the user expiration

Specified by:

isPasswordExpired in interface BaseAuth

Returns:

true when password is expired

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception

isTwoFactorAuthentication

public boolean isTwoFactorAuthentication()
                                  throws UnknownException,
                                         WebserviceException

Description copied from interface: BaseAuth

Is two factor authentication

Specified by:

isTwoFactorAuthentication in interface BaseAuth

Returns:

true active two factor autentication

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception

getTwoFactorQR

public InputStream getTwoFactorQR(String secret)
                           throws PrincipalAdapterException,
                                  UnknownException,
                                  WebserviceException

Description copied from interface: BaseAuth

Get 2FA

Specified by:

getTwoFactorQR in interface BaseAuth

Parameters:

secret - the secret

Returns:

stream with 2FA qr image

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

generate2FASecret

public String generate2FASecret()
                         throws PrincipalAdapterException,
                                UnknownException,
                                WebserviceException

Description copied from interface: BaseAuth

Generate 2FA secret

Specified by:

generate2FASecret in interface BaseAuth

Returns:

String with 2FA secret

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

validate2FAAndSaveSecret

public String validate2FAAndSaveSecret(String secret,
                                       int code)
                                throws PrincipalAdapterException,
                                       UnknownException,
                                       WebserviceException

Description copied from interface: BaseAuth

Validate 2FA and save secret

Specified by:

validate2FAAndSaveSecret in interface BaseAuth

Parameters:

secret - the secret

code - the code

Returns:

String string

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

disable2FA

public String disable2FA()
                  throws PrincipalAdapterException,
                         UnknownException,
                         WebserviceException

Description copied from interface: BaseAuth

Disable 2FA

Specified by:

disable2FA in interface BaseAuth

Returns:

String string

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

verify2FACode

public String verify2FACode(int code)
                     throws PrincipalAdapterException,
                            UnknownException,
                            WebserviceException

Description copied from interface: BaseAuth

Verify 2FA code

Specified by:

verify2FACode in interface BaseAuth

Parameters:

code - the code

Returns:

int string

Throws:

PrincipalAdapterException - the principal adapter exception

UnknownException - the unknown exception

WebserviceException - the webservice exception