/common/common-lang/src/main/java/com/twelvemonkeys/util/service/RegisterableService.java

https://github.com/conceptboard/TwelveMonkeys · Java · 61 lines · 5 code · 3 blank · 53 comment · 0 complexity · ddb85681070619a20d267cbbdc080b6e MD5 · raw file 

    

  1. /*

    2. 

  2.  * Copyright (c) 2008, Harald Kuhr

    3. 

  3.  * All rights reserved.

    4. 

  4.  *

    5. 

  5.  * Redistribution and use in source and binary forms, with or without

    6. 

  6.  * modification, are permitted provided that the following conditions are met:

    7. 

  7.  *     * Redistributions of source code must retain the above copyright

    8. 

  8.  *       notice, this list of conditions and the following disclaimer.

    9. 

  9.  *     * Redistributions in binary form must reproduce the above copyright

    10. 

  10.  *       notice, this list of conditions and the following disclaimer in the

    11. 

  11.  *       documentation and/or other materials provided with the distribution.

    12. 

  12.  *     * Neither the name "TwelveMonkeys" nor the

    13. 

  13.  *       names of its contributors may be used to endorse or promote products

    14. 

  14.  *       derived from this software without specific prior written permission.

    15. 

  15.  *

    16. 

  16.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

    17. 

  17.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

    18. 

  18.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

    19. 

  19.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR

    20. 

  20.  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

    21. 

  21.  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

    22. 

  22.  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

    23. 

  23.  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

    24. 

  24.  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

    25. 

  25.  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

    26. 

  26.  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    27. 

  27.  */

    28. 

  28. 

    29. 

  29. package com.twelvemonkeys.util.service;

    30. 

  30. 

    31. 

  31. /**

    32. 

  32.  * An optional interface that may be implemented by service provider objects.

    33. 

  33.  * <p/>

    34. 

  34.  * If this interface is implemented, the service provider objects will receive

    35. 

  35.  * notification of registration and deregistration from the

    36. 

  36.  * {@code ServiceRegistry}.

    37. 

  37.  *

    38. 

  38.  * @see ServiceRegistry

    39. 

  39.  *

    40. 

  40.  * @author <a href="mailto:harald.kuhr@gmail.com">Harald Kuhr</a>

    41. 

  41.  * @version $Id: //depot/branches/personal/haraldk/twelvemonkeys/release-2/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/service/RegisterableService.java#1 $

    42. 

  42.  */

    43. 

  43. public interface RegisterableService {

    44. 

  44.     /**

    45. 

  45.      * Called right after this service provider object is added to

    46. 

  46.      * the given category of the given {@code ServiceRegistry}.

    47. 

  47.      *

    48. 

  48.      * @param pRegistry the {@code ServiceRegistry} {@code this} was added to

    49. 

  49.      * @param pCategory the category {@code this} was added to

    50. 

  50.      */

    51. 

  51.     void onRegistration(ServiceRegistry pRegistry, Class pCategory);

    52. 

  52. 

    53. 

  53.     /**

    54. 

  54.      * Called right after this service provider object is removed

    55. 

  55.      * from the given category of the given {@code ServiceRegistry}.

    56. 

  56.      *

    57. 

  57.      * @param pRegistry the {@code ServiceRegistry} {@code this} was added to

    58. 

  58.      * @param pCategory the category {@code this} was added to

    59. 

  59.      */

    60. 

  60.     void onDeregistration(ServiceRegistry pRegistry, Class pCategory);

    61. 

  61. }
    62.