com.asakusafw.runtime.stage.resource

Class StageResourceDriver

java.lang.Object

com.asakusafw.runtime.stage.resource.StageResourceDriver

All Implemented Interfaces:

Closeable, AutoCloseable

public class StageResourceDriver
extends Object
implements Closeable

A driver for configuring stage resources.

Since:

0.1.0

Version:

0.7.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StageResourceDriver.AccessMode Represents the access mode for StageResourceDriver.

Constructor Summary

Constructors

Constructor and Description
StageResourceDriver(org.apache.hadoop.mapreduce.JobContext context) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
static void	add(org.apache.hadoop.mapreduce.Job job, String resourcePath, String resourceName) Adds a resource path into the target job object.
void	close()
static long	estimateResourceSize(org.apache.hadoop.mapreduce.JobContext context) Returns the estimated resource data-size.
List<org.apache.hadoop.fs.Path>	findCache(String resourceName) Returns the paths for the specified resource.
static StageResourceDriver.AccessMode	getAccessMode(org.apache.hadoop.mapreduce.JobContext context) Returns the access mode for stage resources in the job.
org.apache.hadoop.conf.Configuration	getConfiguration() Returns the current configuration.
static void	setAccessMode(org.apache.hadoop.mapreduce.JobContext context, StageResourceDriver.AccessMode mode) Sets the access mode for stage resources in the job.

Methods inherited from class java.lang.Object

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

Constructor Detail

StageResourceDriver

public StageResourceDriver(org.apache.hadoop.mapreduce.JobContext context)
                    throws IOException

Creates a new instance.

Parameters:

context - the current job context

Throws:

IOException - if failed to initialize this driver

IllegalArgumentException - if the parameter is null

Method Detail

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

Returns the current configuration.

Returns:

the current configuration

findCache

public List<org.apache.hadoop.fs.Path> findCache(String resourceName)
                                          throws IOException

Returns the paths for the specified resource.

Parameters:

resourceName - the target resource name

Returns:

the resource paths

Throws:

IOException - if error occurred while extracting resource paths

IllegalArgumentException - if the parameter is null

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

add

public static void add(org.apache.hadoop.mapreduce.Job job,
                       String resourcePath,
                       String resourceName)
                throws IOException

Adds a resource path into the target job object.

Parameters:

job - the target job

resourcePath - the resource path expression (this must be accessible from task execution nodes)

resourceName - the resource name

Throws:

IOException - if failed to detect resources on the path

IllegalArgumentException - if some parameters are null

estimateResourceSize

public static long estimateResourceSize(org.apache.hadoop.mapreduce.JobContext context)
                                 throws InterruptedException

Returns the estimated resource data-size.

Parameters:

context - the current job context

Returns:

the estimated resource data-size in bytes

Throws:

InterruptedException - if interrupted while

IllegalArgumentException - if some parameters were null

Since:

0.7.1

getAccessMode

public static StageResourceDriver.AccessMode getAccessMode(org.apache.hadoop.mapreduce.JobContext context)

Returns the access mode for stage resources in the job.

Parameters:

context - the current job context

Returns:

the access mode

Since:

0.7.1

setAccessMode

public static void setAccessMode(org.apache.hadoop.mapreduce.JobContext context,
                                 StageResourceDriver.AccessMode mode)

Sets the access mode for stage resources in the job.

Parameters:

context - the current job context

mode - the access mode

Since:

0.7.1