xmlBlaster 2.1.0 API

org.xmlBlaster.authentication.plugins.ldap
Class ClientPlugin

java.lang.Object
  extended by org.xmlBlaster.authentication.plugins.ldap.ClientPlugin
All Implemented Interfaces:
I_ClientPlugin, I_MsgSecurityInterceptor

public class ClientPlugin
extends java.lang.Object
implements I_ClientPlugin

Helper only for Java clients.

This class does nothing else than:

1. Generate the xml string which is passed as the connect() or login() qos string with the help of SecurityQos.java

2. The messages are not crypted or modified, so the importMessage() and exportMessage() methods do nothing.

Author:
Marcel Ruff.
See Also:
SecurityQos

Field Summary
private  Global glob
           
static java.lang.String ME
           
 
Constructor Summary
ClientPlugin()
           
 
Method Summary
 I_SecurityQos createSecurityQos()
          The client application can use this method to get a new I_SecurityQos instance, and use it to set userId/password etc.
 MsgUnitRaw exportMessage(CryptDataHolder dataHolder)
          Encrypt, sign, seal an outgoing message.
 java.lang.String getType()
           
 java.lang.String getVersion()
           
 MsgUnitRaw importMessage(CryptDataHolder dataHolder)
          Decrypt, check, unseal etc an incomming message.
 void init(Global glob, PluginInfo pluginInfo)
           
 void setSessionData(java.lang.String sessionData)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ME

public static final java.lang.String ME
See Also:
Constant Field Values

glob

private Global glob
Constructor Detail

ClientPlugin

public ClientPlugin()
Method Detail

init

public void init(Global glob,
                 PluginInfo pluginInfo)
Specified by:
init in interface I_ClientPlugin

getType

public java.lang.String getType()
Specified by:
getType in interface I_ClientPlugin
Returns:
The plugin type, e.g. "htpasswd"

getVersion

public java.lang.String getVersion()
Specified by:
getVersion in interface I_ClientPlugin
Returns:
The plugin version, e.g. "1.0"

createSecurityQos

public I_SecurityQos createSecurityQos()
The client application can use this method to get a new I_SecurityQos instance, and use it to set userId/password etc.

Specified by:
createSecurityQos in interface I_ClientPlugin

setSessionData

public void setSessionData(java.lang.String sessionData)
Specified by:
setSessionData in interface I_ClientPlugin

importMessage

public MsgUnitRaw importMessage(CryptDataHolder dataHolder)
                         throws XmlBlasterException
Description copied from interface: I_MsgSecurityInterceptor
Decrypt, check, unseal etc an incomming message.

Use this to import (decrypt) the xmlKey or xmlQos

Specified by:
importMessage in interface I_MsgSecurityInterceptor
Parameters:
dataHolder - A container holding the MsgUnitRaw and some additional informations
Returns:
The original or modified message
Throws:
XmlBlasterException - Thrown i.e. if the message has been modified
See Also:
I_MsgSecurityInterceptor.exportMessage(CryptDataHolder)

exportMessage

public MsgUnitRaw exportMessage(CryptDataHolder dataHolder)
                         throws XmlBlasterException
Description copied from interface: I_MsgSecurityInterceptor
Encrypt, sign, seal an outgoing message.

Use this to export (encrypt) the xmlKey or xmlQos

Specified by:
exportMessage in interface I_MsgSecurityInterceptor
Parameters:
dataHolder - A container holding the MsgUnitRaw and some additional informations
Returns:
The probably more secure string
Throws:
XmlBlasterException - Thrown if the message cannot be processed
See Also:
I_MsgSecurityInterceptor.importMessage(CryptDataHolder)

xmlBlaster 2.1.0 API

Copyright © 1999-2011 The xmlBlaster.org contributers.