org.hawkular.apm.api.services

Interface ServiceDeploymentService

public interface ServiceDeploymentService

Provides access to Service Deployment information. The name of this class is a bit unfortunate, but follows the pattern for this kind of class.

Author:

Juraci Paixão Kröhling

Method Summary

Modifier and Type	Method and Description
ServiceDeployment	getService(String serviceName, String tenantId) Returns a single service deployment, based on the provided service name.
ServiceDeployment	getService(String serviceName, String tenantId, Criteria criteria) Returns a single service deployment, based on the provided service name.
List<ServiceDeployment>	getServiceDeployments(String tenantId) Same as getServiceDeployments(String, Criteria), without using any extra parameters as base criteria.
List<ServiceDeployment>	getServiceDeployments(String tenantId, Criteria criteria) Returns the available service deployments.

Method Detail

getServiceDeployments

List<ServiceDeployment> getServiceDeployments(String tenantId,
                                              Criteria criteria)

Returns the available service deployments. Service here, at this point, are individual services. A service has 1+ buildStamps. The list of buildStamps within the service is complete and is not provided in any specific order. The provided criteria will be used as a base for retrieving the service deployments, but the original object is not changed. Additional criteria is added, so that the results are restricted to service deployments. Note that the same base criteria is passed down to the build stamp retrieval, so, the criteria has to be valid for both.

Parameters:

tenantId - The tenant to get the service deployments from. Optional.

criteria - The base criteria. Optional.

Returns:

a List of Service Deployments, or an empty list if none is available.

getServiceDeployments

List<ServiceDeployment> getServiceDeployments(String tenantId)

Same as getServiceDeployments(String, Criteria), without using any extra parameters as base criteria.

Returns:

a List of Service Deployments, or an empty list if none is available.

See Also:

getServiceDeployments(String, Criteria)

getService

ServiceDeployment getService(String serviceName,
                             String tenantId,
                             Criteria criteria)

Returns a single service deployment, based on the provided service name. This method has the same semantics as getServiceDeployments(String, Criteria), except that the list of BuildStamp might be empty.

Parameters:

serviceName - The service name. Required.

tenantId - The tenant to get the service deployments from. Optional.

criteria - The base criteria. Optional.

Returns:

the ServiceDeployment for the given service name, including BuildStamps, if any.

getService

ServiceDeployment getService(String serviceName,
                             String tenantId)

Returns a single service deployment, based on the provided service name. This method has the same semantics as getServiceDeployments(String, Criteria), except that the list of BuildStamp might be empty.

Parameters:

serviceName - The service name. Required.

tenantId - The tenant to get the service deployments from. Optional.

Returns:

the ServiceDeployment for the given service name, including BuildStamps, if any.