joynr.capabilities.CapabilitiesRegistrar.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
Show all versions of libjoynr-js Show documentation
JOYnr JavaScript libjoynr-js
/*
* #%L
* %%
* Copyright (C) 2011 - 2017 BMW Car IT GmbH
* %%
* 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.
* #L%
*/
define("joynr/capabilities/CapabilitiesRegistrar", [
"global/Promise",
"joynr/util/UtilInternal",
"joynr/types/DiscoveryEntry",
"joynr/types/ProviderScope",
"joynr/capabilities/ParticipantIdStorage",
"joynr/types/Version"
], function(Promise, Util, DiscoveryEntry, ProviderScope, ParticipantIdStorage, Version) {
var ONE_DAY_MS = 24 * 60 * 60 * 1000;
/**
* The Capabilities Registrar
*
* @constructor
* @name CapabilitiesRegistrar
*
* @param {Object}
* dependencies
* @param {CapabilityDiscovery}
* dependencies.discoveryStub connects the inProcessStub to its skeleton
* @param {MessageRouter}
* dependencies.messageRouter used to register nextHop for registered provider
* @param {ParticipantIdStorage}
* dependencies.participantIdStorage connects the inProcessStub to its skeleton
* @param {Address}
* dependencies.libjoynrMessagingAddress address to be used by the cluster controller to send incoming requests to this
* libjoynr's providers
* @param {RequestReplyManager}
* dependencies.requestReplyManager passed on to providerAttribute, providerOperation and providerEvent
* @param {PublicationManager}
* dependencies.publicationManager passed on to providerAttribute
*
*/
function CapabilitiesRegistrar(dependencies) {
var discoveryStub = dependencies.discoveryStub;
var messageRouter = dependencies.messageRouter;
var participantIdStorage = dependencies.participantIdStorage;
var libjoynrMessagingAddress = dependencies.libjoynrMessagingAddress;
var requestReplyManager = dependencies.requestReplyManager;
var publicationManager = dependencies.publicationManager;
var loggingManager = dependencies.loggingManager;
var started = true;
/**
* @param provider
* to scan for a ProviderOperation
* @returns {Boolean} true if provider contains a ProviderOperation
*/
function hasOperation(provider) {
var property;
for (property in provider) {
if (provider.hasOwnProperty(property)) {
if (provider[property].constructor.name === "ProviderOperation") {
return true;
}
}
}
return false;
}
/*
* Internal function used to throw exception in case of CapabilitiesRegistrar
* is not used properly
*/
function checkIfReady() {
if (!started) {
throw new Error("CapabilitiesRegistrar is already shut down");
}
}
/**
* Registers a provider so that it is publicly available
*
* @function
* @name CapabilitiesRegistrar#registerProvider
*
* @param {Object} settings the arguments object for this function call
* @param {String}
* settings.domain
* @param {Object}
* settings.provider
* @param {String}
* settings.provider.interfaceName
* @param {ProviderQos}
* settings.providerQos the Quality of Service parameters for provider registration
* @param {Number}
* [settings.expiryDateMs] date in millis since epoch after which the discovery entry can be purged from all directories.
* Default value is one day.
* @param {Object}
* [settings.loggingContext] optional logging context will be appended to logging messages created in the name of this proxy
* @param {String}
* [settings.participantId] optional. If not set, a globally unique UUID participantId will be generated, and persisted to
* localStorage. If set, the participantId must be unique in the context of the provider's scope, as set in the ProviderQos;
* The application setting the participantId is responsible for guaranteeing uniqueness.
*
* @returns {Object} an A+ promise
*/
this.register =
function register(settings) {
return this.registerProvider(
settings.domain,
settings.provider,
settings.providerQos,
settings.expiryDateMs,
settings.loggingContext,
settings.participantId);
};
/**
* Registers a provider so that it is publicly available
*
* @deprecated Use register instead
* @function
* @name CapabilitiesRegistrar#registerProvider
*
* @param {String}
* domain
* @param {Object}
* provider
* @param {String}
* provider.interfaceName
* @param {ProviderQos}
* providerQos the Quality of Service parameters for provider registration
* @param {Number}
* [expiryDateMs] date in millis since epoch after which the discovery entry can be purged from all directories.
* Default value is one day.
* @param {Object}
* [loggingContext] optional logging context will be appended to logging messages created in the name of this proxy
* @param {String}
* [participantId] optional. If not set, a globally unique UUID participantId will be generated, and persisted to localStorage.
*
* @returns {Object} an A+ promise
*/
this.registerProvider =
function registerProvider(
domain,
provider,
providerQos,
expiryDateMs,
loggingContext,
participantId) {
checkIfReady();
var missingImplementations = provider.checkImplementation();
if (missingImplementations.length > 0) {
throw new Error("provider: "
+ domain
+ "/"
+ provider.interfaceName
+ " is missing: "
+ missingImplementations.toString());
}
// retrieve participantId if not passed in
if (participantId === undefined || participantId === null) {
participantId = participantIdStorage.getParticipantId(domain, provider);
}
if (loggingContext !== undefined) {
loggingManager.setLoggingContext(participantId, loggingContext);
}
// register provider at RequestReplyManager
requestReplyManager.addRequestCaller(participantId, provider);
// register routing address at routingTable
var isGloballyVisible = (providerQos.scope === ProviderScope.GLOBAL);
var messageRouterPromise =
messageRouter.addNextHop(
participantId,
libjoynrMessagingAddress,
isGloballyVisible);
// if provider has at least one attribute, add it as publication provider
publicationManager.addPublicationProvider(participantId, provider);
// TODO: Must be later provided by the user or retrieved from somewhere
var defaultPublicKeyId = "";
var discoveryStubPromise = discoveryStub.add(new DiscoveryEntry({
providerVersion : new Version({
majorVersion : provider.constructor.MAJOR_VERSION,
minorVersion : provider.constructor.MINOR_VERSION
}),
domain : domain,
interfaceName : provider.interfaceName,
participantId : participantId,
qos : providerQos,
publicKeyId : defaultPublicKeyId,
expiryDateMs : expiryDateMs || Date.now() + ONE_DAY_MS,
lastSeenDateMs : Date.now()
}));
return Promise.all([
messageRouterPromise,
discoveryStubPromise
]).then(function() {
return participantId;
});
};
/**
* Unregisters a provider so that it is not publicly available anymore
*
* @function
* @name CapabilitiesRegistrar#unregisterProvider
* @param {String}
* domain
* @param {Object}
* provider
* @param {String}
* provider.interfaceName
* @returns {Object} an A+ promise
*/
this.unregisterProvider = function unregisterProvider(domain, provider) {
checkIfReady();
// retrieve participantId
var participantId = participantIdStorage.getParticipantId(domain, provider);
var discoveryStubPromise = discoveryStub.remove(participantId);
// if provider has at least one attribute, remove it as publication
// provider
publicationManager.removePublicationProvider(participantId, provider);
// unregister routing address at routingTable
var messageRouterPromise = messageRouter.removeNextHop(participantId);
// unregister provider at RequestReplyManager
requestReplyManager.removeRequestCaller(participantId);
return Promise.all([
discoveryStubPromise,
messageRouterPromise
]);
};
/**
* Shutdown the capabilities registrar
*
* @function
* @name CapabilitiesRegistrar#shutdown
*/
this.shutdown = function shutdown() {
started = false;
};
}
return CapabilitiesRegistrar;
});
© 2015 - 2025 Weber Informatics LLC | Privacy Policy