alluxio.hub.agent.process

Class AgentProcessContext

java.lang.Object

alluxio.hub.agent.process.AgentProcessContext

All Implemented Interfaces:

AutoCloseable

@ThreadSafe
public class AgentProcessContext
extends Object
implements AutoCloseable

This context holds information and methods critical to the function of the Hub Agent. This object may be safely shared between multiple threads.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG
static String	UPLOAD_SUBDIR

Constructor Summary

Constructors

Constructor and Description
AgentProcessContext(AlluxioConfiguration conf) Creates a new instance of AgentProcessContext.
AgentProcessContext(AlluxioConfiguration conf, RpcClient<ManagerAgentServiceGrpc.ManagerAgentServiceBlockingStub> client) Creates a new instance of AgentProcessContext.

Method Summary

Modifier and Type	Method and Description
Set<AlluxioNodeType>	alluxioProcesses()
void	changeState(AlluxioNodeType type, ProcessStateChange action) Attempts to change the state of a process.
void	close()
AlluxioConfigurationSet	getConf() Gets the configuration for the current node.
protected HubNodeAddress	getNodeAddress()
String	getPropertyFromFile(PropertyKey key) Get Property from file.
List<AgentListFileInfo>	listFile() List files.
boolean	removeFile(String fileName, UploadProcessType uploadProcessType) Upload a file.
void	restartPresto() Restarts the local instance of presto on this node.
boolean	updateConf(Properties props) Update alluxio site property values.
boolean	uploadFile(String filePath, String permission, com.google.protobuf.ByteString fileContent, UploadProcessType uploadType) Upload a file to the current node.
void	writeConf(AlluxioConfigurationSet conf) Writes the configuration for the current node.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

UPLOAD_SUBDIR

public static final String UPLOAD_SUBDIR

See Also:

Constant Field Values

Constructor Detail

AgentProcessContext

public AgentProcessContext(AlluxioConfiguration conf)
                    throws Exception

Creates a new instance of AgentProcessContext.

Parameters:

conf - the Alluxio Configuration

Throws:

Exception - if the context fails to initialize

AgentProcessContext

public AgentProcessContext(AlluxioConfiguration conf,
                           RpcClient<ManagerAgentServiceGrpc.ManagerAgentServiceBlockingStub> client)
                    throws Exception

Creates a new instance of AgentProcessContext.

Parameters:

conf - the Alluxio Configuration

client - the RPC client to use

Throws:

Exception - if the context fails to initialize

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

alluxioProcesses

public Set<AlluxioNodeType> alluxioProcesses()

Returns:

A set containing the types of Alluxio nodes that this agent is responsible for

getNodeAddress

protected HubNodeAddress getNodeAddress()

changeState

public void changeState(AlluxioNodeType type,
                        ProcessStateChange action)
                 throws IOException,
                        TimeoutException,
                        InterruptedException

Attempts to change the state of a process. An action of ProcessStateChange.RESTART will result in the same state but guarantee that the desired process was stopped and then started.

Parameters:

type - the process to perform the action on

action - the action to perform on the process

Throws:

IOException - if there is a failure to obtain the current state of the process

TimeoutException - if a process fails to start in a timely manner

InterruptedException - if the thread handling is interrupted during a start or stop

getConf

public AlluxioConfigurationSet getConf()
                                throws IOException

Gets the configuration for the current node.

Returns:

an AlluxioConfigurationSet representing the node's configuration on disk

Throws:

IOException - if there are any failures reading the configuration

writeConf

public void writeConf(AlluxioConfigurationSet conf)
               throws IOException

Writes the configuration for the current node. Upon failure, no attempt is made to undo or roll back any changes already made.

Parameters:

conf - the configuration to write to disk

Throws:

IOException - if there are any failures writing to disk

getPropertyFromFile

public String getPropertyFromFile(PropertyKey key)

Get Property from file.

Parameters:

key - property key

Returns:

property value

updateConf

public boolean updateConf(Properties props)

Update alluxio site property values.

Parameters:

props - properties to be updated

Returns:

true if property is updated

uploadFile

public boolean uploadFile(String filePath,
                          String permission,
                          com.google.protobuf.ByteString fileContent,
                          UploadProcessType uploadType)

Upload a file to the current node.

Parameters:

filePath - file path

permission - permission string such as 0777

fileContent - file content

uploadType - upload destination type

Returns:

true if upload is successful

removeFile

public boolean removeFile(String fileName,
                          UploadProcessType uploadProcessType)

Upload a file.

Parameters:

fileName - the name of the file

uploadProcessType - upload type

Returns:

true if upload was successful

listFile

public List<AgentListFileInfo> listFile()

List files.

Returns:

a list of file info

restartPresto

public void restartPresto()
                   throws IOException

Restarts the local instance of presto on this node. Blocks until completed, or throws an IOException upon failure.

Throws:

IOException