rwt.remote.Connection.js Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2002, 2022 Innoopract Informationssysteme GmbH and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Innoopract Informationssysteme GmbH - initial API and implementation
* EclipseSource - ongoing development
******************************************************************************/
(function() {
var Client = rwt.client.Client;
var Timer = rwt.client.Timer;
var Processor = rwt.remote.MessageProcessor;
var ErrorHandler = rwt.runtime.ErrorHandler;
var EventUtil = rwt.remote.EventUtil;
var ServerPush = rwt.client.ServerPush;
var ClientDocument = rwt.widgets.base.ClientDocument;
var Widget = rwt.widgets.base.Widget;
rwt.qx.Class.define( "rwt.remote.Connection", {
extend : rwt.qx.Target,
statics : {
getInstance : function() {
return rwt.runtime.Singletons.get( rwt.remote.Connection );
}
},
construct : function() {
this.base( arguments );
this._url = "";
this._writer = null;
this._event = null;
this._requestCounter = 0;
this._requestPending = false;
this._currentCursor = null;
this._connectionId = null;
this._sendTimer = new Timer( 60 );
this._sendTimer.addEventListener( "interval", function() {
this.sendImmediate( true );
}, this );
this._delayTimer = new Timer();
this._delayTimer.addEventListener( "interval", function() {
this._delayTimer.stop();
this.send();
}, this );
this._waitHintTimer = new Timer( 1000 );
this._waitHintTimer.addEventListener( "interval", this._showWaitHint, this );
this._retryHandler = null;
this._sendListeners = [];
},
destruct : function() {
this._retryHandler = null;
this._sendTimer.dispose();
this._sendTimer = null;
this._waitHintTimer.dispose();
this._waitHintTimer = null;
},
members : {
//////
// API
setUrl : function( url ) {
this._url = url;
},
getUrl : function() {
return this._url;
},
setConnectionId : function( connectionId ) {
this._connectionId = connectionId;
},
getConnectionId : function() {
return this._connectionId;
},
_flushEvent : function() {
if( this._event ) {
var writer = this.getMessageWriter();
this._event[ 1 ] = this._event[ 1 ].split( "." ).pop();
writer.appendNotify.apply( writer, this._event );
this._event = null;
}
},
sendDelayed : function( time ) {
this._delayTimer.setInterval( time );
this._delayTimer.start();
},
/**
* Sends an asynchronous request within 60 milliseconds
*/
send : function() {
this._sendTimer.start();
},
/**
* Sends an synchronous or asynchronous request immediately. All parameters that were added
* since the last request will be sent.
*/
sendImmediate : function( async ) {
this._delayTimer.stop();
if( this._requestPending && async ) {
this._sendTimer.stop();
this.send();
} else {
this._flushEvent();
this.dispatchSimpleEvent( "send" );
rap._.notify( "send" );
this._flushEvent();
this._sendTimer.stop();
this.getMessageWriter().appendHead( "requestCounter", this._requestCounter++ );
this._requestPending = true;
this._currentCursor = ClientDocument.getInstance().getGlobalCursor();
this._startWaitHintTimer();
var request = this._createRequest();
request.setAsynchronous( async );
request.setData( this.getMessageWriter().createMessage() );
this._writer.dispose();
this._writer = null;
request.send();
this._removeSendListeners();
}
},
sendBeacon : function() {
var cid = "";
if( this._connectionId ) {
cid = ( this._url.indexOf( "?" ) === -1 ? "?cid=" : "&cid=" ) + this._connectionId;
}
var body = this.getMessageWriter().createMessage();
var headers = { type: 'application/json' };
navigator.sendBeacon( this._url + cid, new Blob( [body], headers ) );
},
getMessageWriter : function() {
if( this._writer === null ) {
this._writer = new rwt.remote.MessageWriter();
}
return this._writer;
},
getRemoteObject : function( target ) {
return rwt.remote.RemoteObjectFactory.getRemoteObject( target );
},
onNextSend : function( func, context ) {
this._sendListeners.push( [ func, context ] );
this.addEventListener( "send", func, context );
},
getWaitHintTimer : function() {
return this._waitHintTimer;
},
_startWaitHintTimer : function() {
if( this._requestCounter !== 0 ) {
this._waitHintTimer.start();
}
},
_removeSendListeners : function() {
for( var i = 0; i < this._sendListeners.length; i++ ) {
var item = this._sendListeners[ i ];
this.removeEventListener( "send", item[ 0 ], item[ 1 ] );
}
this._sendListeners = [];
},
////////////
// Internals
_createRequest : function() {
var cid = "";
if( this._connectionId ) {
cid = ( this._url.indexOf( "?" ) === -1 ? "?cid=" : "&cid=" ) + this._connectionId;
}
var result = new rwt.remote.Request( this._url + cid, "POST", "application/json" );
result.setSuccessHandler( this._handleSuccess, this );
result.setRedirectHandler( this._handleRedirect, this );
result.setErrorHandler( this._handleError, this );
return result;
},
////////////////////////
// Handle request events
_handleError : function( event ) {
this._hideWaitHint();
if( this._isConnectionError( event.status ) ) {
this._handleConnectionError( event );
} else {
var text = event.responseText;
if( text && text.length > 0 ) {
if( this._isJsonResponse( event ) ) {
var messageObject = JSON.parse( text );
ErrorHandler.showErrorBox( messageObject.head.error, true );
} else {
ErrorHandler.showErrorBox( "server error", true, text );
}
} else {
ErrorHandler.showErrorBox( "request failed" );
}
}
},
_handleSuccess : function( event ) {
try {
var messageObject = JSON.parse( event.responseText );
rwt.remote.EventUtil.setSuspended( true );
var that = this;
Processor.processMessage( messageObject, function() {
that._requestPending = false;
Widget.flushGlobalQueues();
rap._.notify( "render" );
EventUtil.setSuspended( false );
ServerPush.getInstance().sendServerPushRequest();
that.dispatchSimpleEvent( "received" );
that._hideWaitHint();
} );
} catch( ex ) {
this._hideWaitHint();
ErrorHandler.processJavaScriptErrorInResponse( event.responseText, ex, event.target );
}
},
_handleRedirect : function( event ) {
Processor.processMessage( { head: { redirect: event.responseHeaders.location } } );
},
///////////////////////////////
// Handling connection problems
_handleConnectionError : function( event ) {
ClientDocument.getInstance().setGlobalCursor( null );
rwt.runtime.ErrorHandler.showErrorBox( "connection error", false );
this._retryHandler = function() {
var request = this._createRequest();
var failedRequest = event.target;
request.setAsynchronous( failedRequest.getAsynchronous() );
request.setData( failedRequest.getData() );
request.send();
};
},
_retry : function() {
try {
ErrorHandler.hideErrorBox();
this._showWaitHint();
this._retryHandler();
} catch( ex ) {
rwt.runtime.ErrorHandler.processJavaScriptError( ex );
}
},
_isConnectionError : rwt.util.Variant.select( "qx.client", {
"trident" : function( statusCode ) {
// for a description of the IE status codes, see
// http://support.microsoft.com/kb/193625
// Some modern IEs use standard, but not all
return ( statusCode === 12007 // ERROR_INTERNET_NAME_NOT_RESOLVED
|| statusCode === 12029 // ERROR_INTERNET_CANNOT_CONNECT
|| statusCode === 12030 // ERROR_INTERNET_CONNECTION_ABORTED
|| statusCode === 12031 // ERROR_INTERNET_CONNECTION_RESET
|| statusCode === 12152 // ERROR_HTTP_INVALID_SERVER_RESPONSE
|| statusCode === 0 );
},
"gecko" : function( statusCode ) {
// Firefox 3 reports other statusCode than oder versions (bug #249814)
var result;
// Check if Gecko > 1.9 is running (used in FF 3)
// Gecko/app integration overview: http://developer.mozilla.org/en/Gecko
if( Client.getMajor() * 10 + Client.getMinor() >= 19 ) {
result = ( statusCode === 0 );
} else {
result = ( statusCode === -1 );
}
return result;
},
"default" : function( statusCode ) {
return statusCode === 0;
}
} ),
_isJsonResponse : function( event ) {
var contentType = event.responseHeaders[ "content-type" ];
return contentType.indexOf( "application/json" ) !== -1;
},
///////////////////////////////////////////////////
// Wait hint - UI feedback while request is running
_showWaitHint : function() {
this._waitHintTimer.stop();
ClientDocument.getInstance().setGlobalCursor( "progress" );
ErrorHandler.showWaitHint();
},
_hideWaitHint : function() {
this._waitHintTimer.stop();
ErrorHandler.hideErrorBox();
ClientDocument.getInstance().setGlobalCursor( this._currentCursor );
}
}
} );
}());
/**
* Path that points to the "resources/resource" path in the bundle. Files
* must be registered in ClientResources.java.
*/
rwt.remote.Connection.RESOURCE_PATH = "./rwt-resources/resource/";
© 2015 - 2025 Weber Informatics LLC | Privacy Policy