/*------------------------------------------------------------------------------
Name: CbDispatchConnection.java
Project: xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
------------------------------------------------------------------------------*/
package org.xmlBlaster.engine.dispatch;
import java.util.ArrayList;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.xmlBlaster.authentication.plugins.CryptDataHolder;
import org.xmlBlaster.authentication.plugins.I_MsgSecurityInterceptor;
import org.xmlBlaster.engine.MsgUnitWrapper;
import org.xmlBlaster.engine.ServerScope;
import org.xmlBlaster.engine.SubscriptionInfo;
import org.xmlBlaster.engine.admin.I_AdminSession;
import org.xmlBlaster.engine.admin.I_AdminSubject;
import org.xmlBlaster.engine.qos.UpdateReturnQosServer;
import org.xmlBlaster.engine.queuemsg.MsgQueueUpdateEntry;
import org.xmlBlaster.protocol.I_CallbackDriver;
import org.xmlBlaster.util.Global;
import org.xmlBlaster.util.MsgUnit;
import org.xmlBlaster.util.MsgUnitRaw;
import org.xmlBlaster.util.SessionName;
import org.xmlBlaster.util.XmlBlasterException;
import org.xmlBlaster.util.checkpoint.I_Checkpoint;
import org.xmlBlaster.util.def.Constants;
import org.xmlBlaster.util.def.ErrorCode;
import org.xmlBlaster.util.def.MethodName;
import org.xmlBlaster.util.dispatch.DispatchConnection;
import org.xmlBlaster.util.key.MsgKeyData;
import org.xmlBlaster.util.qos.MsgQosData;
import org.xmlBlaster.util.qos.address.AddressBase;
import org.xmlBlaster.util.qos.address.CallbackAddress;
import org.xmlBlaster.util.queuemsg.MsgQueueEntry;
import org.xmlBlaster.util.xbformat.I_ProgressListener;
/**
* Holding all necessary infos to establish callback
* connections and invoke their update().
* @see DispatchConnection
* @author xmlBlaster@marcelruff.info
* @author michele@laghi.eu
*/
public final class CbDispatchConnection extends DispatchConnection
{
private static Logger log = Logger.getLogger(CbDispatchConnection.class.getName());
public final String ME;
private I_CallbackDriver cbDriver;
private String cbKey;
private I_AdminSession session;
private SessionName sessionName;
//private boolean acceptRemoteLoginAsTunnel;
private boolean useRemoteLoginAsTunnel;
/**
* @param connectionsHandler The DevliveryConnectionsHandler witch i belong to
* @param address The address i shall connect to
*/
public CbDispatchConnection(Global glob, CbDispatchConnectionsHandler connectionsHandler, AddressBase address) throws XmlBlasterException {
super(glob, connectionsHandler, address);
this.ME = connectionsHandler.getDispatchManager().getQueue().getStorageId().toString();
sessionName = connectionsHandler.getDispatchManager().getSessionName();
ServerScope serverScope = (ServerScope)glob;
I_AdminSubject subject = serverScope.getAuthenticate().getSubjectInfoByName(sessionName);
if (subject != null)
this.session = subject.getSessionByPubSessionId(sessionName.getPublicSessionId());
// This other side uses us as tunnel, we won't ping it
this.useRemoteLoginAsTunnel = address.getEnv("useRemoteLoginAsTunnel", false).getValue(); //"heron".equals(qos.getSessionName().getLoginName());
//this.acceptRemoteLoginAsTunnel = address.getEnv("acceptRemoteLoginAsTunnel", false).getValue();
}
/**
* @return A nice name for logging
*/
public final String getName() {
return ME;
}
public void setAddress(AddressBase address) throws XmlBlasterException {
super.setAddress(address);
if (this.cbDriver == null || !this.cbDriver.isAlive())
loadPlugin();
this.cbDriver.init(this.glob, (CallbackAddress)address);
}
/**
* The name of the protocol driver
*/
public final String getDriverName() {
return (this.cbDriver != null) ? this.cbDriver.getName() : "unknown";
}
/** Load the appropriate protocol driver */
public final void loadPlugin() throws XmlBlasterException {
// Check if a native callback driver is passed in the glob Hashtable (e.g. for "jdbc" or "native"), take this instance
// SOCKET protocol
this.cbDriver = (I_CallbackDriver)this.address.getCallbackDriver();
if (this.cbDriver == null) {
// JDBC service
this.cbKey = address.getType() + address.getRawAddress();
this.cbDriver = glob.getNativeCallbackDriver(this.cbKey);
}
if (this.cbDriver == null) {
// instantiate the callback plugin (CORBA, XMLRPC) ...
this.cbDriver = ((org.xmlBlaster.engine.ServerScope)glob).getCbProtocolManager().getNewCbProtocolDriverInstance(address.getType());
if (this.cbDriver == null)
throw new XmlBlasterException(glob, ErrorCode.RESOURCE_CONFIGURATION_PLUGINFAILED, ME, "Sorry, callback protocol type='" + address.getType() + "' is not supported");
// glob.addNativeCallbackDriver(this.cbKey, this.cbDriver);
if (log.isLoggable(Level.FINE)) log.fine(ME+": Created callback plugin '" + this.address.getType() + "'");
}
else {
if (log.isLoggable(Level.FINE)) log.fine(ME+": Created native callback driver for protocol '" + address.getType() + "'");
}
}
public I_ProgressListener registerProgressListener(I_ProgressListener listener) {
if (this.cbDriver == null) return null;
return this.cbDriver.registerProgressListener(listener);
}
/**
* @see DispatchConnection#connectLowlevel()
*/
public final void connectLowlevel() throws XmlBlasterException {
// Initialize the driver (connect on lowlevel layer) ...
this.cbDriver.init(glob, (CallbackAddress)address);
// Check if it is available
if (super.address.getPingInterval() > 0) {
// Send clientProperty "__initialCallbackPing"=false to supress initial ping
boolean initialCallbackPing = super.address.getEnv(Constants.CLIENTPROPERTY_INITIAL_CALLBACK_PING , true).getValue();
if (initialCallbackPing)
doPing("<qos><state info='"+Constants.INFO_INITIAL+"'/></qos>");
}
if (log.isLoggable(Level.FINE)) log.fine(ME+": Connected low level to callback '" + this.address.getType() + "'");
}
class Holder {
public MsgQueueUpdateEntry msgQueueUpdateEntry;
public MsgUnitRaw msgUnitRaw;
public String subscriptionId;
public Holder(MsgQueueUpdateEntry msgQueueUpdateEntry, MsgUnitRaw msgUnitRaw, String subscriptionId) {
this.msgQueueUpdateEntry = msgQueueUpdateEntry;
this.msgUnitRaw = msgUnitRaw;
this.subscriptionId = subscriptionId;
}
}
/**
* We export/encrypt the message (call the interceptor)
*
* @param holderList list of Holder instances
* @param methodName UPDATE or UPDATE_ONEWAY
* @throws XmlBlasterException
*/
private void exportCrypt(ArrayList holderList, MethodName methodName) throws XmlBlasterException {
if (holderList == null || methodName == null) return;
I_MsgSecurityInterceptor securityInterceptor = connectionsHandler.getDispatchManager().getMsgSecurityInterceptor();
if (securityInterceptor == null) {
log.warning(ME+": No session security context, sending " + holderList.size() + " messages without encryption");
return;
}
ServerScope scope = (ServerScope)this.glob;
for (int i=0; i<holderList.size(); i++) {
Holder holder = (Holder)holderList.get(i);
// Pass subscribeQos or connectQos - clientProperties to exportMessage() in case there are
// some interesting settings provided, for example a desired XSL transformation
SubscriptionInfo subscriptionInfo = null;
Map map = null;
if (holder.subscriptionId != null) {
subscriptionInfo = scope.getRequestBroker().getClientSubscriptions().getSubscription(holder.subscriptionId);
if (subscriptionInfo != null)
map = subscriptionInfo.getQueryQosDataClientProperties();
//String xslFileName = subscriptionInfo.getQueryQosData().getClientProperty("__xslTransformerFileName", (String)null);
}
else {
// todo: use map=ConnectQos.getClientProperties() as a map to pass to dataHolder
}
CryptDataHolder dataHolder = new CryptDataHolder(methodName, holder.msgUnitRaw, map);
holder.msgUnitRaw = securityInterceptor.exportMessage(dataHolder);
}
if (log.isLoggable(Level.FINE)) log.fine(ME+": Exported/encrypted " + holderList.size() + " " + methodName + " messages.");
}
/**
* Send the messages back to the client.
* @param msgArr Should be a copy of the original, since we export it which changes/encrypts the content
* <p>
* The RETURN value is transferred in the msgArr[i].getReturnObj(), for oneway updates it is null
* </p>
*/
public void doSend(MsgQueueEntry[] msgArr_, boolean isAsyncMode) throws XmlBlasterException
{
ArrayList oneways = null;
ArrayList responders = null;
{
for (int i=0; i<msgArr_.length; i++) {
MsgQueueUpdateEntry entry = (MsgQueueUpdateEntry)msgArr_[i];
MsgUnitWrapper msgUnitWrapper = entry.getMsgUnitWrapper();
if (msgUnitWrapper == null) {
if (log.isLoggable(Level.FINE)) log.fine(ME+": doSend("+entry.getLogId()+") ignoring callback message as no meat is available (assume expired)");
entry.setReturnObj(new UpdateReturnQosServer(this.glob, Constants.RET_EXPIRED)); //"<qos><state id='EXPIRED'/></qos>";
continue;
}
if (msgUnitWrapper.getMsgQosData().isPtp() && session!=null && !session.getConnectQos().isPtpAllowed()) {
if (log.isLoggable(Level.FINE)) log.fine(ME+": doSend("+entry.getLogId()+") ignoring callback message as PtP is not wanted");
entry.setReturnObj(new UpdateReturnQosServer(this.glob, Constants.RET_ERASED));
continue;
}
MsgUnit mu = msgUnitWrapper.getMsgUnit();
//MsgUnit mu = entry.getMsgUnit(); throws unwanted exception if meat==null (forceDestroy)
MsgQosData msgQosData = (MsgQosData)mu.getQosData().clone();
msgQosData.setTopicProperty(null);
msgQosData.setState(entry.getState());
msgQosData.setSubscriptionId(entry.getSubscriptionId());
msgQosData.setQueueIndex(i);
msgQosData.setQueueSize(connectionsHandler.getDispatchManager().getQueue().getNumOfEntries());
if (msgQosData.getNumRouteNodes() == 1) {
msgQosData.clearRoutes();
}
// Convert oid to original again for erased events fired by TopicHandler.java notifySubscribersAboutErase()
if (mu.getKeyOid().equals(Constants.EVENT_OID_ERASEDTOPIC)) {
mu = new MsgUnit(mu, (MsgKeyData)mu.getKeyData().clone(), null, msgQosData);
String oid = mu.getQosData().getClientProperty("__oid", (String)null);
if (oid != null) {
mu.getKeyData().setOid(oid);
try {
((org.xmlBlaster.util.qos.MsgQosData)mu.getQosData()).setSubscriptionId(mu.getQosData().getClientProperty("__subscriptionId", (String)null));
}
catch (Throwable e) {
log.severe(ME+": Failed to set subscriptionId: " + e.toString());
}
String domain = mu.getQosData().getClientProperty("__domain", (String)null);
if (domain != null) {
mu.getKeyData().setDomain(domain);
mu.getQosData().getClientProperties().remove("__domain");
}
mu.getQosData().getClientProperties().remove("__oid");
mu.getQosData().getClientProperties().remove("__subscriptionId");
}
}
else {
mu = new MsgUnit(mu, null, null, msgQosData);
}
MsgUnitRaw raw = new MsgUnitRaw(mu, mu.getKeyData().toXml(), mu.getContent(), mu.getQosData().toXml());
if (address.oneway() || entry.updateOneway()) {
if (oneways == null) oneways = new ArrayList();
oneways.add(new Holder(entry, raw, entry.getSubscriptionId()));
}
else {
if (responders == null) responders = new ArrayList();
responders.add(new Holder(entry, raw, entry.getSubscriptionId()));
}
}
}
exportCrypt(responders, MethodName.UPDATE);
exportCrypt(oneways, MethodName.UPDATE_ONEWAY);
if (oneways != null) {
MsgUnitRaw[] raws = new MsgUnitRaw[oneways.size()];
for (int i=0; i<oneways.size(); i++) {
raws[i] = ((Holder)oneways.get(i)).msgUnitRaw;
}
cbDriver.sendUpdateOneway(raws);
connectionsHandler.getDispatchStatistic().incrNumUpdate(oneways.size());
if (log.isLoggable(Level.FINE)) log.fine(ME+": Success, sent " + oneways.size() + " oneway messages.");
I_Checkpoint cp = glob.getCheckpointPlugin();
if (cp != null) {
for (int i=0; i<oneways.size(); i++) {
Holder h = (Holder)oneways.get(i);
cp.passingBy(I_Checkpoint.CP_UPDATE_ACK, (MsgUnit)h.msgUnitRaw.getMsgUnit(),
sessionName, null);
}
}
}
if (responders != null) {
if (log.isLoggable(Level.FINE)) log.fine(ME+": Before update " + responders.size() + " acknowledged messages ...");
MsgUnitRaw[] raws = new MsgUnitRaw[responders.size()];
for (int i=0; i<responders.size(); i++) {
raws[i] = ((Holder)responders.get(i)).msgUnitRaw;
}
String[] rawReturnVal = null;
try {
rawReturnVal = cbDriver.sendUpdate(raws);
}
catch (Throwable t) {
// http://www.xmlblaster.org/xmlBlaster/doc/requirements/interface.update.html#exception
XmlBlasterException ex = (t instanceof XmlBlasterException) ? (XmlBlasterException)t :
new XmlBlasterException(glob, ErrorCode.USER_UPDATE_INTERNALERROR, ME, "Callback failed", t);
if (!ex.isServerSide()) { // Transform remote exceptions must be of type user.* or communication.*
if (!ex.isUser() && !ex.isCommunication())
ex = new XmlBlasterException(glob, ErrorCode.USER_UPDATE_INTERNALERROR, ME, "Callback failed", ex);
}
throw ex;
}
connectionsHandler.getDispatchStatistic().incrNumUpdate(raws.length);
if (log.isLoggable(Level.FINE)) log.fine(ME+": Success, sent " + raws.length + " acknowledged messages, return value #1 is '" + rawReturnVal[0] + "'");
I_Checkpoint cp = glob.getCheckpointPlugin();
if (cp != null) {
for (int i=0; i<raws.length; i++) {
cp.passingBy(I_Checkpoint.CP_UPDATE_ACK, (MsgUnit)raws[i].getMsgUnit(),
sessionName, null);
}
}
// this is done since the client could send one single bulk acknowledge
if (rawReturnVal != null && rawReturnVal.length == 1 && raws.length > 1) {
String bulkReturnValue = rawReturnVal[0];
log.fine("Reconstructing return values of a bulk acknowledge '" + bulkReturnValue + "'");
rawReturnVal = new String[raws.length];
for (int i=0; i < rawReturnVal.length; i++)
rawReturnVal[i] = bulkReturnValue;
}
if (rawReturnVal != null && rawReturnVal.length == raws.length) {
I_MsgSecurityInterceptor securityInterceptor = connectionsHandler.getDispatchManager().getMsgSecurityInterceptor();
for (int i=0; i<rawReturnVal.length; i++) {
MsgQueueUpdateEntry entry = ((Holder)responders.get(i)).msgQueueUpdateEntry;
if (!entry.wantReturnObj())
continue;
if (securityInterceptor != null) {
// decrypt ...
CryptDataHolder dataHolder = new CryptDataHolder(MethodName.UPDATE,
new MsgUnitRaw(null, (byte[])null, rawReturnVal[i]));
dataHolder.setReturnValue(true);
rawReturnVal[i] = securityInterceptor.importMessage(dataHolder).getQos();
}
// create object
try {
entry.setReturnObj(new UpdateReturnQosServer(glob, rawReturnVal[i]));
}
catch (Throwable e) {
log.warning(ME+": Can't parse returned value '" + rawReturnVal[i] + "', setting to default: " + e.toString());
//e.printStackTrace();
UpdateReturnQosServer updateRetQos = new UpdateReturnQosServer(glob, "<qos/>");
updateRetQos.setException(e);
entry.setReturnObj(updateRetQos);
}
}
if (log.isLoggable(Level.FINE)) log.fine(ME+": Imported/decrypted " + rawReturnVal.length + " message return values.");
}
else
log.severe(ME+": Unexpected UpdateReturnQos '" + (rawReturnVal==null?"null":""+rawReturnVal.length)+ "', expected " + raws.length);
}
}
/**
* @see org.xmlBlaster.util.dispatch.DispatchConnection#doPing(String)
*/
public final String doPing(String data) throws XmlBlasterException {
if (this.useRemoteLoginAsTunnel) {
// We don't ping, the other side does not know what to do with it
// We are only guest and using the socket from the other cluster node
return Constants.RET_OK; // fake a return for ping
}
String ret = this.cbDriver.ping(data);
return (ret==null) ? "" : ret;
}
/**
*
* Nothing to do here
*/
public final void resetConnection() {
glob.removeNativeCallbackDriver(cbKey);
if (this.cbDriver != null) {
try {
this.cbDriver.shutdown();
} catch (XmlBlasterException e) {
e.printStackTrace();
}
}
}
/**
* On reconnect polling try to establish the connection.
*/
protected final void reconnect() throws XmlBlasterException {
// this.connectionsHandler.createDispatchConnection(address);
this.cbDriver.init(glob, (CallbackAddress)address);
}
/**
* Stop all callback drivers of this client.
*/
public final void shutdown() throws XmlBlasterException {
super.shutdown();
glob.removeNativeCallbackDriver(cbKey);
if (this.cbDriver != null) {
this.cbDriver.shutdown();
}
}
/**
* Dump state of this object into a XML ASCII string.
* <br>
* @param extraOffset indenting of tags for nice output
* @return internal state as an XML ASCII string
*/
public final String toXml(String extraOffset) {
StringBuffer sb = new StringBuffer(256);
String offset = "\n ";
if (extraOffset == null) extraOffset = "";
offset += extraOffset;
sb.append(offset + "<CbDispatchConnection>");
address.toXml(" " + offset);
if (this.cbDriver == null)
sb.append(offset).append(" <noCallbackDriver />");
else
sb.append(offset).append(" <callback type='" + getDriverName() + "' state='" + getState() + "'/>");
sb.append(offset).append("</CbDispatchConnection>");
return sb.toString();
}
public I_AdminSession getAdminSession() {
return this.session;
}
protected boolean forcePingFailure() {
return false;
}
}