org.dmd.dmp.server.servlet.base.plugins

Class BasicSecurityPlugin

java.lang.Object

org.dmd.dmp.server.servlet.base.DmpServletPlugin

org.dmd.dmp.server.servlet.base.plugins.BasicSecurityPlugin

All Implemented Interfaces:

SecurityManagerIF

public class BasicSecurityPlugin
extends DmpServletPlugin
implements SecurityManagerIF

The BasicSecurityPlugin provides basic security mechanisms for an example application. It defines two users: user1 and user2 whose passwords are the same as the user name.

Field Summary

Fields inherited from class org.dmd.dmp.server.servlet.base.DmpServletPlugin

cache, pluginConfig, pluginManager, servlet

Constructor Summary

Constructors

Constructor and Description
BasicSecurityPlugin()

Method Summary

Modifier and Type	Method and Description
SessionRI	getSession(org.dmd.dmp.server.extended.Request request)
void	init() Derived classes should perform any initialization logic required.
org.dmd.dmp.server.extended.LoginResponse	login(org.dmd.dmp.server.extended.LoginRequest request) This method should be overloaded to perform whatever authentication is required to determine that a user is allowed to connect.
org.dmd.dmp.server.extended.LogoutResponse	logout(org.dmd.dmp.server.extended.LogoutRequest request) Terminates the associated session with the server.
void	preInit()
org.dmd.dmp.server.extended.Response	validateSession(org.dmd.dmp.server.extended.Request request) All requests sent to the servlet via the Dark Matter Protocol must be associated with a valid session; all DMP Requests should have the session identifier set.

Methods inherited from class org.dmd.dmp.server.servlet.base.DmpServletPlugin

getID, getPluginName, setManagerAndConfig, shutdown, start

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicSecurityPlugin

public BasicSecurityPlugin()

Method Detail

preInit

public void preInit()

Overrides:

preInit in class DmpServletPlugin

init

public void init()
          throws org.dmd.util.exceptions.ResultException,
                 org.dmd.dmc.DmcValueException

Description copied from class: DmpServletPlugin

Derived classes should perform any initialization logic required. If a plugin has indicated that it depends on another plugin, it is safe to assume that the other plugin has been initialized.

Overrides:

init in class DmpServletPlugin

Throws:

org.dmd.util.exceptions.ResultException

org.dmd.dmc.DmcValueException

login

public org.dmd.dmp.server.extended.LoginResponse login(org.dmd.dmp.server.extended.LoginRequest request)

Description copied from interface: SecurityManagerIF

This method should be overloaded to perform whatever authentication is required to determine that a user is allowed to connect.

Specified by:

login in interface SecurityManagerIF

Parameters:

request - The login request.

Returns:

A login response that indicates success or failure.

logout

public org.dmd.dmp.server.extended.LogoutResponse logout(org.dmd.dmp.server.extended.LogoutRequest request)

Description copied from interface: SecurityManagerIF

Terminates the associated session with the server. Any subsequent transactions that use the related session identifier will be rejected.

Specified by:

logout in interface SecurityManagerIF

Returns:

a logout response.

validateSession

public org.dmd.dmp.server.extended.Response validateSession(org.dmd.dmp.server.extended.Request request)
                                                     throws org.dmd.dmc.DmcValueException

All requests sent to the servlet via the Dark Matter Protocol must be associated with a valid session; all DMP Requests should have the session identifier set.

Specified by:

validateSession in interface SecurityManagerIF

Parameters:

request - the request whose session will be validated.

Returns:

null if the session is okay and an error response otherwise.

Throws:

org.dmd.dmc.DmcValueException

getSession

public SessionRI getSession(org.dmd.dmp.server.extended.Request request)

Specified by:

getSession in interface SecurityManagerIF

Parameters:

request - The request for which we require the session handle.

Returns:

the session object associated with a request.