Package org.apache.hadoop.security.rpcauth

Class RpcAuthMethod

java.lang.Object

org.apache.hadoop.security.rpcauth.RpcAuthMethod

Direct Known Subclasses:

FakeKerberosAuthMethod, KerberosAuthMethod, SimpleAuthMethod, TokenAuthMethod

public abstract class RpcAuthMethod
extends java.lang.Object

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
javax.security.auth.callback.CallbackHandler	createCallbackHandler()
javax.security.sasl.SaslClient	createSaslClient(java.util.Map<java.lang.String,java.lang.Object> saslProperties)	Implementors which uses SASL authentication must return true for isSasl() method and return and instance of SaslClient.
javax.security.sasl.SaslServer	createSaslServer(Server.Connection connection, java.util.Map<java.lang.String,java.lang.Object> saslProperties)	Implementors which uses SASL authentication must return true for isSasl() method and return and instance of SaslServer.
boolean	equals(java.lang.Object that)
byte	getAuthCode()	Deprecated.
UserGroupInformation.AuthenticationMethod	getAuthenticationMethod()
UserGroupInformation	getAuthorizedUgi(java.lang.String authorizedId, SecretManager secretManager)
java.lang.String	getMechanismName()	Return the SASL mechanism name
java.lang.String	getProtocol()
java.lang.String	getServerId()
UserGroupInformation	getUser(UserGroupInformation ticket)
int	hashCode()
boolean	isNegotiable()	false by default
boolean	isProxyAllowed()
boolean	isSasl()	false by default
java.lang.String[]	loginModules()
void	reLogin()	does nothing
boolean	shouldReLogin()
java.lang.String	toString()
void	write(java.io.DataOutput out)	Write to out.
void	writeUGI(UserGroupInformation ugi, org.apache.hadoop.ipc.protobuf.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 java.lang.String simpleName

mechanismName

protected final java.lang.String mechanismName

authenticationMethod

protected final UserGroupInformation.AuthenticationMethod authenticationMethod

Constructor Detail

RpcAuthMethod

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

Method Detail

getAuthCode

@Deprecated
public byte getAuthCode()

Deprecated.

getMechanismName

public java.lang.String getMechanismName()

Return the SASL mechanism name

getAuthenticationMethod

public UserGroupInformation.AuthenticationMethod getAuthenticationMethod()

createCallbackHandler

public javax.security.auth.callback.CallbackHandler createCallbackHandler()

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object that)

Overrides:

equals in class java.lang.Object

loginModules

public java.lang.String[] loginModules()

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Write to out.

Throws:

java.io.IOException

getUser

public UserGroupInformation getUser(UserGroupInformation ticket)

writeUGI

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

getAuthorizedUgi

public UserGroupInformation getAuthorizedUgi(java.lang.String authorizedId,
                                             SecretManager secretManager)
                                      throws java.io.IOException

Throws:

java.io.IOException

shouldReLogin

public boolean shouldReLogin()
                      throws java.io.IOException

Throws:

java.io.IOException

reLogin

public void reLogin()
             throws java.io.IOException,
                    javax.security.auth.login.LoginException

does nothing

Throws:

java.io.IOException

javax.security.auth.login.LoginException

isProxyAllowed

public boolean isProxyAllowed()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isNegotiable

public boolean isNegotiable()

false by default

isSasl

public boolean isSasl()

false by default

getProtocol

public java.lang.String getProtocol()
                             throws java.io.IOException

Throws:

java.io.IOException

getServerId

public java.lang.String getServerId()
                             throws java.io.IOException

Throws:

java.io.IOException

createSaslClient

public javax.security.sasl.SaslClient createSaslClient(java.util.Map<java.lang.String,java.lang.Object> saslProperties)
                                                throws java.io.IOException

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

Throws:

java.io.IOException

createSaslServer

public javax.security.sasl.SaslServer createSaslServer(Server.Connection connection,
                                                       java.util.Map<java.lang.String,java.lang.Object> saslProperties)
                                                throws java.io.IOException,
                                                       java.lang.InterruptedException

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

Parameters:

connection -

Throws:

java.io.IOException

java.lang.InterruptedException