xmlBlaster 2.2.0 API

org.xmlBlaster.protocol.xmlrpc
Class AuthenticateImpl

java.lang.Object
  extended by org.xmlBlaster.protocol.xmlrpc.AuthenticateImpl

public class AuthenticateImpl
extends java.lang.Object

The methods of this class are callable bei XMLRPC clients.

void return is not allowed so we return an empty string instead

Author:
Marcel Ruff.

Field Summary
private  AddressServer addressServer
           
private  I_Authenticate authenticate
           
private  Global glob
           
private static java.util.logging.Logger log
           
private static java.lang.String ME
           
private  XmlBlasterImpl xblImpl
           
 
Constructor Summary
AuthenticateImpl(Global glob, XmlRpcDriver driver, I_Authenticate authenticate, XmlBlasterImpl xblImpl)
          Constructor.
 
Method Summary
 java.lang.String connect(java.lang.String qos_literal)
          Login to xmlBlaster.
 java.lang.String connect(java.lang.String sessionId, java.lang.String qos_literal)
          Login to xmlBlaster.
private  java.lang.String connectInternal(java.lang.String sessionId, java.lang.String qos_literal, boolean singleChannel)
          Login to xmlBlaster.
 java.lang.String connectSingleChannel(java.lang.String sessionId, java.lang.String qos_literal)
          Login to xmlBlaster.
 java.lang.String disconnect(java.lang.String sessionId, java.lang.String qos_literal)
           
private  java.lang.String extractSessionIdFromQos(java.lang.String literal)
           
 java.lang.String login(java.lang.String loginName, java.lang.String passwd, java.lang.String qos_literal, java.lang.String sessionId)
          Deprecated. Use connect() instead
 java.lang.String logout(java.lang.String sessionId)
          Deprecated. Use disconnect() instead
 java.lang.String ping(java.lang.String qos)
          Test the xml-rpc connection and xmlBlaster availability.
 java.lang.Object xmlScriptInvoke(java.lang.String literal)
          invokeSubscribe to messages.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ME

private static final java.lang.String ME

glob

private final Global glob

log

private static java.util.logging.Logger log

authenticate

private final I_Authenticate authenticate

addressServer

private final AddressServer addressServer

xblImpl

private XmlBlasterImpl xblImpl
Constructor Detail

AuthenticateImpl

public AuthenticateImpl(Global glob,
                        XmlRpcDriver driver,
                        I_Authenticate authenticate,
                        XmlBlasterImpl xblImpl)
                 throws XmlBlasterException
Constructor.

Throws:
XmlBlasterException
Method Detail

login

public java.lang.String login(java.lang.String loginName,
                              java.lang.String passwd,
                              java.lang.String qos_literal,
                              java.lang.String sessionId)
                       throws XmlBlasterException
Deprecated. Use connect() instead

Do login to xmlBlaster.

Returns:
The secret sessionId as a raw string
Throws:
XmlBlasterException
See Also:
Authenticate.connect(ConnectQosServer,String)

logout

public java.lang.String logout(java.lang.String sessionId)
                        throws XmlBlasterException
Deprecated. Use disconnect() instead

Logout of a client.

void return is not allowed so we return an empty string instead

Throws:
XmlBlasterException - If client is unknown

extractSessionIdFromQos

private final java.lang.String extractSessionIdFromQos(java.lang.String literal)

connectInternal

private java.lang.String connectInternal(java.lang.String sessionId,
                                         java.lang.String qos_literal,
                                         boolean singleChannel)
                                  throws org.apache.xmlrpc.XmlRpcException
Login to xmlBlaster.

Parameters:
qos_literal - See ConnectQosServer.java
Returns:
The xml string from ConnectReturnQos.java
Throws:
org.apache.xmlrpc.XmlRpcException
See Also:
ConnectQosServer, ConnectReturnQosServer

connect

public java.lang.String connect(java.lang.String qos_literal)
                         throws org.apache.xmlrpc.XmlRpcException
Login to xmlBlaster. This is the old connect method

Parameters:
qos_literal - See ConnectQosServer.java
Returns:
The xml string from ConnectReturnQos.java
Throws:
org.apache.xmlrpc.XmlRpcException
See Also:
ConnectQosServer, ConnectReturnQosServer

connect

public java.lang.String connect(java.lang.String sessionId,
                                java.lang.String qos_literal)
                         throws org.apache.xmlrpc.XmlRpcException
Login to xmlBlaster.

Parameters:
qos_literal - See ConnectQosServer.java
Returns:
The xml string from ConnectReturnQos.java
Throws:
org.apache.xmlrpc.XmlRpcException
See Also:
ConnectQosServer, ConnectReturnQosServer

connectSingleChannel

public java.lang.String connectSingleChannel(java.lang.String sessionId,
                                             java.lang.String qos_literal)
                                      throws org.apache.xmlrpc.XmlRpcException
Login to xmlBlaster.

Parameters:
qos_literal - See ConnectQosServer.java
Returns:
The xml string from ConnectReturnQos.java
Throws:
org.apache.xmlrpc.XmlRpcException
See Also:
ConnectQosServer, ConnectReturnQosServer

disconnect

public java.lang.String disconnect(java.lang.String sessionId,
                                   java.lang.String qos_literal)
                            throws org.apache.xmlrpc.XmlRpcException
Throws:
org.apache.xmlrpc.XmlRpcException

ping

public java.lang.String ping(java.lang.String qos)
Test the xml-rpc connection and xmlBlaster availability.

See Also:
org.xmlBlaster.protocol.I_XmlBlaster#ping(String)

xmlScriptInvoke

public java.lang.Object xmlScriptInvoke(java.lang.String literal)
                                 throws XmlBlasterException
invokeSubscribe to messages.

Throws:
XmlBlasterException
See Also:
The interface.subscribe requirement

xmlBlaster 2.2.0 API

Copyright © 1999-2014 The xmlBlaster.org contributers.