org.alfresco.jlan.oncrpc

Interface RpcAuthenticator

All Known Implementing Classes:

DefaultRpcAuthenticator

public interface RpcAuthenticator

RPC Authenticator Interface

Provides authentication support for ONC/RPC requests.

Author:

gkspencer

Method Summary

Methods

Modifier and Type	Method and Description
Object	authenticateRpcClient(int authType, RpcPacket rpc) Authenticate an RPC client using the credentials within the RPC request.
int[]	getRpcAuthenticationTypes() Return a list of the authentication types that the RPC authenticator implementation supports.
ClientInfo	getRpcClientInformation(Object sessKey, RpcPacket rpc) Get RPC client information from the RPC request.
void	initialize(ServerConfiguration config, org.springframework.extensions.config.ConfigElement params) Initialize the RPC authenticator
void	setCurrentUser(SrvSession sess, ClientInfo client) Set the current authenticated user context for processing of the current RPC request

Method Detail

initialize

void initialize(ServerConfiguration config,
              org.springframework.extensions.config.ConfigElement params)
                throws InvalidConfigurationException

Initialize the RPC authenticator

Parameters:

config - ServerConfiguration

params - ConfigElement

Throws:

InvalidConfigurationException

authenticateRpcClient

Object authenticateRpcClient(int authType,
                           RpcPacket rpc)
                             throws RpcAuthenticationException

Authenticate an RPC client using the credentials within the RPC request. The object that is returned is used as the key to find the associated session object.

Parameters:

authType - int

rpc - RpcPacket

Returns:

Object

Throws:

RpcAuthenticationException

getRpcClientInformation

ClientInfo getRpcClientInformation(Object sessKey,
                                 RpcPacket rpc)

Get RPC client information from the RPC request.

This method is called when a new session object is created by an RPC server.

Parameters:

sessKey - Object

rpc - RpcPacket

Returns:

ClientInfo

getRpcAuthenticationTypes

int[] getRpcAuthenticationTypes()

Return a list of the authentication types that the RPC authenticator implementation supports. The authentication types are specified in the AuthType class.

Returns:

int[]

setCurrentUser

void setCurrentUser(SrvSession sess,
                  ClientInfo client)

Set the current authenticated user context for processing of the current RPC request

Parameters:

sess - SrvSession

client - ClientInfo