com.amazonaws.hal

Class HalService<T>

java.lang.Object

com.amazonaws.hal.HalService<T>

Type Parameters:

T - The type of the root resource.

public class HalService<T>
extends Object

The HalService simplifies the configuration and access to an AWS HAL-based service API. It is constructed with service information, the interface class that describes the service's root resource, and an optional path to the service root (if not specified it is assumed to be "/"). A HalService can be further configured, using the builder pattern, to use a particular AWSCredentialsProvider or ClientConfiguration. Once configured, this class is used to retrieve the service's root resource.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ROOT_PATH

Constructor Summary

Constructors

Constructor and Description
HalService(String endpoint, String serviceName, String regionId, Class<T> rootClass)
HalService(String endpoint, String serviceName, String regionId, Class<T> rootClass, String rootPath)

Method Summary

Methods

Modifier and Type	Method and Description
T	getRootResource()
void	setAwsCredentialsProvider(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)
void	setClientConfiguration(com.amazonaws.ClientConfiguration clientConfiguration)
void	setResourceCache(Map<String,Object> resourceCache)
HalService<T>	with(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)
HalService<T>	with(com.amazonaws.ClientConfiguration clientConfiguration)
HalService<T>	with(Map<String,Object> resourceCache)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ROOT_PATH

public static String DEFAULT_ROOT_PATH

Constructor Detail

HalService

public HalService(String endpoint,
          String serviceName,
          String regionId,
          Class<T> rootClass)

HalService

public HalService(String endpoint,
          String serviceName,
          String regionId,
          Class<T> rootClass,
          String rootPath)

Method Detail

with

public HalService<T> with(com.amazonaws.ClientConfiguration clientConfiguration)

setClientConfiguration

public void setClientConfiguration(com.amazonaws.ClientConfiguration clientConfiguration)

with

public HalService<T> with(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)

setAwsCredentialsProvider

public void setAwsCredentialsProvider(com.amazonaws.auth.AWSCredentialsProvider awsCredentialsProvider)

with

public HalService<T> with(Map<String,Object> resourceCache)

setResourceCache

public void setResourceCache(Map<String,Object> resourceCache)

getRootResource

public T getRootResource()