org.duracloud.serviceapi

Interface ServicesManager

All Superinterfaces:

Securable

All Known Subinterfaces:

LocalServicesManager

All Known Implementing Classes:

DuradminServicesManagerImpl, ServiceManager, ServicesManagerImpl

public interface ServicesManager
extends Securable

Allows for communication with DuraService

Author:

Bill Branan

Method Summary

Methods

Modifier and Type	Method and Description
int	deployService(int serviceId, String serviceHost, String userConfigVersion, List<UserConfigModeSet> userConfigModeSets) Deploys a service.
List<ServiceInfo>	getAvailableServices() Provides a listing of available services, that is, services which can be deployed.
ServiceInfo	getDeployedService(int serviceId, int deploymentId) Gets a deployed service.
Map<String,String>	getDeployedServiceProps(int serviceId, int deploymentId) Gets runtime properties for a deployed service.
List<ServiceInfo>	getDeployedServices() Provides a listing of all deployed services.
ServiceInfo	getService(int serviceId) Gets a service.
void	undeployService(int serviceId, int deploymentId) UnDeploys a service.
void	updateServiceConfig(int serviceId, int deploymentId, String userConfigVersion, List<UserConfigModeSet> userConfigModeSets) Updates the configuration of a deployed service.

Methods inherited from interface org.duracloud.common.model.Securable

login, logout

Method Detail

getAvailableServices

List<ServiceInfo> getAvailableServices()
                                       throws ServicesException

Provides a listing of available services, that is, services which can be deployed.

Returns:

List of available services

Throws:

ServicesException - if available services cannot be retrieved

getDeployedServices

List<ServiceInfo> getDeployedServices()
                                      throws ServicesException

Provides a listing of all deployed services.

Returns:

List of deployed services

Throws:

ServicesException - if deployed services cannot be retrieved

getService

ServiceInfo getService(int serviceId)
                       throws NotFoundException,
                              ServicesException

Gets a service. This includes configuration options and deployment options for a potential deployment as well as a list of all current deployments of this service. There is no guarantee with this call that the service returned can be deployed. Use getAvailableServices to get the list of services which are available for deployment.

Parameters:

serviceId - the ID of the service to retrieve

Returns:

a service

Throws:

NotFoundException - if the service cannot be found

ServicesException - if the service cannot be retrieved

getDeployedService

ServiceInfo getDeployedService(int serviceId,
                             int deploymentId)
                               throws NotFoundException,
                                      ServicesException

Gets a deployed service. This includes the selected configuration for the deployment as well as the user configuration options for potential reconfiguration.

Parameters:

serviceId - the ID of the service to retrieve

deploymentId - the ID of the service deployment to retrieve

Returns:

a service which has been deployed

Throws:

NotFoundException - if either the service or deployment cannot be found

ServicesException - if the service cannot be retrieved

getDeployedServiceProps

Map<String,String> getDeployedServiceProps(int serviceId,
                                         int deploymentId)
                                           throws NotFoundException,
                                                  ServicesException

Gets runtime properties for a deployed service.

Parameters:

serviceId - the ID of the service to retrieve

deploymentId - the ID of the service deployment to retrieve

Returns:

a map of service properties

Throws:

NotFoundException - if either the service or deployment cannot be found

ServicesException - if the service properties cannot be retrieved

deployService

int deployService(int serviceId,
                String serviceHost,
                String userConfigVersion,
                List<UserConfigModeSet> userConfigModeSets)
                  throws NotFoundException,
                         ServicesException

Deploys a service.

Parameters:

serviceId - the ID of the service to deploy

userConfigVersion - the version of the user configuration

userConfigModeSets - a list of user configuration options

serviceHost - the selected deployment option

Returns:

the deploymentID of the newly deployed service

Throws:

NotFoundException - if the service cannot be found

ServicesException - if the service cannot be deployed

updateServiceConfig

void updateServiceConfig(int serviceId,
                       int deploymentId,
                       String userConfigVersion,
                       List<UserConfigModeSet> userConfigModeSets)
                         throws NotFoundException,
                                ServicesException

Updates the configuration of a deployed service.

Parameters:

serviceId - the ID of the service to update

deploymentId - the ID of the service deployment to update

userConfigVersion - the version of the user configuration

userConfigModeSets - updated user configuration options

Throws:

NotFoundException - if either the service or deployment cannot be found

ServicesException - if the service configuration cannot be updated

undeployService

void undeployService(int serviceId,
                   int deploymentId)
                     throws NotFoundException,
                            ServicesException

UnDeploys a service.

Parameters:

serviceId - the ID of the service to undeploy

deploymentId - the ID of the service deployment to undeploy

Throws:

NotFoundException - if either the service or deployment cannot be found

ServicesException - if the service cannot be undeployed