org.duracloud.account.db.util

Interface DuracloudInstanceService

All Known Implementing Classes:

DuracloudInstanceServiceImpl, DuracloudInstanceServiceSecuredImpl

public interface DuracloudInstanceService

An interface for controlling a deployed duracloud instance

Method Summary

Modifier and Type	Method and Description
Long	getAccountId() Gets the id of the account
org.duracloud.account.db.model.DuracloudInstance	getInstanceInfo() Gets information about the underlying Duracloud instance.
org.duracloud.account.db.model.InstanceType	getInstanceType() Returns the hardware type of the instance.
String	getInstanceVersion() Gets the version of this instance
String	getStatus() Returns the state of the Duracloud instance.
String	getStatusInternal() Returns the state of the Duracloud with relaxed security.
void	initialize() Collects all of the necessary information and initializes a Duracloud instance
void	reInitialize()
void	reInitializeUserRoles()
void	restart() Restarts the server instance and calls initialize
void	setUserRoles(Set<org.duracloud.account.db.model.DuracloudUser> users) Pushes user role info to the running instance.
void	stop() Stops the instance.

Method Detail

getAccountId

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

Gets the id of the account

Returns:

acctId

getInstanceInfo

@Secured(value="role:ROLE_ANONYMOUS, scope:ANY")
org.duracloud.account.db.model.DuracloudInstance getInstanceInfo()

Gets information about the underlying Duracloud instance.

getInstanceVersion

@Secured(value="role:ROLE_ANONYMOUS, scope:ANY")
String getInstanceVersion()

Gets the version of this instance

getStatus

@Secured(value="role:ROLE_USER, scope:SELF_ACCT")
String getStatus()
                                                            throws DuracloudInstanceNotAvailableException

Returns the state of the Duracloud instance.

Throws:

DuracloudInstanceNotAvailableException

getInstanceType

@Secured(value="role:ROLE_ANONYMOUS, scope:ANY")
org.duracloud.account.db.model.InstanceType getInstanceType()
                                                                                                      throws DuracloudInstanceNotAvailableException

Returns the hardware type of the instance.

Returns:

Throws:

DuracloudInstanceNotAvailableException

getStatusInternal

@Secured(value="role:ROLE_ANONYMOUS, scope:ANY")
String getStatusInternal()
                                                                   throws DuracloudInstanceNotAvailableException

Returns the state of the Duracloud with relaxed security.

Throws:

DuracloudInstanceNotAvailableException

stop

@Secured(value="role:ROLE_ROOT, scope:SELF_ACCT")
void stop()

Stops the instance. Stopped instances cannot be restarted (stop == terminate).

restart

@Secured(value="role:ROLE_ROOT, scope:SELF_ACCT")
void restart()

Restarts the server instance and calls initialize

initialize

@Secured(value="role:ROLE_ROOT, scope:SELF_ACCT")
void initialize()

Collects all of the necessary information and initializes a Duracloud instance

reInitializeUserRoles

@Secured(value="role:ROLE_ROOT, scope:ANY")
void reInitializeUserRoles()

reInitialize

@Secured(value="role:ROLE_ROOT, scope:ANY")
void reInitialize()

setUserRoles

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

Pushes user role info to the running instance. Note: This set of users will replace the existing configuration on the running instance.

Parameters:

users - to update