org.duracloud.client

Class ServicesManagerImpl

java.lang.Object

org.duracloud.client.ServicesManagerImpl

All Implemented Interfaces:

Securable, ServicesManager

Direct Known Subclasses:

DuradminServicesManagerImpl

public class ServicesManagerImpl
extends Object
implements ServicesManager, Securable

Allows for communication with DuraService

Author:

Bill Branan

Constructor Summary

Constructors

Constructor and Description
ServicesManagerImpl(String host, String port)
ServicesManagerImpl(String host, String port, String context)

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.
String	getBaseURL()
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	login(Credential credential) This method supplies user credentials to the application.
void	logout() This method clears any previously logged-in credentials.
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 class java.lang.Object

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

Constructor Detail

ServicesManagerImpl

public ServicesManagerImpl(String host,
                   String port)

ServicesManagerImpl

public ServicesManagerImpl(String host,
                   String port,
                   String context)

Method Detail

getBaseURL

public String getBaseURL()

getAvailableServices

public List<ServiceInfo> getAvailableServices()
                                       throws ServicesException

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

Specified by:

getAvailableServices in interface ServicesManager

Returns:

List of available services

Throws:

ServicesException - if available services cannot be retrieved

getDeployedServices

public List<ServiceInfo> getDeployedServices()
                                      throws ServicesException

Provides a listing of all deployed services.

Specified by:

getDeployedServices in interface ServicesManager

Returns:

List of deployed services

Throws:

ServicesException - if deployed services cannot be retrieved

getService

public 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.

Specified by:

getService in interface ServicesManager

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

public 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.

Specified by:

getDeployedService in interface ServicesManager

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

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

Gets runtime properties for a deployed service.

Specified by:

getDeployedServiceProps in interface ServicesManager

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

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

Deploys a service.

Specified by:

deployService in interface ServicesManager

Parameters:

serviceId - the ID of the service to deploy

serviceHost - the selected service host

userConfigVersion - the version of the user configuration

userConfigModeSets - a list of user configuration options

Returns:

the deploymentID of the newly deployed service

Throws:

NotFoundException - if the service cannot be found

ServicesException - if the service cannot be deployed

updateServiceConfig

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

Updates the configuration of a deployed service.

Specified by:

updateServiceConfig in interface ServicesManager

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

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

UnDeploys a service.

Specified by:

undeployService in interface ServicesManager

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

login

public void login(Credential credential)

Description copied from interface: Securable

This method supplies user credentials to the application.

Specified by:

login in interface Securable

Parameters:

credential - of user

logout

public void logout()

Description copied from interface: Securable

This method clears any previously logged-in credentials.

Specified by:

logout in interface Securable