summaryrefslogtreecommitdiffstats
path: root/install/ui/src/freeipa/_base/Singleton_registry.js
blob: fe806546863ba92ce67ed294724082abe23782ca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/*  Authors:
 *    Petr Vobornik <pvoborni@redhat.com>
 *
 * Copyright (C) 2012 Red Hat
 * see file 'COPYING' for use and warranty information
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

define(['dojo/_base/declare',
        'dojo/_base/array',
        'dojo/_base/lang',
        './construct',
        './Builder',
        './Construct_registry'
        ], function(declare, array, lang, construct, Builder, Construct_registry) {

    var Singleton_registry = declare(null, {
        /**
         * Registry for storing singleton instances of various items based
         * on their type.
         *
         * @class
         * @name Singleton_registry
         */

        /**
         * Internal map for instances
         * @protected
         * @type Object
         */
        _map: {},

        /**
         * Builder used for building new instances. Builder has to have a
         * Constructor registry set.
         * @type Builder
         */
        builder: null,

        /**
         * Gets an instance of given type. Creates a new one if it doesn't
         * exist.
         *
         * When an object is passed in, the function returns it.
         *
         * @param type {String|Object} Type's name. Or the the object itself.
         * @returns Object|null
         */
        get: function(type) {

            if (typeof type === 'object') return type;

            var obj = this._map[type];

            if (!obj) {
                if (!this.builder) {
                    throw {
                        error: 'Object not initialized: missing builder',
                        ref: this
                    };
                }
                obj = this._map[type] = this.builder.build(type);
            }

            return obj;
        },

        /**
         * Set object of given type - overwrites existing
         *
         * @param {String} type
         * @param {anything} object
         */
        set: function (type, obj) {
            this._map[type] = obj;
        },

        /**
         * Removes object of given type from registry
         *
         * @param {String} type
         */
        remove: function(type) {

            var undefined;
            this._map[type] = undefined;
        },

        /**
         * Registers construction specification
         *
         * @param type {String|Object} type or construction spec
         * @param func {Function} ctor or factory function
         * @param [default_spec] {Object} default spec object for given type
         *
         * @returns Object
         */
        register: function(type, func, default_spec) {
            if (!lang.exists('builder.registry', this)) {
                throw {
                    error: 'Object Initialized Exception: builder not initalized',
                    context: this
                };
            }

            this.builder.registry.register(type, func, default_spec);
        },


        constructor: function(spec) {

            spec = spec || {};
            this._map = {};
            this.builder = spec.builder || new Builder({
                registry: new Construct_registry()
            });
        }
    });

    return Singleton_registry;
});