src/third_party/closure_library/closure/goog/messaging/loggerserver.js

// Copyright 2010 The Closure Library Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @fileoverview This class listens on a message channel for logger commands and
 * logs them on the local page. This is useful when dealing with message
 * channels to contexts that don't have access to their own logging facilities.
 *
 */

goog.provide('goog.messaging.LoggerServer');

goog.require('goog.Disposable');
goog.require('goog.log');
goog.require('goog.log.Level');



/**
 * Creates a logger server that logs messages on behalf of the remote end of a
 * message channel. The remote end of the channel should use a
 * {goog.messaging.LoggerClient} with the same service name.
 *
 * @param {!goog.messaging.MessageChannel} channel The channel that is sending
 *     the log messages.
 * @param {string} serviceName The name of the logging service to listen for.
 * @param {string=} opt_channelName The name of this channel. Used to help
 *     distinguish this client's messages.
 * @constructor
 * @extends {goog.Disposable}
 * @final
 */
goog.messaging.LoggerServer = function(channel, serviceName, opt_channelName) {
  goog.messaging.LoggerServer.base(this, 'constructor');

  /**
   * The channel that is sending the log messages.
   * @type {!goog.messaging.MessageChannel}
   * @private
   */
  this.channel_ = channel;

  /**
   * The name of the logging service to listen for.
   * @type {string}
   * @private
   */
  this.serviceName_ = serviceName;

  /**
   * The name of the channel.
   * @type {string}
   * @private
   */
  this.channelName_ = opt_channelName || 'remote logger';

  this.channel_.registerService(
      this.serviceName_, goog.bind(this.log_, this), true /* opt_json */);
};
goog.inherits(goog.messaging.LoggerServer, goog.Disposable);


/**
 * Handles logging messages from the client.
 * @param {!Object|string} message
 *     The logging information from the client.
 * @private
 */
goog.messaging.LoggerServer.prototype.log_ = function(message) {
  var args =
      /**
       * @type {{level: number, message: string,
       *           name: string, exception: Object}}
       */ (message);
  var level = goog.log.Level.getPredefinedLevelByValue(args['level']);
  if (level) {
    var msg = '[' + this.channelName_ + '] ' + args['message'];
    goog.log.getLogger(args['name'])
        .log(level, msg, args['exception']);
  }
};


/** @override */
goog.messaging.LoggerServer.prototype.disposeInternal = function() {
  goog.messaging.LoggerServer.base(this, 'disposeInternal');
  this.channel_.registerService(this.serviceName_, goog.nullFunction, true);
  delete this.channel_;
};