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

public 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

public void setUserId(java.lang.String userId)

Set the userId for the login.

getUserId

public java.lang.String getUserId()

Get the userId, which is used for the login;

setClientIp

public void setClientIp(java.lang.String ip)

getClientIp

public 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

public void setCredential(java.lang.String cred)

Set the credential (password etc.).

getCredential

public java.lang.String getCredential()

Access the credential (e.g. password)

toXml

public java.lang.String toXml(java.lang.String extraOffset)

Serialize the information.