alluxio.master.file.contexts

Class CreatePathContext<T extends com.google.protobuf.GeneratedMessageV3.Builder<?>,K extends CreatePathContext<?,?>>

java.lang.Object

alluxio.master.file.contexts.OperationContext<T,K>

alluxio.master.file.contexts.CreatePathContext<T,K>

Type Parameters:

T - Proto Builder type

K - Path context type

Direct Known Subclasses:

CreateDirectoryContext, CreateFileContext

public abstract class CreatePathContext<T extends com.google.protobuf.GeneratedMessageV3.Builder<?>,K extends CreatePathContext<?,?>>
extends OperationContext<T,K>

Wrapper for CreateFilePOptions or CreateDirectoryPOptions with additional context data.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AclEntry>	mAcl
protected String	mGroup
protected boolean	mMetadataLoad
protected Mode	mMode
protected boolean	mMountPoint
protected long	mOperationTimeMs
protected String	mOwner
protected boolean	mRecursive
protected long	mTtl
protected TtlAction	mTtlAction
protected Map<String,byte[]>	mXAttr
protected XAttrPropagationStrategy	mXAttrPropStrat

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreatePathContext(T optionsBuilder) Creates context with given option data.

Method Summary

Modifier and Type	Method and Description
List<AclEntry>	getAcl()
String	getGroup()
Mode	getMode()
long	getOperationTimeMs()
String	getOwner()
protected K	getThis() Note: This is safe as 'K' extends CreatePathContext.
long	getTtl()
TtlAction	getTtlAction()
WriteType	getWriteType()
Map<String,byte[]>	getXAttr()
XAttrPropagationStrategy	getXAttrPropStrat()
boolean	isMetadataLoad()
boolean	isMountPoint()
boolean	isPersisted()
boolean	isRecursive()
K	setAcl(List<AclEntry> acl) Sets an immutable copy of acl as the internal access control list.
K	setGroup(String group)
K	setMetadataLoad(boolean metadataLoad)
K	setMountPoint(boolean mountPoint)
K	setOperationTimeMs(long operationTimeMs)
K	setOwner(String owner)
K	setWriteType(WriteType writeType)
K	setXAttr(Map<String,byte[]> xattr)
String	toString()

Methods inherited from class alluxio.master.file.contexts.OperationContext

getCancelledTrackers, getOperationId, getOptions, withTracker

Methods inherited from class java.lang.Object

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

Field Detail

mMountPoint

protected boolean mMountPoint

mOperationTimeMs

protected long mOperationTimeMs

mAcl

protected List<AclEntry> mAcl

mOwner

protected String mOwner

mGroup

protected String mGroup

mMetadataLoad

protected boolean mMetadataLoad

mXAttr

protected Map<String,byte[]> mXAttr

mXAttrPropStrat

protected XAttrPropagationStrategy mXAttrPropStrat

mMode

protected Mode mMode

mRecursive

protected boolean mRecursive

mTtl

protected long mTtl

mTtlAction

protected TtlAction mTtlAction

Constructor Detail

CreatePathContext

protected CreatePathContext(T optionsBuilder)

Creates context with given option data.

Parameters:

optionsBuilder - the options builder

Method Detail

getMode

public Mode getMode()

Returns:

Mode, extracted from options

isPersisted

public boolean isPersisted()

Returns:

true if persisted, extracted from options

isRecursive

public boolean isRecursive()

Returns:

true if recursive, extracted from options

getTtl

public long getTtl()

Returns:

ttl, extracted from options

getTtlAction

public TtlAction getTtlAction()

Returns:

ttl action, extracted from options

getThis

protected K getThis()

Note: This is safe as 'K' extends CreatePathContext.

Returns:

the object's type

setOperationTimeMs

public K setOperationTimeMs(long operationTimeMs)

Parameters:

operationTimeMs - the operation time to use

Returns:

the updated context

getOperationTimeMs

public long getOperationTimeMs()

Returns:

the operation time

setAcl

public K setAcl(List<AclEntry> acl)

Sets an immutable copy of acl as the internal access control list.

Parameters:

acl - the ACL entries

Returns:

the updated context

getAcl

public List<AclEntry> getAcl()

Returns:

an immutable list of ACL entries

setMountPoint

public K setMountPoint(boolean mountPoint)

Parameters:

mountPoint - the mount point flag to use; it specifies whether the object to create is a mount point

Returns:

the updated context

isMountPoint

public boolean isMountPoint()

Returns:

the mount point flag; it specifies whether the object to create is a mount point

setOwner

public K setOwner(String owner)

Parameters:

owner - the owner to use

Returns:

the updated context

getOwner

public String getOwner()

Returns:

the owner

setGroup

public K setGroup(String group)

Parameters:

group - the group to use

Returns:

the updated context

getWriteType

public WriteType getWriteType()

Returns:

the write type of this path

setWriteType

public K setWriteType(WriteType writeType)

Parameters:

writeType - type of write on this create

Returns:

the updated context

getGroup

public String getGroup()

Returns:

the group

setMetadataLoad

public K setMetadataLoad(boolean metadataLoad)

Parameters:

metadataLoad - the flag value to use; if true, the create path is a result of a metadata load

Returns:

the updated context

getXAttr

@Nullable
public Map<String,byte[]> getXAttr()

Returns:

extended attributes on this context

setXAttr

public K setXAttr(@Nullable
                  Map<String,byte[]> xattr)

Parameters:

xattr - extended attributes to set when creating

Returns:

the updated context

getXAttrPropStrat

public XAttrPropagationStrategy getXAttrPropStrat()

Returns:

extended attributes propagation strategy of this context

isMetadataLoad

public boolean isMetadataLoad()

Returns:

the metadataLoad flag; if true, the create path is a result of a metadata load

toString

public String toString()

Overrides:

toString in class Object