org.dmd.dmp.server.servlet.security

Class SecurityPlugin

java.lang.Object

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

org.dmd.dmp.server.servlet.security.SecurityPlugin

All Implemented Interfaces:

SecurityManagerIF

public class SecurityPlugin
extends DmpServletPlugin
implements SecurityManagerIF

This is an example implementation of a plugin that implements the role of SecurityManager. When initialized, it creates the UserFolderRI and a single UserRI as follows: UserFolderRI dotName uf UserRI dotName uf.1 userName example password example

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGINNAME

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

cache, pluginConfig, pluginManager, servlet

Constructor Summary

Constructors

Constructor and Description
SecurityPlugin()

Method Summary

Modifier and Type	Method and Description
SessionRI	getSession(org.dmd.dmp.server.extended.Request request)
protected 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.
org.dmd.dmp.server.extended.Response	validateSession(org.dmd.dmp.server.extended.Request request) This method should be overloaded to perform validation of the session identifier associated with the request as well as any additional security checks required.

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

getID, getPluginName, preInit, setManagerAndConfig, shutdown, start

Methods inherited from class java.lang.Object

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

Field Detail

PLUGINNAME

public static String PLUGINNAME

Constructor Detail

SecurityPlugin

public SecurityPlugin()

Method Detail

init

protected void init()
             throws org.dmd.util.exceptions.ResultException

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

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

Description copied from interface: SecurityManagerIF

This method should be overloaded to perform validation of the session identifier associated with the request as well as any additional security checks required. For example, if security groups have been implemented and the associated user doesn't have sufficient privileges to perform an operation, the request should be denied.

Specified by:

validateSession in interface SecurityManagerIF

Parameters:

request - the request to be checked.

Returns:

An error response if any problems are found and null if everything is okay.

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.