i_securityqos.java

java开源的企业总线.xmlBlaster

package org.xmlBlaster.authentication.plugins;
import org.xmlBlaster.util.XmlBlasterException;

/**
 * A client helper.
 *
 * The reason is for clients to access xmlBlaster
 * transparently from the authentication method
 * <p />
 * Here is a typical example for a password based QoS
 * <pre>
 *  &lt;qos>
 *     &lt;securityService type='htpasswd' version='1.0'>
 *        &lt;![CDATA[
 *           &lt;user>michele&lt;/user>
 *           &lt;passwd>secret&lt;/passwd>
 *        ]]>
 *     &lt;/securityService>
 *  &lt;/qos>
 * </pre>
 */
public interface I_SecurityQos {

   /**
    * Parse the given xml string which contains the userId and credentials.
    * Should be able to parse with or without surrounding &lt;security> tag
    */
   public void parse(String xml) throws XmlBlasterException;

   /**
    * Set the userId for the login.
    * <p/>
    * @param String userId
    */
   public void setUserId(String userId);

   /**
    * Get the userId, which is used for the login;
    */
   public String getUserId();

   public void setClientIp (String ip);

   /**
    * Access the remote IP of the socket - the clients IP.
    * <p />
    * Currently only passed by the SOCKET protocol plugin, other plugins return null
    * @return null if not known or something like "192.168.1.2"
    *
    */
   public String getClientIp();

   /**
    * Set the credential (password etc.).
    * <p/>
    * @param String credential
    */
   public void setCredential(String cred);

   /**
    * Access the credential (e.g. password)
    */
   public String getCredential();

   /**
    * Serialize the information.
    */
   public String toXml(String extraOffset);

}