org.cristalise.kernel.process.auth

Interface Authenticator

public interface Authenticator

This interface is used by the kernel to store an authenticated connection and/or token that will be used by kernel components. The CRISTAL property 'Authenticator' is used to specify the implementation used. It is instantiated by the connect() methods of the Gateway, and will be found in the AgentProxy returned by connect(). Lookup and ClusterStorage instances are initialized with this Authenticator, which is expected to maintain the same user's connection through the process lifetime, reconnecting if the connection is lost.

Since:

3.0

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(String resource) Authenticates a superuser connection for the server.
boolean	authenticate(String agentName, String password, String resource) Authenticates a CRISTAL agent.
void	disconnect() Close or expire the connection as the CRISTAL process shuts down.
Object	getAuthObject() Lookup and storage implementations that need to use user or superuser authentication can retrieve it using this method.

Method Detail

authenticate

boolean authenticate(String agentName,
                     String password,
                     String resource)
              throws InvalidDataException,
                     ObjectNotFoundException

Authenticates a CRISTAL agent. If this method returns true, then the connect method will create and return an AgentProxy for the given username using the Lookup and ProxyManager.

Parameters:

agentName - The username of the Agent to be authenticated. This must be already present as an Agent in the CRISTAL directory.

password - The Agent's password

resource - The authentication resource/domain/realm of the agent. Included so that domains may include CRISTAL users from different realms. This parameter is passed into the connect() method if required. May be null.

Returns:

a boolean indicating if the authentication was successful. If so, then the Gateway will generate an AgentProxy for the given user.

Throws:

ObjectNotFoundException - When the Agent doesn't exist

InvalidDataException - When authentication fails for another reason

authenticate

boolean authenticate(String resource)
              throws InvalidDataException,
                     ObjectNotFoundException

Authenticates a superuser connection for the server. It must be able to act on behalf of any other Agent, as the server needs to do this. Credentials may be in the CRISTAL properties, or some other mechanism.

Parameters:

resource - The authentication resource/domain/realm of the agent. Included so that domains may include CRISTAL users from different realms. This parameter is passed into the connect() method if required. May be null.

Returns:

whether the superuser is authenticated or not

Throws:

ObjectNotFoundException - When the Agent doesn't exist

InvalidDataException - When authentication fails for another reason

getAuthObject

Object getAuthObject()

Lookup and storage implementations that need to use user or superuser authentication can retrieve it using this method. This will be highly implementation specific.

Returns:

the connection/token created during authentication

disconnect

void disconnect()

Close or expire the connection as the CRISTAL process shuts down.