Package org.apache.hadoop.hdfs.web.resources

Class UserParam

java.lang.Object

org.apache.hadoop.hdfs.web.resources.Param<java.lang.String,org.apache.hadoop.hdfs.web.resources.StringParam.Domain>

org.apache.hadoop.hdfs.web.resources.UserParam

public class UserParam
extends Param<java.lang.String,org.apache.hadoop.hdfs.web.resources.StringParam.Domain>

User parameter.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT	Default parameter value.
static java.lang.String	NAME	Parameter name.

Constructor Summary

Constructors

Constructor	Description
UserParam(java.lang.String str)	Constructor.
UserParam(org.apache.hadoop.security.UserGroupInformation ugi)	Construct an object from a UGI.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()
static org.apache.hadoop.hdfs.web.resources.StringParam.Domain	getUserPatternDomain()
java.lang.String	getValueString()
static void	setUserPattern(java.lang.String pattern)
static void	setUserPatternDomain(org.apache.hadoop.hdfs.web.resources.StringParam.Domain dm)

Methods inherited from class org.apache.hadoop.hdfs.web.resources.Param

getValue, toSortedString, toString

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

Parameter name.

See Also:

Constant Field Values

DEFAULT

public static final java.lang.String DEFAULT

Default parameter value.

See Also:

Constant Field Values

Constructor Detail

UserParam

public UserParam(java.lang.String str)

Constructor.

Parameters:

str - a string representation of the parameter value.

UserParam

public UserParam(org.apache.hadoop.security.UserGroupInformation ugi)

Construct an object from a UGI.

Method Detail

getUserPatternDomain

@VisibleForTesting
public static org.apache.hadoop.hdfs.web.resources.StringParam.Domain getUserPatternDomain()

setUserPatternDomain

@VisibleForTesting
public static void setUserPatternDomain(org.apache.hadoop.hdfs.web.resources.StringParam.Domain dm)

setUserPattern

public static void setUserPattern(java.lang.String pattern)

getName

public java.lang.String getName()

Specified by:

getName in class Param<java.lang.String,org.apache.hadoop.hdfs.web.resources.StringParam.Domain>

Returns:

the parameter name.

getValueString

public java.lang.String getValueString()

Specified by:

getValueString in class Param<java.lang.String,org.apache.hadoop.hdfs.web.resources.StringParam.Domain>

Returns:

the parameter value as a string