From af869409b81ad399b4733a1b7b0d5c662fbfa73d Mon Sep 17 00:00:00 2001 From: liamfallon Date: Fri, 6 Jul 2018 13:38:08 +0100 Subject: Fix Javadoc errors Path changes and changes due to mitigation of security violations caused some links in the Javadoc not to work any more. This changes fixes the javadoc. Issue-ID: POLICY-954 Change-Id: Ic9db2627fb1ffad69c8acadc7b975bc40864caaf Signed-off-by: liamfallon --- .../jms/JMSObjectEventProtocolParameters.java | 28 +++++++++++----------- .../jms/JMSTextEventProtocolParameters.java | 2 +- .../plugins/event/protocol/jms/package-info.java | 2 +- .../plugins-event/plugins-event-protocol/pom.xml | 3 ++- 4 files changed, 18 insertions(+), 17 deletions(-) (limited to 'plugins/plugins-event') diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java index c2baff8e6..83aef4e9d 100644 --- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java +++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSObjectEventProtocolParameters.java @@ -26,34 +26,34 @@ import org.onap.policy.apex.service.parameters.eventprotocol.EventProtocolParame * Event protocol parameters for JMS Object messages as an event protocol. * *

- * On reception of an a JMS {@link javax.jms.ObjectMessage}, the JMS Object plugin unmarshals the message as follows: + * On reception of an a JMS {@code javax.jms.ObjectMessage}, the JMS Object plugin unmarshals the message as follows: *

    - *
  1. It extracts the Java object from the {@link javax.jms.ObjectMessage} instance. - *
  2. It creates an {@link org.onap.policy.apex.service.engine.event.ApexEvent} instance to hold the java object. + *
  3. It extracts the Java object from the {@code javax.jms.ObjectMessage} instance.
    4. + *
  4. It creates an {@link org.onap.policy.apex.service.engine.event.ApexEvent} instance to hold the java object.
    5. *
  5. It sets the name of the Apex event to be the simple class name of the incoming Java object and appends the value - * of the {@code incomingEventSuffix} parameter to it. - *
  6. It sets the version of the incoming event to the value of the {@code incomingEventVersion} parameter. + * of the {@code incomingEventSuffix} parameter to it.
    7. + *
  7. It sets the version of the incoming event to the value of the {@code incomingEventVersion} parameter.
    8. *
  8. It sets the name space of the incoming event to be the value of the package of the class of the incoming Java - * object. - *
  9. It sets the source of the incoming event to the value of the {@code incomingEventSource} parameter. - *
  10. It sets the target of the incoming event to the value of the {@code incomingEventTarget} parameter. + * object.
    11. + *
  11. It sets the source of the incoming event to the value of the {@code incomingEventSource} parameter.
    12. + *
  12. It sets the target of the incoming event to the value of the {@code incomingEventTarget} parameter.
    13. *
  13. It puts a single entry into the Apex event map with the the simple class name of the incoming Java object being - * the key of the entry and the actual incoming object as the value of the entry. + * the key of the entry and the actual incoming object as the value of the entry.
    14. *
*

* When sending an object to JMS, the plugin expects to receive an Apex event with a single entry. The plugin marshals - * the value of that entry to an object that can be sent by JMS as a {@link javax.jms.ObjectMessage} instance. + * the value of that entry to an object that can be sent by JMS as a {@code javax.jms.ObjectMessage} instance. *

* The parameters for this plugin are: *

    *
  1. incomingEventSuffix: The suffix to append to the simple name of incoming Java class instances when they are - * encapsulated in Apex events. The parameter defaults to the string value {@code IncomingEvent}. + * encapsulated in Apex events. The parameter defaults to the string value {@code IncomingEvent}.
    2. *
  2. incomingEventVersion: The event version to use for incoming Java class instances when they are encapsulated in - * Apex events. The parameter defaults to the string value {@code 1.0.0}. + * Apex events. The parameter defaults to the string value {@code 1.0.0}.
    3. *
  3. incomingEventSource: The event source to use for incoming Java class instances when they are encapsulated in Apex - * events. The parameter defaults to the string value {@code JMS}. + * events. The parameter defaults to the string value {@code JMS}.
    4. *
  4. incomingEventTarget: The event target to use for incoming Java class instances when they are encapsulated in Apex - * events. The parameter defaults to the string value {@code Apex}. + * events. The parameter defaults to the string value {@code Apex}.
    5. *
* * @author Liam Fallon (liam.fallon@ericsson.com) diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java index 8ddc64862..b3a9154ff 100644 --- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java +++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/JMSTextEventProtocolParameters.java @@ -28,7 +28,7 @@ import org.onap.policy.apex.service.engine.event.impl.jsonprotocolplugin.JSONEve * Text messages received and sent over JMS in ~Text format are assumed to be in a JSON format that Apex can understand. * Therefore this plugin is a subclass of the built in JSON event protocol plugin. *

- * On reception of a JMS {@link javax.jms.TextMessage} message, the JMS Text plugin unmarshals the message the JMS text + * On reception of a JMS {@code javax.jms.TextMessage} message, the JMS Text plugin unmarshals the message the JMS text * message and passes it to its JSON superclass unmarshaling for processing. *

* When sending an Apex event, the plugin uses its underlying JSON superclass to marshal the event to a JSON string and diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java index 92d6d07d4..f7e236743 100644 --- a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java +++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-jms/src/main/java/org/onap/policy/apex/plugins/event/protocol/jms/package-info.java @@ -20,7 +20,7 @@ /** * Contains implementations of Apex event protocol converter plugins for JMS event protocols that are implementations of - * {@link javax.jms.Message}. + * {@code javax.jms.Message}. * * @author Liam Fallon (liam.fallon@ericsson.com) */ diff --git a/plugins/plugins-event/plugins-event-protocol/pom.xml b/plugins/plugins-event/plugins-event-protocol/pom.xml index 563a4f625..a751dc4ba 100644 --- a/plugins/plugins-event/plugins-event-protocol/pom.xml +++ b/plugins/plugins-event/plugins-event-protocol/pom.xml @@ -40,5 +40,6 @@ plugins-event-protocol-jms plugins-event-protocol-xml + plugins-event-protocol-yaml - \ No newline at end of file + -- cgit 1.2.3-korg