joynr.infrastructure.ChannelUrlDirectoryProvider.js Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of libjoynr-js Show documentation
JOYnr JavaScript libjoynr-js
There is a newer version: 1.4.0
/*
 * PLEASE NOTE. THIS IS A GENERATED FILE!
 * Generation date: Wed Jan 27 16:29:10 CET 2016
 */
(function(undefined){

	var checkImpl = function() {
		var missingInImplementation = [];
		if (! this.unregisterChannelUrls.checkOperation())  missingInImplementation.push("Operation:unregisterChannelUrls");
		if (! this.getUrlsForChannel.checkOperation())  missingInImplementation.push("Operation:getUrlsForChannel");
		if (! this.registerChannelUrls.checkOperation())  missingInImplementation.push("Operation:registerChannelUrls");

		return missingInImplementation;
	};

	/**
	 * @name ChannelUrlDirectoryProvider
	 * @constructor
	 *
	 * @classdesc
	 * PLEASE NOTE. THIS IS A GENERATED FILE!
	 * 
Generation date: Wed Jan 27 16:29:10 CET 2016
	 * 

The ChannelUrlDirectory interface defines the
	 * interface of the joynr internal channel URL directory. The channel URL
	 * directory is a joynr infrastructure backend component that resolves
	 * channel IDs to channel URLs. A joynr Cluster Controller is addressed
	 * using a unique channel ID. However, the channel ID can be mapped on
	 * multiple channel URLs depending on network topology and reachability.
	 *
	 * @summary Constructor of ChannelUrlDirectoryProvider object
	 *
	 * @param {Object} [implementation] the implementation of the provider
	 * @param {Object} [implementation.ATTRIBUTENAME] the definition of attribute implementation
	 * @param {Function} [implementation.ATTRIBUTENAME.set] the getter function with the
	 *     signature "function(value){}" that stores the given attribute value
	 * @param {Function} [implementation.ATTRIBUTENAME.get] the getter function with the
	 *     signature "function(){}" that returns the current attribute value
	 * @param {Function} [implementation.OPERATIONNAME] the operation function
	 * @param {Object} [implementation.EVENTNAME] the definition of the event implementation
	 *
	 * @returns {ChannelUrlDirectoryProvider} a ChannelUrlDirectoryProvider object to communicate with the joynr infrastructure
	 */
	var ChannelUrlDirectoryProvider = null;
	ChannelUrlDirectoryProvider = function ChannelUrlDirectoryProvider(
		passedImplementation,
		dependencies
	) {
		if (!(this instanceof ChannelUrlDirectoryProvider)) {
			// in case someone calls constructor without new keyword (e.g. var c = Constructor({..}))
			return new ChannelUrlDirectoryProvider(
				passedImplementation,
				dependencies);
		}

		var implementation = passedImplementation || {};

		// defining provider members
		/**
		 * @function ChannelUrlDirectoryProvider#unregisterChannelUrls
		 * @summary The unregisterChannelUrls operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 

Deletes all ChannelUrlInformation that
		 * is registered with the channel URL directory for the given channel ID.
		 * @see ChannelUrlInformation
		 *
		 * @param {String} channelId -
		 * the channel ID to remove from the directory
		 */
		this.unregisterChannelUrls = new dependencies.ProviderOperation(this, implementation.unregisterChannelUrls, "unregisterChannelUrls", [
			{
				inputParameter: [
					{
						name : "channelId",
						type : "String"
					}
				],
				error: {
					type: "no error enumeration given"
				},
				outputParameter: [
				]
			}
		]);
		/**
		 * @function ChannelUrlDirectoryProvider#getUrlsForChannel
		 * @summary The getUrlsForChannel operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 

Gets ChannelUrlInformation from the
		 * channel URL directory for a given channel ID.
		 * @see ChannelUrlInformation
		 *
		 * @param {String} channelId -
		 * the channel ID to lookup
		 * @returns {ChannelUrlInformation} result -
		 * channel URL information to reach the given
		 * channel ID
		 */
		this.getUrlsForChannel = new dependencies.ProviderOperation(this, implementation.getUrlsForChannel, "getUrlsForChannel", [
			{
				inputParameter: [
					{
						name : "channelId",
						type : "String"
					}
				],
				error: {
					type: "no error enumeration given"
				},
				outputParameter: [
					{
						name : "result",
						type : "joynr.types.ChannelUrlInformation"
					}
				]
			}
		]);
		/**
		 * @function ChannelUrlDirectoryProvider#registerChannelUrls
		 * @summary The registerChannelUrls operation is GENERATED FROM THE INTERFACE DESCRIPTION
		 * 

Registers ChannelUrlInformation for
		 * a channel ID. The channel URL information is used to send messages
		 * to a Cluster Controller identified by the unique channel ID.
		 * @see ChannelUrlInformation
		 *
		 * @param {String} channelId -
		 * the channel ID to register channel URL information
		 * with
		 * @param {ChannelUrlInformation} channelUrlInformation -
		 * the channel URL information used to send messages
		 * to a Cluster Controller
		 */
		this.registerChannelUrls = new dependencies.ProviderOperation(this, implementation.registerChannelUrls, "registerChannelUrls", [
			{
				inputParameter: [
					{
						name : "channelId",
						type : "String"
					},
					{
						name : "channelUrlInformation",
						type : "joynr.types.ChannelUrlInformation"
					}
				],
				error: {
					type: "no error enumeration given"
				},
				outputParameter: [
				]
			}
		]);

		Object.defineProperty(this, 'checkImplementation', {
			enumerable: false,
			configurable: false,
			writable: false,
			value: checkImpl
		});

		this.interfaceName = "infrastructure/ChannelUrlDirectory";

		this.id = dependencies.uuid();

		return Object.freeze(this);
	};

	// AMD support
	if (typeof define === 'function' && define.amd) {
		define("joynr/infrastructure/ChannelUrlDirectoryProvider", [
			"joynr/types/ChannelUrlInformation"
			], function () {
				return ChannelUrlDirectoryProvider;
			}
		);
	} else if (typeof exports !== 'undefined' ) {
		if ((module !== undefined) && module.exports) {
			require("../../joynr/types/ChannelUrlInformation");
			exports = module.exports = ChannelUrlDirectoryProvider;
		}
		else {
			// support CommonJS module 1.1.1 spec (`exports` cannot be a function)
			exports.ChannelUrlDirectoryProvider = ChannelUrlDirectoryProvider;
		}
	} else {
		window.ChannelUrlDirectoryProvider = ChannelUrlDirectoryProvider;
	}
})();