Package eirb.pub.app.server

Class ServerVault

java.lang.Object

eirb.pub.app.server.ServerVault

public class ServerVault
extends Object

Constructor Summary

Constructors

Constructor	Description
ServerVault(ServerAuthentication authentication)

Method Summary

Modifier and Type	Method	Description
void	deleteVault(ServerVaultFile serverVaultFile)	Delete the vault from the server
void	deleteVault(UUID id)	Delete the vault with the given id
ServerVaultFile	getVault(ServerVaultFile serverVaultFile)	Retrieve a Vault from the server (get updated vault)
ServerVaultFile	getVault(UUID id)	Retrieve a Vault from the server
List<Pair<UUID,String>>	getVaultList()	Get the list of the vault owned by the authenticated user *
ServerVaultFile	postVault(VaultFile vault)	Send a new VaultFile to the server.
void	updateVault(ServerVaultFile vault)	Update a Vault by submitting a new version to the server

Methods inherited from class java.lang.Object

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

Constructor Details

ServerVault

public ServerVault(ServerAuthentication authentication)

Method Details

getVaultList

public List<Pair<UUID,String>> getVaultList()
                                     throws IOException,
AuthenticationException,
TimeoutException

Get the list of the vault owned by the authenticated user *

Returns:

the HashMap with (key=id, value=vaultName) of the user

Throws:

IOException - If an error occurred with the server connection

AuthenticationException - if the user is no longer authenticated

TimeoutException

getVault

public ServerVaultFile getVault(UUID id)
                         throws ForbiddenAccessException,
AuthenticationException,
IOException,
VaultFileIOException,
VaultFileFormatException,
TimeoutException

Retrieve a Vault from the server

Parameters:

id - , id of the vault

Returns:

the vault with the given id, not a GetRequest because not possible to have a body with a getRequest

Throws:

AuthenticationException - if the user is not authenticated

ForbiddenAccessException - if the user do not have access to the desired vault (or don't exist on the server anymore)

VaultFileIOException - if the building operation of the vaultFile failed

VaultFileFormatException - If the format of the vault file is not respected

IOException - if an error occurred with the connection

TimeoutException

getVault

public ServerVaultFile getVault(ServerVaultFile serverVaultFile)
                         throws ForbiddenAccessException,
AuthenticationException,
IOException,
VaultFileIOException,
VaultFileFormatException,
TimeoutException

Retrieve a Vault from the server (get updated vault)

Parameters:

serverVaultFile - vault that we want to get the update from the server

Returns:

the vault with the given id, not a GetRequest because not possible to have a body with a getRequest

Throws:

AuthenticationException - if the user is not authenticated

ForbiddenAccessException - if the user do not have access to the desired vault (or don't exist on the server anymore)

VaultFileIOException - if the building operation of the vaultFile failed

VaultFileFormatException - If the format of the vault file is not respected

TimeoutException - if the request took too much time to complete

IOException - if an error occurred with the connection

updateVault

public void updateVault(ServerVaultFile vault)
                 throws ForbiddenAccessException,
AuthenticationException,
VaultUpdateException,
IOException,
TimeoutException

Update a Vault by submitting a new version to the server

If an update was made on the server, an error will be raised with the VaultFile present on the server to merge it with the current one. This one can be found in the Exception, rerun this method to correctly push the desired version of the Vault

Parameters:

vault - Version of the ServerVaultFile to be push to the server

Throws:

ForbiddenAccessException - The authenticated user can't update the give Vault (check VaultFile Server id provided)

AuthenticationException - The user is not authenticated

TimeoutException - if the request took too much time to complete

VaultUpdateException - A more recent version of the vault is present of the server, merge the VaultFile present in the Exception with the current one and remake the request

IOException

postVault

public ServerVaultFile postVault(VaultFile vault)
                          throws AuthenticationException,
IOException,
TimeoutException

Send a new VaultFile to the server. It will be saved with the other vaultFile from the authenticated user. Return a ServerVaultFile which contains the vault, id and hash of the vault

Update the vaultFile with the server-id of the uploaded vault

/!\ Warning this method is used to create a new Vault in the user account not to update an existing one

Parameters:

vault - , type: VaultFile

Throws:

AuthenticationException - If the user is not authenticated

TimeoutException - if the request took too much time to complete

IOException - If the connection with the server breaks

deleteVault

public void deleteVault(UUID id)
                 throws ForbiddenAccessException,
AuthenticationException,
IOException,
TimeoutException

Delete the vault with the given id

Parameters:

id - id of the vault we want to delete

Throws:

IOException - If a problem occurres with the server connection

AuthenticationException - If the user is not authenticated (or the token is outdated)

TimeoutException - if the request took too much time to complete

ForbiddenAccessException - Can't delete the vault because the user has no access to the ressource

deleteVault

public void deleteVault(ServerVaultFile serverVaultFile)
                 throws IOException,
ForbiddenAccessException,
AuthenticationException,
TimeoutException

Delete the vault from the server

Parameters:

serverVaultFile - vault to remove from the server

Throws:

IOException - If a problem occurres with the server connection

AuthenticationException - If the user is not authenticated (or the token is outdated)

TimeoutException - if the request took too much time to complete

ForbiddenAccessException - Can't delete the vault because the user has no access to the ressource