org.apache.hadoop.security.rpcauth

Class RpcAuthMethod

java.lang.Object

org.apache.hadoop.security.rpcauth.RpcAuthMethod

Direct Known Subclasses:

DigestAuthMethod, FakeKerberosAuthMethod, KerberosAuthMethod, SimpleAuthMethod

public abstract class RpcAuthMethod
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected byte	authcode Deprecated.
protected UserGroupInformation.AuthenticationMethod	authenticationMethod
protected String	mechanismName
protected String	simpleName

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RpcAuthMethod(byte code, String simpleName, String mechanismName, UserGroupInformation.AuthenticationMethod authMethod)

Method Summary

Methods

Modifier and Type	Method and Description
SaslClient	createSaslClient(Map<String,Object> saslProperties) Implementors which uses SASL authentication must return true for isSasl() method and return and instance of SaslClient.
SaslServer	createSaslServer(Server.Connection connection, Map<String,Object> saslProperties) Implementors which uses SASL authentication must return true for isSasl() method and return and instance of SaslServer.
boolean	equals(Object that)
byte	getAuthCode() Deprecated.
UserGroupInformation.AuthenticationMethod	getAuthenticationMethod()
org.apache.hadoop.security.UserGroupInformation	getAuthorizedUgi(String authorizedId, org.apache.hadoop.security.token.SecretManager secretManager)
String	getMechanismName() Return the SASL mechanism name
String	getProtocol()
String	getServerId()
org.apache.hadoop.security.UserGroupInformation	getUser(org.apache.hadoop.security.UserGroupInformation ticket)
int	hashCode()
boolean	isNegotiable() false by default
boolean	isProxyAllowed()
boolean	isSasl() false by default
String[]	loginModules()
void	reLogin() does nothing
boolean	shouldReLogin()
String	toString()
void	write(DataOutput out) Write to out.
void	writeUGI(org.apache.hadoop.security.UserGroupInformation ugi, IpcConnectionContextProtos.UserInformationProto.Builder ugiProto)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

authcode

@Deprecated
protected final byte authcode

Deprecated.

simpleName

protected final String simpleName

mechanismName

protected final String mechanismName

authenticationMethod

protected final UserGroupInformation.AuthenticationMethod authenticationMethod

Constructor Detail

RpcAuthMethod

protected RpcAuthMethod(byte code,
             String simpleName,
             String mechanismName,
             UserGroupInformation.AuthenticationMethod authMethod)

Method Detail

getAuthCode

@Deprecated
public byte getAuthCode()

Deprecated.

getMechanismName

public String getMechanismName()

Return the SASL mechanism name

getAuthenticationMethod

public UserGroupInformation.AuthenticationMethod getAuthenticationMethod()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object that)

Overrides:

equals in class Object

loginModules

public String[] loginModules()

write

public void write(DataOutput out)
           throws IOException

Write to out.

Throws:

IOException

getUser

public org.apache.hadoop.security.UserGroupInformation getUser(org.apache.hadoop.security.UserGroupInformation ticket)

writeUGI

public void writeUGI(org.apache.hadoop.security.UserGroupInformation ugi,
            IpcConnectionContextProtos.UserInformationProto.Builder ugiProto)

getAuthorizedUgi

public org.apache.hadoop.security.UserGroupInformation getAuthorizedUgi(String authorizedId,
                                                               org.apache.hadoop.security.token.SecretManager secretManager)
                                                                 throws IOException

Throws:

IOException

shouldReLogin

public boolean shouldReLogin()
                      throws IOException

Throws:

IOException

reLogin

public void reLogin()
             throws IOException

does nothing

Throws:

IOException

isProxyAllowed

public boolean isProxyAllowed()

toString

public String toString()

Overrides:

toString in class Object

isNegotiable

public boolean isNegotiable()

false by default

isSasl

public boolean isSasl()

false by default

getProtocol

public String getProtocol()
                   throws IOException

Throws:

IOException

getServerId

public String getServerId()
                   throws IOException

Throws:

IOException

createSaslClient

public SaslClient createSaslClient(Map<String,Object> saslProperties)
                            throws IOException

Implementors which uses SASL authentication must return true for isSasl() method and return and instance of SaslClient.

Throws:

IOException

createSaslServer

public SaslServer createSaslServer(Server.Connection connection,
                          Map<String,Object> saslProperties)
                            throws IOException,
                                   InterruptedException

Implementors which uses SASL authentication must return true for isSasl() method and return and instance of SaslServer.

Parameters:

connection -

Throws:

IOException

InterruptedException