net.sf.jrtps.udds.security

Class AuthenticationPlugin

java.lang.Object

net.sf.jrtps.udds.security.AuthenticationPlugin

Direct Known Subclasses:

JKSAuthenticationPlugin, NoOpAuthenticationPlugin

public abstract class AuthenticationPlugin
extends Object

An abstract class for authentication plugin. udds Participant (BuiltinParticipantDataListener) calls beginHandshake(ParticipantData) method during discovery. Implementation is expected to call either notifyListenersOfSuccess(ParticipantData) or notifyListenersOfFailure(ParticipantData)

Author:

mcr70

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_LOG_CATEGORY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuthenticationPlugin(Configuration conf)

Method Summary

Modifier and Type	Method and Description
void	addAuthenticationListener(AuthenticationListener aListener) Adds an AuthenticationListener.
abstract void	beginHandshake(ParticipantData pd) Begins a handshake protocol with given ParticipantData.
Configuration	getConfiguration()
CryptoPlugin	getCryptoPlugin() Gets CryptoPlugin associated with this AuthenticationPlugin
abstract Guid	getGuid() Gets the Guid of local participant
abstract IdentityToken	getIdentityToken() Gets an IdentityToken that will be send to remote participant during discovery. null value may be returned if implementing AuthenticationPlugin does not support authentication protocol as specified in DDS security specification.
static AuthenticationPlugin	getInstance(String name) Gets an instance of AuthenticationPlugin registered with given name
abstract String	getName() Gets the name of this plugin.
void	init(Participant p) This method is called after security endpoints have been created by participant.
protected void	notifyListenersOfFailure(ParticipantData pd) Notifies AuthenticationListeners of failed authentication
protected void	notifyListenersOfSuccess(net.sf.jrtps.udds.security.AuthenticationData ad) Notifies AuthenticationListeners of successful authentication
static void	registerPlugin(AuthenticationPlugin plugin) Registers a AuthenticationPlugin.
void	removeAuthenticationListener(AuthenticationListener aListener) Removes an AuthenticationListener.

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_LOG_CATEGORY

public static final String AUTH_LOG_CATEGORY

See Also:

Constant Field Values

Constructor Detail

AuthenticationPlugin

protected AuthenticationPlugin(Configuration conf)

Method Detail

getConfiguration

public Configuration getConfiguration()

getName

public abstract String getName()

Gets the name of this plugin. Name of the plugin can be used in configuration files.

Returns:

Name of the plugin.

registerPlugin

public static void registerPlugin(AuthenticationPlugin plugin)

Registers a AuthenticationPlugin.

Parameters:

plugin - AuthenticationPlugin

getInstance

public static AuthenticationPlugin getInstance(String name)

Gets an instance of AuthenticationPlugin registered with given name

Parameters:

name - name of the plugin. If name is null or empty string, it is considered as "none".

Returns:

AuthenticationPlugin

Throws:

RuntimeException - if there was not AuthenticationPlugin registered with given name

init

public void init(Participant p)

This method is called after security endpoints have been created by participant.

Parameters:

p - Participant

beginHandshake

public abstract void beginHandshake(ParticipantData pd)

Begins a handshake protocol with given ParticipantData.

Parameters:

pd - ParticipantData

getIdentityToken

public abstract IdentityToken getIdentityToken()

Gets an IdentityToken that will be send to remote participant during discovery. null value may be returned if implementing AuthenticationPlugin does not support authentication protocol as specified in DDS security specification.

Returns:

IdentityToken

addAuthenticationListener

public void addAuthenticationListener(AuthenticationListener aListener)

Adds an AuthenticationListener.

Parameters:

aListener - AuthenticationListener

removeAuthenticationListener

public void removeAuthenticationListener(AuthenticationListener aListener)

Removes an AuthenticationListener.

Parameters:

aListener - AuthenticationListener

notifyListenersOfSuccess

protected void notifyListenersOfSuccess(net.sf.jrtps.udds.security.AuthenticationData ad)

Notifies AuthenticationListeners of successful authentication

Parameters:

ad - AuthenticationData

notifyListenersOfFailure

protected void notifyListenersOfFailure(ParticipantData pd)

Notifies AuthenticationListeners of failed authentication

Parameters:

pd - ParticipantData

getGuid

public abstract Guid getGuid()

Gets the Guid of local participant

Returns:

Guid Guid

getCryptoPlugin

public CryptoPlugin getCryptoPlugin()

Gets CryptoPlugin associated with this AuthenticationPlugin

Returns:

CryptoPlugin