Fixed bug in discovering JVM loaded case classes during code generation
[controller.git] / opendaylight / md-sal / sal-binding-broker / src / main / java / org / opendaylight / controller / sal / binding / codegen / RuntimeCodeGenerator.java
1 /*
2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.sal.binding.codegen;
9
10 import org.opendaylight.controller.sal.binding.spi.NotificationInvokerFactory;
11 import org.opendaylight.controller.sal.binding.spi.RpcRouter;
12 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
13 import org.opendaylight.yangtools.yang.binding.RpcService;
14 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext;
15
16 public interface RuntimeCodeGenerator {
17
18     /**
19      * Returns an instance of provided RpcService type which delegates all calls
20      * to the delegate.
21      * 
22      * <p>
23      * Returned instance:
24      * <ul>
25      * <li>implements provided subclass of RpcService type and
26      * {@link DelegateProxy} interface.
27      * <li>
28      * <p>
29      * delegates all invocations of methods, which are defined in RpcService
30      * subtype to delegate which is defined by
31      * {@link DelegateProxy#setDelegate(Object)}.
32      * <p>
33      * If delegate is not defined (<code>getDelegate() == null</code>)
34      * implementation throws {@link IllegalStateException}
35      * <li>{@link DelegateProxy#getDelegate()} - returns the delegate to which
36      * all calls are delegated.
37      * <li>{@link DelegateProxy#setDelegate(Object)} - sets the delegate for
38      * particular instance
39      * 
40      * </ul>
41      * 
42      * @param serviceType
43      *            - Subclass of RpcService for which direct proxy is to be
44      *            generated.
45      * @return Instance of RpcService of provided serviceType which implements
46      *         and {@link DelegateProxy}
47      * @throws IllegalArgumentException
48      * 
49      */
50     <T extends RpcService> T getDirectProxyFor(Class<T> serviceType) throws IllegalArgumentException;
51
52     /**
53      * Returns an instance of provided RpcService type which routes all calls to
54      * other instances selected on particular input field.
55      * 
56      * <p>
57      * Returned instance:
58      * <ul>
59      * <li>Implements:
60      * <ul>
61      * <li>{@link DelegateProxy}
62      * <li>{@link RpcRouter}
63      * </ul>
64      * <li>
65      * routes all invocations of methods, which are defined in RpcService
66      * subtype based on method arguments and routing information defined in the
67      * RpcRoutingTables for this instance
68      * {@link RpcRouter#getRoutingTable(Class)}.
69      * <ul>
70      * <li>
71      * Implementation uses
72      * {@link RpcRouter#getService(Class, InstanceIdentifier)} method to
73      * retrieve particular instance to which call will be routed.
74      * <li>
75      * Instance of {@link InstanceIdentifier} is determined by first argument of
76      * method and is retrieved via method which is annotated with
77      * {@link RoutingContext}. Class representing Routing Context Identifier is
78      * retrieved by {@link RoutingContext}.
79      * <li>If first argument is not defined / {@link RoutingContext} annotation
80      * is not present on any field invocation will be delegated to default
81      * service {@link RpcRouter#getDefaultService()}.
82      * </ul>
83      * 
84      * @param serviceType
85      *            - Subclass of RpcService for which Router is to be generated.
86      * @return Instance of RpcService of provided serviceType which implements
87      *         also {@link RpcRouter}<T> and {@link DelegateProxy}
88      */
89     <T extends RpcService> RpcRouter<T> getRouterFor(Class<T> serviceType,String name) throws IllegalArgumentException;
90
91     NotificationInvokerFactory getInvokerFactory();
92 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.