org.apache.hadoop.fs.swift.http

Class RestClientBindings

java.lang.Object

org.apache.hadoop.fs.swift.http.RestClientBindings

public final class RestClientBindings
extends Object

This class implements the binding logic between Hadoop configurations and the swift rest client.

The swift rest client takes a Properties instance containing the string values it uses to bind to a swift endpoint.

This class extracts the values for a specific filesystem endpoint and then builds an appropriate Properties file.

Field Summary

Fields

Modifier and Type	Field and Description
static String	E_INVALID_NAME

Constructor Summary

Constructors

Constructor and Description
RestClientBindings()

Method Summary

Methods

Modifier and Type	Method and Description
static Properties	bind(URI fsURI, org.apache.hadoop.conf.Configuration conf) Build a properties instance bound to the configuration file -using the filesystem URI as the source of the information.
static String	buildSwiftInstancePrefix(String service) Public for testing : build the full prefix for use in resolving configuration items
static void	copy(org.apache.hadoop.conf.Configuration conf, String confKey, Properties props, String propsKey, boolean required) Copy a (trimmed) property from the configuration file to the properties file.
static String	extractContainerName(String hostname) Get the container name from the hostname -the single element before the first "." in the hostname
static String	extractContainerName(URI uri)
static String	extractServiceName(String hostname) Get the service name from a longer hostname string
static String	extractServiceName(URI uri)

Methods inherited from class java.lang.Object

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

Field Detail

E_INVALID_NAME

public static final String E_INVALID_NAME

See Also:

Constant Field Values

Constructor Detail

RestClientBindings

public RestClientBindings()

Method Detail

buildSwiftInstancePrefix

public static String buildSwiftInstancePrefix(String service)

Public for testing : build the full prefix for use in resolving configuration items

Parameters:

service - service to use

Returns:

the prefix string without any trailing "."

extractContainerName

public static String extractContainerName(String hostname)
                                   throws SwiftConfigurationException

Get the container name from the hostname -the single element before the first "." in the hostname

Parameters:

hostname - hostname to split

Returns:

the container

Throws:

SwiftConfigurationException

extractContainerName

public static String extractContainerName(URI uri)
                                   throws SwiftConfigurationException

Throws:

SwiftConfigurationException

extractServiceName

public static String extractServiceName(String hostname)
                                 throws SwiftConfigurationException

Get the service name from a longer hostname string

Parameters:

hostname - hostname

Returns:

the separated out service name

Throws:

SwiftConfigurationException - if the hostname was invalid

extractServiceName

public static String extractServiceName(URI uri)
                                 throws SwiftConfigurationException

Throws:

SwiftConfigurationException

bind

public static Properties bind(URI fsURI,
              org.apache.hadoop.conf.Configuration conf)
                       throws SwiftConfigurationException

Build a properties instance bound to the configuration file -using the filesystem URI as the source of the information.

Parameters:

fsURI - filesystem URI

conf - configuration

Returns:

a properties file with the instance-specific properties extracted and bound to the swift client properties.

Throws:

SwiftConfigurationException - if the configuration is invalid

copy

public static void copy(org.apache.hadoop.conf.Configuration conf,
        String confKey,
        Properties props,
        String propsKey,
        boolean required)
                 throws SwiftConfigurationException

Copy a (trimmed) property from the configuration file to the properties file.

If marked as required and not found in the configuration, an exception is raised. If not required -and missing- then the property will not be set. In this case, if the property is already in the Properties instance, it will remain untouched.

Parameters:

conf - source configuration

confKey - key in the configuration file

props - destination property set

propsKey - key in the property set

required - is the property required

Throws:

SwiftConfigurationException - if the property is required but was not found in the configuration instance.