remoting/webapp/crd/js/host_session.js

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /**
   6  * @fileoverview
   7  * Class handling creation and teardown of a remoting host session.
   8  *
   9  * This abstracts a <embed> element and controls the plugin which does the
  10  * actual remoting work.  There should be no UI code inside this class.  It
  11  * should be purely thought of as a controller of sorts.
  12  */
  13
  14 'use strict';
  15
  16 /** @suppress {duplicate} */
  17 var remoting = remoting || {};
  18
  19 /**
  20  * @constructor
  21  * @implements {base.Disposable}
  22  */
  23 remoting.HostSession = function() {
  24   /** @type {remoting.It2MeHostFacade} @private */
  25   this.hostFacade_ = null;
  26 };
  27
  28 // Note that these values are copied directly from host_script_object.h and
  29 // must be kept in sync.
  30 /** @enum {number} */
  31 remoting.HostSession.State = {
  32   UNKNOWN: -1,
  33   DISCONNECTED: 0,
  34   STARTING: 1,
  35   REQUESTED_ACCESS_CODE: 2,
  36   RECEIVED_ACCESS_CODE: 3,
  37   CONNECTED: 4,
  38   DISCONNECTING: 5,
  39   ERROR: 6,
  40   INVALID_DOMAIN_ERROR: 7
  41 };
  42
  43 remoting.HostSession.prototype.dispose = function() {
  44   base.dispose(this.hostFacade_);
  45   this.hostFacade_ = null;
  46 };
  47
  48 /**
  49  * @param {string} stateString The string representation of the host state.
  50  * @return {remoting.HostSession.State} The HostSession.State enum value
  51  *     corresponding to stateString.
  52  */
  53 remoting.HostSession.State.fromString = function(stateString) {
  54   if (!remoting.HostSession.State.hasOwnProperty(stateString)) {
  55     console.error('Unexpected HostSession.State string: ', stateString);
  56     return remoting.HostSession.State.UNKNOWN;
  57   }
  58   return remoting.HostSession.State[stateString];
  59 };
  60
  61 /**
  62  * Initiates a connection.
  63  * @param {remoting.It2MeHostFacade} hostFacade It2Me host facade to use.
  64  * @param {string} email The user's email address.
  65  * @param {string} accessToken A valid OAuth2 access token.
  66  * @param {function(remoting.HostSession.State):void} onStateChanged
  67  *     Callback for notifications of changes to the host plugin's state.
  68  * @param {function(boolean):void} onNatTraversalPolicyChanged Callback
  69  *     for notification of changes to the NAT traversal policy.
  70  * @param {function(string):void} logDebugInfo Callback allowing the plugin
  71  *     to log messages to the debug log.
  72  * @param {function():void} onError Callback to invoke in case of an error.
  73  */
  74 remoting.HostSession.prototype.connect =
  75     function(hostFacade, email, accessToken, onStateChanged,
  76              onNatTraversalPolicyChanged, logDebugInfo, onError) {
  77   /** @private */
  78   this.hostFacade_ = hostFacade;
  79
  80   this.hostFacade_.connect(
  81       email, 'oauth2:' + accessToken,
  82       onStateChanged, onNatTraversalPolicyChanged, logDebugInfo,
  83       remoting.settings.XMPP_SERVER_FOR_IT2ME_HOST,
  84       remoting.settings.XMPP_SERVER_USE_TLS,
  85       remoting.settings.DIRECTORY_BOT_JID,
  86       onError);
  87 };
  88
  89 /**
  90  * Get the access code generated by the it2me host. Valid only after the
  91  * host state is RECEIVED_ACCESS_CODE.
  92  * @return {string} The access code.
  93  */
  94 remoting.HostSession.prototype.getAccessCode = function() {
  95   return this.hostFacade_.getAccessCode();
  96 };
  97
  98 /**
  99  * Get the lifetime for the access code. Valid only after the host state is
 100  * RECEIVED_ACCESS_CODE.
 101  * @return {number} The access code lifetime, in seconds.
 102  */
 103 remoting.HostSession.prototype.getAccessCodeLifetime = function() {
 104   return this.hostFacade_.getAccessCodeLifetime();
 105 };
 106
 107 /**
 108  * Get the email address of the connected client. Valid only after the plugin
 109  * state is CONNECTED.
 110  * @return {string} The client's email address.
 111  */
 112 remoting.HostSession.prototype.getClient = function() {
 113   return this.hostFacade_.getClient();
 114 };
 115
 116 /**
 117  * Disconnect the it2me session.
 118  * @return {void} Nothing.
 119  */
 120 remoting.HostSession.prototype.disconnect = function() {
 121   this.hostFacade_.disconnect();
 122 };