* - the dataProvider
* @param rpcRegistry
* - the rpcRegistry
- * @param executor
- * - thread pool executor
* @param epRendererAugmentation
* - specific implementation RPC augmentation, if any. Otherwise
* NULL
*
* @param matcher
* the {@link RequirementMatcher} to apply
- * @param target
+ * @param relator
* the {@link ConsumerSelectionRelator} to match against
* @return <code>true</code> if the matcher matches the target
*/
*
* @param matcher
* the {@link RequirementMatcher} to apply
- * @param target
+ * @param relator
* the {@link ProviderSelectionRelator} to match against
* @return <code>true</code> if the matcher matches the target
*/
/**
* Indicates that the policy related to the set of endpoint groups
* has changed
- * @param updatedConsumers the set of endpoint groups involved
+ * @param updatedGroups the set of endpoint groups involved
* in a contract whose policy has changed
*/
public void policyUpdated(Set<EgKey> updatedGroups);
/**
* Find a clause with a specified name within a contract
- * @param tenant the {@link Contract} to search
- * @param contractId the {@link ClauseName} to search for
+ * @param contract the {@link Contract} to search
+ * @param clauseName the {@link ClauseName} to search for
* @return the {@link Clause} if it exists, null otherwise
*/
public static Clause findClause(Contract contract,
/**
* Find a subject with a specified name within a contract
- * @param tenant the {@link Contract} to search
+ * @param contract the {@link Contract} to search
* @param subjectName the {@link SubjectName} to search for
* @return the {@link Subject} if it exists, null otherwise
*/
/**
* Find a consumer named selector in an endpoint group
* @param eg the {@link EndpointGroup} to search
- * @param name the {@link NamedSelectorName} to search for
+ * @param name the {@link SelectorName} to search for
* @return the {@link ConsumerNamedSelector} if it exists, null otherwise
*/
public static ConsumerNamedSelector findCns(EndpointGroup eg,
/**
* Find a provider named selector in an endpoint group
* @param eg the {@link EndpointGroup} to search
- * @param name the {@link NamedSelectorName} to search for
+ * @param name the {@link SelectorName} to search for
* @return the {@link ProviderNamedSelector} if it exists, null otherwise
*/
public static ProviderNamedSelector findPns(EndpointGroup eg,
/**
* Find a provider target selector in an endpoint group
* @param eg the {@link EndpointGroup} to search
- * @param name the {@link TargetSelectorName} to search for
+ * @param name the {@link SelectorName} to search for
* @return the {@link ProviderNamedSelector} if it exists, null otherwise
*/
public static ProviderTargetSelector findPts(EndpointGroup eg,
* Construct a new SingletonTask for the given runnable. The context
* is used to manage the state of the task execution and can be shared
* by more than one instance of the runnable.
- * @param context
- * @param Task
+ * @param ses
+ * @param task
*/
public SingletonTask(ScheduledExecutorService ses,
Runnable task) {
ses.schedule(stw, delay, unit);
}
}
-}
\ No newline at end of file
+}
*
* @param input
* the input object
- * @param timestamp
- * the current timestamp
*/
protected EndpointBuilder buildEndpoint(RegisterEndpointInput input) {
return new EndpointBuilder(input);
*
* @param input
* the input object
- * @param timestamp
- * the current timestamp
*/
protected EndpointL3Builder buildEndpointL3(RegisterEndpointInput input) {
return new EndpointL3Builder(input);
/**
* Get a collection of endpoints in a particular endpoint group
*
- * @param nodeId
- * the nodeId of the switch to get endpoints for
+ * @param eg
+ * endpoint group ID
* @return a collection of {@link Endpoint} objects.
*/
public synchronized Collection<Endpoint> getEndpointsForGroup(EgKey eg) {
*
* @param nodeId the ID of the node
* @param tableId the ID of the table
- * @return the {@link InstanceIdentifier<Table>}
+ * @return the {@link InstanceIdentifier}
*/
public static final InstanceIdentifier<Table> createTablePath(final NodeId nodeId, final short tableId) {
return createNodePath(nodeId).builder()
*
* @param nodeId the Id of the node
* @param groupId the ID of the group table
- * @return the {@link InstanceIdentifier<Group>}
+ * @return the {@link InstanceIdentifier}
*/
public static final InstanceIdentifier<Group> createGroupPath(final NodeId nodeId, final GroupId groupId) {
return createNodePath(nodeId).builder()
* @param nodeId the Id of the node
* @param groupId the ID of the group table
* @param bucketId the ID of the bucket in the group table
- * @return the {@link InstanceIdentifier<Bucket>}
+ * @return the {@link InstanceIdentifier}
*/
public static final InstanceIdentifier<Bucket> createBucketPath(final NodeId nodeId, final GroupId groupId,
final BucketId bucketId) {
/**
* Update the relevant flow table for the node
* @param nodeId the node to update
- * @param dirty the dirty set
* @param policyInfo
* @param flowMap
* @throws Exception
* Get a 32-bit context ordinal suitable for use in the OF data plane for
* the given policy item.
*
- * @param tenantId
- * the tenant ID of the element
- * @param id
- * the unique ID for the element
+ * @param destNode
+ * destination node ID
* @return the 32-bit ordinal value
* @throws Exception
*/
public abstract ClassifierDefinition getClassDef();
/**
- * @return parent classifier
- * @see {@link ClassifierDefinition}
+ * @return parent classifier, see {@link Classifier}
*/
public final Classifier getParent() {
return parent;
* @param matches list of builders containing {@code matches} to update
* @param params parameters of classifier-instance inserted by user
* @return result, which indicates if all the matching fields were updated successfully and
- * contain updated {@code matches}
- * @see {@link ClassificationResult}
+ * contain updated {@code matches}, see {@link ClassificationResult}
*/
public final ClassificationResult updateMatch(List<MatchBuilder> matches, Map<String, ParameterValue> params) {
if (params == null) {
return new ClassificationResult(matchBuilders);
}
-/**
+ /**
* Checks presence of required {@code params} in order to decide if classifier can update {@code matches} properly
- * in method {@link #update(List, Map)
+ * in method {@link #update(List, Map)}
* @param params inserted parameters, not null
- * @return true, if required parameters are present
- * @throws IllegalArgumentException when any of required {@code params} is not present
- * @see {@link #updateMatch(List, Map)}
+ * @throws IllegalArgumentException when any of required {@code params} is not present, see {@link #updateMatch(List, Map)}
*/
protected abstract void checkPresenceOfRequiredParams(Map<String, ParameterValue> params);
/**
* Create an Endpoint in the Endopint Registry. This can only be called in
- * response to an {@link EndpointDeclareRequest} message
+ * response to an {@link org.opendaylight.groupbasedpolicy.renderer.opflex.lib.messages.EndpointDeclareRequest} message
*/
public void createEp() {
/**
* Delete an Endpoint in the Endpoint Registry. This can only be called in
- * response to an {@link EndpointUndeclareRequest} message
+ * response to an {@link org.opendaylight.groupbasedpolicy.renderer.opflex.lib.messages.EndpointUndeclareRequest} message
*/
public void deleteEp() {
/**
* Look up an endpoint in the Endpoint Registry. This can only be called in
- * response to an {@link EndpointResolveRequest} message. It initiates all
+ * response to an {@link org.opendaylight.groupbasedpolicy.renderer.opflex.lib.messages.EndpointResolveRequest} message. It initiates all
* of the reads, one by one, and invokes the callback when all of them have
* completed.
*/
/**
* An interface to provide notifications when connections are
* established or closed. The connection notifications
- * use{@link RpcEncpoint} objects; as connections come and go,
- * the {@link RpcEndpoint} objects associated with the connections
+ * use {@link JsonRpcEndpoint} objects; as connections come and go,
+ * the {@link JsonRpcEndpoint} objects associated with the connections
* can be long-lived
*
* @author tbachman
* Send a concrete {@link RpcMessage} to the RPC endpoint.
*
* @param message The concrete {@link RpcMessage} to send
- * @return SettableFuture<Object> The caller can use the returned
+ * @return SettableFuture<Object> The caller can use the returned
* object to wait for the response (currently no timeout)
* @throws Throwable The concrete message couldn't be serialized and sent
*/
* request message is received
*
* @param endpoint The endpoint that received the messgae
- * @param message The concrete {@RpcMessage} received
+ * @param message The concrete {@link RpcMessage} received
*/
public void callback(JsonRpcEndpoint endpoint, RpcMessage message);
/**
*
- * Subscribe to a concrete {@RpcMessage}
+ * Subscribe to a concrete {@link RpcMessage}
*
* @param message The concrete {@link RpcMessage} message to subscribe to
* @param callback The callback to invoke when the message is published
* is received
*
* @param endpoint The endpoint that received this message
- * @param message the concrete {@RpcMessage}
+ * @param message the concrete {@link RpcMessage}
*/
public void publish(JsonRpcEndpoint endpoint, RpcMessage message);
/**
* Class that provides Managed Object metadata. The {@link PolicyClassInfo} object contains metadata
* about
- * the Managed Object, while the {@link PropertyInfo} list
+ * the Managed Object, while the {@link PolicyPropertyInfo} list
* contained by this object provides the metadata about the
* Managed Object properties.
* This data must be kept consistent with the agents.
Code Review / groupbasedpolicy.git / commitdiff