org.duracloud.account.db.util

Interface AccountService

All Known Implementing Classes:

AccountServiceImpl, AccountServiceSecuredImpl

public interface AccountService

An interface for manipulating account data.

Author:

"Daniel Bernstein (dbernstein@duraspace.org)"

Method Summary

Modifier and Type	Method and Description
void	addStorageProvider(org.duracloud.storage.domain.StorageProviderType storageProviderType) Adds a new secondary storage provider to this account.
void	deleteUserInvitation(Long invitationId) Deletes an invitation to this account.
Long	getAccountId() This method returns the id of account
org.duracloud.account.db.model.ComputeProviderAccount	getComputeProvider() Retrieves the primary storage provider account info
Set<org.duracloud.account.db.model.UserInvitation>	getPendingInvitations() Gets a listing of the user invitations which are associated with this account.
org.duracloud.account.db.model.StorageProviderAccount	getPrimaryStorageProvider() Retrieves the primary storage provider account info
Set<org.duracloud.account.db.model.StorageProviderAccount>	getSecondaryStorageProviders() Retrieves the info for all secondary storage provider accounts
String	getSubdomain() This method returns the subdomain associated with this account.
Set<org.duracloud.account.db.model.DuracloudUser>	getUsers()
org.duracloud.account.db.model.UserInvitation	inviteUser(String emailAddress, String adminUsername, org.duracloud.notification.Emailer emailer) Invites a user to join this account by sending a notification to the provided email address.
void	removeStorageProvider(Long storageProviderId) Removes a storage provider from the list of secondary storage providers for this account.
org.duracloud.account.db.model.AccountInfo	retrieveAccountInfo()
org.duracloud.account.db.model.ServerDetails	retrieveServerDetails() Retrieves ServerDetails if they are available (if this account type makes user of ServerDetails).
void	setPrimaryStorageProviderRrs(boolean rrs) Sets the primary storage provider to RRS or not
void	storeAccountInfo(String acctName, String orgName, String department)
void	storeAccountStatus(org.duracloud.account.db.model.AccountInfo.AccountStatus status)
void	storeServerDetails(org.duracloud.account.db.model.ServerDetails serverDetails)
void	storeSubdomain(String subdomain)

Method Detail

getAccountId

@Secured(value="role:ROLE_ANONYMOUS, scope:ANY")
Long getAccountId()

This method returns the id of account

Returns:

account id

retrieveAccountInfo

@Secured(value="role:ROLE_ADMIN, scope:SELF_ACCT")
org.duracloud.account.db.model.AccountInfo retrieveAccountInfo()

Returns:

storeAccountInfo

@Secured(value="role:ROLE_OWNER, scope:SELF_ACCT")
void storeAccountInfo(String acctName,
                                                                          String orgName,
                                                                          String department)

Parameters:

acctName -

orgName -

department -

storeAccountStatus

@Secured(value="role:ROLE_OWNER, scope:SELF_ACCT")
void storeAccountStatus(org.duracloud.account.db.model.AccountInfo.AccountStatus status)

Parameters:

status -

retrieveServerDetails

@Secured(value="role:ROLE_ADMIN, scope:SELF_ACCT")
org.duracloud.account.db.model.ServerDetails retrieveServerDetails()

Retrieves ServerDetails if they are available (if this account type makes user of ServerDetails).

Returns:

ServerDetails if available, otherwise null

storeServerDetails

@Secured(value="role:ROLE_OWNER, scope:SELF_ACCT")
void storeServerDetails(org.duracloud.account.db.model.ServerDetails serverDetails)

Parameters:

serverDetails -

storeSubdomain

@Secured(value="role:ROLE_OWNER, scope:SELF_ACCT")
void storeSubdomain(String subdomain)

Parameters:

subdomain -

getSubdomain

@Secured(value="role:ROLE_USER, scope:SELF_ACCT")
String getSubdomain()

This method returns the subdomain associated with this account.

Returns:

subdomain

getPrimaryStorageProvider

@Secured(value="role:ROLE_ADMIN, scope:SELF_ACCT")
org.duracloud.account.db.model.StorageProviderAccount getPrimaryStorageProvider()

Retrieves the primary storage provider account info

Returns:

getComputeProvider

@Secured(value="role:ROLE_ADMIN, scope:SELF_ACCT")
org.duracloud.account.db.model.ComputeProviderAccount getComputeProvider()

Retrieves the primary storage provider account info

Returns:

getSecondaryStorageProviders

@Secured(value="role:ROLE_ADMIN, scope:SELF_ACCT")
Set<org.duracloud.account.db.model.StorageProviderAccount> getSecondaryStorageProviders()

Retrieves the info for all secondary storage provider accounts

Returns:

addStorageProvider

@Secured(value="role:ROLE_OWNER, scope:SELF_ACCT")
void addStorageProvider(org.duracloud.storage.domain.StorageProviderType storageProviderType)

Adds a new secondary storage provider to this account.

Parameters:

storageProviderType -

setPrimaryStorageProviderRrs

@Secured(value="role:ROLE_OWNER, scope:SELF_ACCT")
void setPrimaryStorageProviderRrs(boolean rrs)

Sets the primary storage provider to RRS or not

Parameters:

rrs -

removeStorageProvider

@Secured(value="role:ROLE_OWNER, scope:SELF_ACCT")
void removeStorageProvider(Long storageProviderId)

Removes a storage provider from the list of secondary storage providers for this account. The primary storage provider cannot be removed.

Parameters:

storageProviderId -

getUsers

@Secured(value="role:ROLE_ANONYMOUS, scope:ANY")
Set<org.duracloud.account.db.model.DuracloudUser> getUsers()

Returns:

empty list

inviteUser

@Secured(value="role:ROLE_ADMIN, scope:SELF_ACCT")
org.duracloud.account.db.model.UserInvitation inviteUser(String emailAddress,
                                                                                                             String adminUsername,
                                                                                                             org.duracloud.notification.Emailer emailer)

Invites a user to join this account by sending a notification to the provided email address. The invitation sent to the user is also returned by this method, as it may be useful to an administrator.

Parameters:

emailAddress - address at which to invite user

emailer - utility for sending mail

Returns:

UserInvitation

getPendingInvitations

@Secured(value="role:ROLE_ADMIN, scope:SELF_ACCT")
Set<org.duracloud.account.db.model.UserInvitation> getPendingInvitations()

Gets a listing of the user invitations which are associated with this account.

Returns:

UserInvitation set

deleteUserInvitation

@Secured(value="role:ROLE_ADMIN, scope:SELF_ACCT")
void deleteUserInvitation(Long invitationId)

Deletes an invitation to this account.

Parameters:

invitationId -