AuthMechanism Property

The authentication mechanism to use when connecting to the server.

Syntax

 hadoopdfs.getAuthMechanism([callback])
 hadoopdfs.setAuthMechanism( authMechanism, [callback])

Possible Values

  0 (amNone), 
  1 (amSimple), 
  2 (amBasic), 
  3 (amNTLM), 
  4 (amNegotiate), 
  5 (amOAuth)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAuthMechanism([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setAuthMechanism([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property controls what authentication mechanism the class should use when connecting to the server.

Possible values are:


0 (amNone - default)	No authentication is performed.
1 (amSimple)	Hadoop pseudo/simple authentication is performed.
2 (amBasic)	Basic authentication is performed.
3 (amNTLM)	NTLM authentication is performed.
4 (amNegotiate)	Negotiate authentication is performed.
5 (amOAuth)	OAuth authentication is performed.

When set to 1 (amSimple), the value of the User property is automatically sent in every request using the user.name query parameter.

When set to 2 (amBasic), 3 (amNTLM), or 4 (amNegotiate), the values held by the User and Password properties will be used to perform Basic, NTLM, or Negotiate (e.g., Kerberos SPNEGO) authentication.

When set to 5 (amOAuth), the value of the Authorization property is automatically sent in every request using the Authorization HTTP header.

Data Type

Integer