-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.controller.sal.core.api;\r
-\r
-import java.util.Set;\r
-\r
-import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;\r
-import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;\r
-import org.opendaylight.controller.yang.common.QName;\r
-import org.opendaylight.controller.yang.common.RpcResult;\r
-import org.opendaylight.controller.yang.data.api.CompositeNode;\r
-\r
-/**\r
- * {@link Provider}'s implementation of rpc.\r
- * \r
- * In order to expose the rpc to other components, the provider MUST register\r
- * concrete implementation of this interface\r
- * \r
- * The registration could be done by :\r
- * <ul>\r
- * <li>returning an instance of implementation in the return value of\r
- * {@link Provider#getProviderFunctionality()}\r
- * <li>passing an instance of implementation and {@link QName} of rpc as\r
- * arguments to the\r
- * {@link ProviderSession#addRpcImplementation(QName, RpcImplementation)}\r
- * </ul>\r
- * \r
- * The simplified process of the invocation of rpc is following:\r
- * \r
- * <ol>\r
- * <li> {@link Consumer} invokes\r
- * {@link ConsumerSession#rpc(QName, CompositeNode)}\r
- * <li> {@link Broker} finds registered {@link RpcImplementation}s\r
- * <li> {@link Broker} invokes\r
- * {@link RpcImplementation#invokeRpc(QName, CompositeNode)}\r
- * <li> {@link RpcImplementation} processes the data and returns a\r
- * {@link RpcResult}\r
- * <li> {@link Broker} returns the {@link RpcResult} to {@link Consumer}\r
- * </ol>\r
- * \r
- * \r
- */\r
-public interface RpcImplementation extends Provider.ProviderFunctionality {\r
-\r
- /**\r
- * A set of rpc types supported by implementation.\r
- * \r
- * The set of rpc {@link QName}s which are supported by this implementation.\r
- * This set is used, when {@link Provider} is registered to the SAL, to\r
- * register and expose the implementation of the returned rpcs.\r
- * \r
- * @return Set of QNames identifying supported RPCs\r
- */\r
- Set<QName> getSupportedRpcs();\r
-\r
- /**\r
- * Invokes a implementation of specified rpc.\r
- * \r
- * \r
- * @param rpc\r
- * Rpc to be invoked\r
- * @param input\r
- * Input data for rpc.\r
- * \r
- * @throws IllegalArgumentException\r
- * <ul>\r
- * <li>If rpc is null.\r
- * <li>If input is not <code>null</code> and\r
- * <code>false == rpc.equals(input.getNodeType)</code>\r
- * </ul>\r
- * @return RpcResult containing the output of rpc if was executed\r
- * successfully, the list of errors otherwise.\r
- */\r
- RpcResult<CompositeNode> invokeRpc(QName rpc, CompositeNode input);\r
-\r
-}\r
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.sal.core.api;
+
+import java.util.Set;
+
+import org.opendaylight.controller.sal.core.api.Broker.ConsumerSession;
+import org.opendaylight.controller.sal.core.api.Broker.ProviderSession;
+import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.opendaylight.yangtools.yang.data.api.CompositeNode;
+
+/**
+ * {@link Provider}'s implementation of rpc.
+ *
+ * In order to expose the rpc to other components, the provider MUST register
+ * concrete implementation of this interface
+ *
+ * The registration could be done by :
+ * <ul>
+ * <li>returning an instance of implementation in the return value of
+ * {@link Provider#getProviderFunctionality()}
+ * <li>passing an instance of implementation and {@link QName} of rpc as
+ * arguments to the
+ * {@link ProviderSession#addRpcImplementation(QName, RpcImplementation)}
+ * </ul>
+ *
+ * The simplified process of the invocation of rpc is following:
+ *
+ * <ol>
+ * <li> {@link Consumer} invokes
+ * {@link ConsumerSession#rpc(QName, CompositeNode)}
+ * <li> {@link Broker} finds registered {@link RpcImplementation}s
+ * <li> {@link Broker} invokes
+ * {@link RpcImplementation#invokeRpc(QName, CompositeNode)}
+ * <li> {@link RpcImplementation} processes the data and returns a
+ * {@link RpcResult}
+ * <li> {@link Broker} returns the {@link RpcResult} to {@link Consumer}
+ * </ol>
+ *
+ *
+ */
+public interface RpcImplementation extends Provider.ProviderFunctionality {
+
+ /**
+ * A set of rpc types supported by implementation.
+ *
+ * The set of rpc {@link QName}s which are supported by this implementation.
+ * This set is used, when {@link Provider} is registered to the SAL, to
+ * register and expose the implementation of the returned rpcs.
+ *
+ * @return Set of QNames identifying supported RPCs
+ */
+ Set<QName> getSupportedRpcs();
+
+ /**
+ * Invokes a implementation of specified rpc.
+ *
+ *
+ * @param rpc
+ * Rpc to be invoked
+ * @param input
+ * Input data for rpc.
+ *
+ * @throws IllegalArgumentException
+ * <ul>
+ * <li>If rpc is null.
+ * <li>If input is not <code>null</code> and
+ * <code>false == rpc.equals(input.getNodeType)</code>
+ * </ul>
+ * @return RpcResult containing the output of rpc if was executed
+ * successfully, the list of errors otherwise.
+ */
+ RpcResult<CompositeNode> invokeRpc(QName rpc, CompositeNode input);
+
+}
Code Review / controller.git / blobdiff