001//
002// NAME
003//    Notifier.java
004//
005// COPYRIGHT
006//    Copyright 2007-2014 Cloud Software Group, Inc. ALL RIGHTS RESERVED.
007//    Cloud Software Group, Inc. Confidential Information
008//
009// HISTORY
010//    $Revision: 1.1.2.84 $ $Date: 2014/02/06 20:35:16 $
011//
012// WARNINGS
013//    THIS FILE IS GENERATED, DO NOT EDIT
014//
015
016package com.kabira.platform.switchconfig;
017
018import java.util.*;
019import com.kabira.platform.annotation.*;
020
021
022/**
023<p>
024       Configuration data notifier
025<p>
026       Used to register interest in being notified of
027                changes in version state.
028
029@deprecated        Notifier has been replaced by ConfigurationListener.
030
031*/
032
033@Deprecated
034@Managed
035public class Notifier
036{
037        private static final String _RuntimeType = "switchconfig::Notifier";
038
039/**
040Create a new Notifier
041
042*/
043        public Notifier()
044        {
045                super();
046        }
047
048
049        /**
050        <p>
051       Specified version being loaded
052@param version                Version being loaded
053@param configList        additional configuration objects
054                to be added to version.
055
056<p>
057       Called after a new configuration version is
058                loaded.  The load operation may return a list
059                of configuration objects to be added to the
060                version.
061
062
063        */
064
065        public native void load(
066                        final com.kabira.platform.switchconfig.Version version,
067                        com.kabira.platform.OutParameter<com.kabira.platform.switchconfig.Config[]> configList) throws com.kabira.platform.switchconfig.OperationFailed;
068
069
070        /**
071        <p>
072       Specified version being loaded
073@param version                Version being loaded
074@param configList        additional configuration objects
075                to be added to version.
076
077<p>
078       Called after a new configuration version is
079                loaded.  The load operation may return a list
080                of configuration objects to be added to the
081                version.
082
083
084        */
085
086        private native void load_super(
087                        final com.kabira.platform.switchconfig.Version version,
088                        com.kabira.platform.OutParameter<com.kabira.platform.switchconfig.Config[]> configList) throws com.kabira.platform.switchconfig.OperationFailed;
089
090
091        /**
092        <p>
093       Specified version being made active
094@param version                Version made active
095<p>
096       Called when a new configuration version is
097                made active and there was no previous
098                active version of configuration data.
099
100
101        */
102
103        public native void active(
104                        final com.kabira.platform.switchconfig.Version version);
105
106
107        /**
108        <p>
109       Specified version being made active
110@param version                Version made active
111<p>
112       Called when a new configuration version is
113                made active and there was no previous
114                active version of configuration data.
115
116
117        */
118
119        private native void active_super(
120                        final com.kabira.platform.switchconfig.Version version);
121
122
123        /**
124        <p>
125       Specified version being made inactive
126@param version                Version being made inactive
127<p>
128       Called when a configuration version is
129                deactivated without activating a new version.
130                The version specified in the operation
131                parameter is already inactive when this
132                operation is called.
133
134
135        */
136
137        public native void inactive(
138                        final com.kabira.platform.switchconfig.Version version);
139
140
141        /**
142        <p>
143       Specified version being made inactive
144@param version                Version being made inactive
145<p>
146       Called when a configuration version is
147                deactivated without activating a new version.
148                The version specified in the operation
149                parameter is already inactive when this
150                operation is called.
151
152
153        */
154
155        private native void inactive_super(
156                        final com.kabira.platform.switchconfig.Version version);
157
158
159        /**
160        <p>
161       Replace an active version with another version
162@param deactivating        Version being made inactive
163@param activating        Version being made active
164<p>
165       Called when there is an active configuration
166                version being replaced with a new version.
167                The versions change state before the notifier 
168                operation is called so the activating version 
169                is the active version.
170
171
172        */
173
174        public native void replace(
175                        final com.kabira.platform.switchconfig.Version deactivating,
176                        final com.kabira.platform.switchconfig.Version activating);
177
178
179        /**
180        <p>
181       Replace an active version with another version
182@param deactivating        Version being made inactive
183@param activating        Version being made active
184<p>
185       Called when there is an active configuration
186                version being replaced with a new version.
187                The versions change state before the notifier 
188                operation is called so the activating version 
189                is the active version.
190
191
192        */
193
194        private native void replace_super(
195                        final com.kabira.platform.switchconfig.Version deactivating,
196                        final com.kabira.platform.switchconfig.Version activating);
197
198
199        /**
200        <p>
201       Specified version is being removed
202@param version                Version being removed
203<p>
204       Called when a configuration version is
205                being removed.  This operation is called
206                after all of the registered auditRemove()
207                 operations have been called but before
208                the version is removed.
209
210
211        */
212
213        public native void remove(
214                        final com.kabira.platform.switchconfig.Version version);
215
216
217        /**
218        <p>
219       Specified version is being removed
220@param version                Version being removed
221<p>
222       Called when a configuration version is
223                being removed.  This operation is called
224                after all of the registered auditRemove()
225                 operations have been called but before
226                the version is removed.
227
228
229        */
230
231        private native void remove_super(
232                        final com.kabira.platform.switchconfig.Version version);
233
234
235        /**
236        <p>
237       Audit a configuration being loaded
238@param version                Version to audit
239@param configToRemove        Configuration objects to remove
240<p>
241       Called during the configuration load operation
242                to audit the configuration version just loaded. 
243                This operation will be called after the entire 
244                version has been loaded.  This means that
245                all load notifiers will be called before any
246                of the auditLoad notifiers are called.
247<p>
248                The auditLoad operation decides whether to 
249                accept the configuration version without 
250                modification, remove a subset of the 
251                configuration objects from the version, 
252                or reject the configuration version.
253<p>
254                To accept the configuration version without
255                modification return normally from the 
256                auditLoad operation.  Do not place any objects
257                into the configToRemove output parameter.
258<p>
259                To remove objects from the configuration 
260                version place the objects in the configToRemove
261                output parameter and then return normally.
262<p>
263                To reject the configuration version raise an
264                OperationFailed exception with the reason
265                field set to the reason the audit failed.
266                This will cause the load operation to fail.
267                All configuration objects loaded into shared
268                memory during the load operation will be 
269                removed.
270
271
272        */
273
274        public native void auditLoad(
275                        final com.kabira.platform.switchconfig.Version version,
276                        com.kabira.platform.OutParameter<com.kabira.platform.switchconfig.Config[]> configToRemove) throws com.kabira.platform.switchconfig.OperationFailed;
277
278
279        /**
280        <p>
281       Audit a configuration being loaded
282@param version                Version to audit
283@param configToRemove        Configuration objects to remove
284<p>
285       Called during the configuration load operation
286                to audit the configuration version just loaded. 
287                This operation will be called after the entire 
288                version has been loaded.  This means that
289                all load notifiers will be called before any
290                of the auditLoad notifiers are called.
291<p>
292                The auditLoad operation decides whether to 
293                accept the configuration version without 
294                modification, remove a subset of the 
295                configuration objects from the version, 
296                or reject the configuration version.
297<p>
298                To accept the configuration version without
299                modification return normally from the 
300                auditLoad operation.  Do not place any objects
301                into the configToRemove output parameter.
302<p>
303                To remove objects from the configuration 
304                version place the objects in the configToRemove
305                output parameter and then return normally.
306<p>
307                To reject the configuration version raise an
308                OperationFailed exception with the reason
309                field set to the reason the audit failed.
310                This will cause the load operation to fail.
311                All configuration objects loaded into shared
312                memory during the load operation will be 
313                removed.
314
315
316        */
317
318        private native void auditLoad_super(
319                        final com.kabira.platform.switchconfig.Version version,
320                        com.kabira.platform.OutParameter<com.kabira.platform.switchconfig.Config[]> configToRemove) throws com.kabira.platform.switchconfig.OperationFailed;
321
322
323        /**
324        <p>
325       Audit activating a configuration version
326@param version                Version to audit
327<p>
328       Called to audit a configuration version
329                that is transitioning from inactive to active.
330<p>
331                OperationFailed is raised if the audit fails.
332                Reason contains the reason the audit failed.
333
334
335        */
336
337        public native void audit(
338                        final com.kabira.platform.switchconfig.Version version) throws com.kabira.platform.switchconfig.OperationFailed;
339
340
341        /**
342        <p>
343       Audit activating a configuration version
344@param version                Version to audit
345<p>
346       Called to audit a configuration version
347                that is transitioning from inactive to active.
348<p>
349                OperationFailed is raised if the audit fails.
350                Reason contains the reason the audit failed.
351
352
353        */
354
355        private native void audit_super(
356                        final com.kabira.platform.switchconfig.Version version) throws com.kabira.platform.switchconfig.OperationFailed;
357
358
359        /**
360        <p>
361       Audit replacing an active version
362@param deactivating        Version being made inactive
363@param activating        Version being made active
364<p>
365       Called to audit replacement of an active
366                version with another version.  In the
367                case of replacing an active version with
368                another version, the auditReplace notifier
369                is called, if it has been implemented.  If
370                not, the audit notifier operation is called
371                with the activating version as the version
372                parameter.
373<p>
374                OperationFailed is raised if the audit fails.
375                Reason contains the reason the audit failed.
376
377
378        */
379
380        public native void auditReplace(
381                        final com.kabira.platform.switchconfig.Version deactivating,
382                        final com.kabira.platform.switchconfig.Version activating) throws com.kabira.platform.switchconfig.OperationFailed;
383
384
385        /**
386        <p>
387       Audit replacing an active version
388@param deactivating        Version being made inactive
389@param activating        Version being made active
390<p>
391       Called to audit replacement of an active
392                version with another version.  In the
393                case of replacing an active version with
394                another version, the auditReplace notifier
395                is called, if it has been implemented.  If
396                not, the audit notifier operation is called
397                with the activating version as the version
398                parameter.
399<p>
400                OperationFailed is raised if the audit fails.
401                Reason contains the reason the audit failed.
402
403
404        */
405
406        private native void auditReplace_super(
407                        final com.kabira.platform.switchconfig.Version deactivating,
408                        final com.kabira.platform.switchconfig.Version activating) throws com.kabira.platform.switchconfig.OperationFailed;
409
410
411        /**
412        <p>
413       Audit a configuration version that is being
414                deactivated
415
416@param version                Version to audit
417<p>
418       Called to audit a configuration version
419                that is transitioning from active to inactive.
420<p>
421                OperationFailed is raised if the audit fails.
422                Reason contains the reason the audit failed.
423
424
425        */
426
427        public native void auditInactive(
428                        final com.kabira.platform.switchconfig.Version version) throws com.kabira.platform.switchconfig.OperationFailed;
429
430
431        /**
432        <p>
433       Audit a configuration version that is being
434                deactivated
435
436@param version                Version to audit
437<p>
438       Called to audit a configuration version
439                that is transitioning from active to inactive.
440<p>
441                OperationFailed is raised if the audit fails.
442                Reason contains the reason the audit failed.
443
444
445        */
446
447        private native void auditInactive_super(
448                        final com.kabira.platform.switchconfig.Version version) throws com.kabira.platform.switchconfig.OperationFailed;
449
450
451        /**
452        <p>
453       Audit a configuration version that is being
454                removed
455
456@param version                Version to audit
457<p>
458       Called to audit a configuration version
459                that is being removed
460<p>
461                OperationFailed is raised if the audit fails.
462                Reason contains the reason the audit failed.
463
464
465        */
466
467        public native void auditRemove(
468                        final com.kabira.platform.switchconfig.Version version) throws com.kabira.platform.switchconfig.OperationFailed;
469
470
471        /**
472        <p>
473       Audit a configuration version that is being
474                removed
475
476@param version                Version to audit
477<p>
478       Called to audit a configuration version
479                that is being removed
480<p>
481                OperationFailed is raised if the audit fails.
482                Reason contains the reason the audit failed.
483
484
485        */
486
487        private native void auditRemove_super(
488                        final com.kabira.platform.switchconfig.Version version) throws com.kabira.platform.switchconfig.OperationFailed;
489
490}