summaryrefslogtreecommitdiffstats
path: root/install/ui/src/freeipa/_base/Singleton_registry.js
blob: 18b0c420a702ed16abeece3e1fb7f5d48894ec1e (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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*  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) {

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

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

        /**
         * Builder used for building new instances. Builder has to have a
         * Constructor registry set.
         * @property {_base.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 {string|Object} type Type's name. Or the the object itself.
         * @return {Object|null}
         */
        get: function(type) {

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

            var obj = this._map[type];

            if (!obj) {
                if (!this.builder) return null;
                try {
                    obj = this._map[type] = this.builder.build(type);
                } catch (e) {
                    if (e.code === 'no-ctor-fac') obj = null;
                    else {
                        window.console.error('Error while building: ' + type);
                        throw e;
                    }
                }
            }

            return obj;
        },

        /**
         * Set object of given type - overwrites existing
         *
         * @param {string} type
         * @param {Mixed} 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 {string|Object} type type or construction spec
         * @param {Function} func ctor or factory function
         * @param {Object} [default_spec] default spec object for given type
         *
         * @return {Object}
         */
        register: function(type, func, default_spec) {
            this._check_builder();
            this.builder.registry.register(type, func, default_spec);
        },

        /**
         * Makes a copy of construct specification of original type. Extends
         * it with values in supplied construct specification.
         *
         * @param {string} org_type Original type
         * @param {string} new_type New type
         * @param {Object} construct_spec Construction specification
         */
        copy: function(org_type, new_type, construct_spec) {
            this._check_builder();
            this.builder.registry.copy(org_type, new_type, construct_spec);
        },

        /**
         * Create new construction specification based on an existing one and
         * a specification object. Save it as a new type.
         * @param  {string|Function} type New type or a callback to get
         *                                the type: `callback(spec)`
         * @param  {Object} spec Construction specification
         */
        register_from_spec: function(type, spec) {
            this._check_builder();
            var cs = this.builder.merge_spec(spec, true);
            if (typeof type === 'function') {
                cs.type = type(cs.spec);
            } else {
                cs.type = type;
            }
            this.builder.registry.register(cs);
        },

        _check_builder: function() {
            if (!lang.exists('builder.registry', this)) {
                throw {
                    error: 'Object Initialized Exception: builder not initalized',
                    context: this
                };
            }
        },

        constructor: function(spec) {

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

    return Singleton_registry;
});