xmlBlaster 2.1.0 API

org.xmlBlaster.authentication.plugins
Interface I_SecurityQos

All Known Implementing Classes:
SecurityQos, SecurityQos, SecurityQos, SecurityQos

public interface I_SecurityQos

A client helper. The reason is for clients to access xmlBlaster transparently from the authentication method

Here is a typical example for a password based QoS

  <qos>
     <securityService type='htpasswd' version='1.0'>
        <![CDATA[
           <user>michele</user>
           <passwd>secret</passwd>
        ]]>
     </securityService>
  </qos>
 


Method Summary
 java.lang.String getClientIp()
          Access the remote IP of the socket - the clients IP.
 java.lang.String getCredential()
          Access the credential (e.g.
 java.lang.String getUserId()
          Get the userId, which is used for the login;
 void parse(java.lang.String xml)
          Parse the given xml string which contains the userId and credentials.
 void setClientIp(java.lang.String ip)
           
 void setCredential(java.lang.String cred)
          Set the credential (password etc.).
 void setUserId(java.lang.String userId)
          Set the userId for the login.
 java.lang.String toXml(java.lang.String extraOffset)
          Serialize the information.
 

Method Detail

parse

void parse(java.lang.String xml)
           throws XmlBlasterException
Parse the given xml string which contains the userId and credentials. Should be able to parse with or without surrounding <security> tag

Throws:
XmlBlasterException

setUserId

void setUserId(java.lang.String userId)
Set the userId for the login.

Parameters:
String - userId

getUserId

java.lang.String getUserId()
Get the userId, which is used for the login;


setClientIp

void setClientIp(java.lang.String ip)

getClientIp

java.lang.String getClientIp()
Access the remote IP of the socket - the clients IP.

Currently only passed by the SOCKET protocol plugin, other plugins return null

Returns:
null if not known or something like "192.168.1.2"

setCredential

void setCredential(java.lang.String cred)
Set the credential (password etc.).

Parameters:
String - credential

getCredential

java.lang.String getCredential()
Access the credential (e.g. password)


toXml

java.lang.String toXml(java.lang.String extraOffset)
Serialize the information.


xmlBlaster 2.1.0 API

Copyright © 1999-2011 The xmlBlaster.org contributers.