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