Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

simplify javadoc links #3785

Merged
merged 4 commits into from
Sep 29, 2022
Merged

simplify javadoc links #3785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05d65b5
simplify javadoc links
gvanbrakel Sep 29, 2022
cc25c07
one file too many
gvanbrakel Sep 29, 2022
60c326e
avoid checkstyle problem, follow suggestion
gvanbrakel Sep 29, 2022
bf3bf8f
Merge branch 'master' into issue/cleanup_javadoc_links
gvanbrakel Sep 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions akamai/src/main/java/nl/nn/adapterframework/extensions/akamai/NetStorageCmsSigner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ public NetStorageCmsSigner(URI uri, CredentialFactory accessTokenCf, SignType si

/**
* Computes the value for the the X-Akamai-ACS-Action: header. This is an url query-string encoded separated
* list of parameters in the form of name=value&name2=value2.
* list of parameters in the form of name=value&name2=value2.
* @param action the set of action parameters to be sent in the API request
* @return an url encoded query string of name-value pairs from the {@link nl.nn.adapterframework.extensions.akamai.NetStorageRequest}
* @return an url encoded query string of name-value pairs from the {@link NetStorageRequest}
*/
protected String getActionHeaderValue(NetStorageRequest action) {
return action.compileHeader();
Expand Down
10 changes: 5 additions & 5 deletions akamai/src/main/java/nl/nn/adapterframework/extensions/akamai/NetStorageSender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
/**
* Sender for Akamai NetStorage (HTTP based).
*
* <p>See {@link nl.nn.adapterframework.http.HttpSenderBase} for more arguments and parameters!</p>
* <p>See {@link HttpSenderBase} for more arguments and parameters!</p>
*
*
* <p><b>AuthAlias:</b></p>
Expand Down Expand Up @@ -210,9 +210,9 @@ public Message extractResult(HttpResponseHandler responseHandler, PipeLineSessio
} else {
if (statusCode==HttpServletResponse.SC_OK) {
ok = true;
} else if (isFollowRedirects() &&
statusCode == HttpServletResponse.SC_MOVED_PERMANENTLY ||
statusCode == HttpServletResponse.SC_MOVED_TEMPORARILY ||
} else if (isFollowRedirects() &&
statusCode == HttpServletResponse.SC_MOVED_PERMANENTLY ||
statusCode == HttpServletResponse.SC_MOVED_TEMPORARILY ||
statusCode == HttpServletResponse.SC_TEMPORARY_REDIRECT) {
ok = true;
}
Expand Down Expand Up @@ -271,7 +271,7 @@ public Message extractResult(HttpResponseHandler responseHandler, PipeLineSessio
}

/**
* When an exception occurs and the response cannot be parsed, we do not want to throw a 'missing response' exception.
* When an exception occurs and the response cannot be parsed, we do not want to throw a 'missing response' exception.
* Since this method is used when handling exceptions, silently return null, to avoid NPE's and IOExceptions
*/
public String getResponseBodyAsString(HttpResponseHandler responseHandler, boolean throwIOExceptionWhenParsingResponse) throws IOException {
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/nl/nn/adapterframework/cache/ICacheEnabled.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@
package nl.nn.adapterframework.cache;

/**
* Interface to be implemented by classes that could use a cache.
* Interface to be implemented by classes that could use a cache.
* Implementers will be notified of a cache that is configured via setCache().
* They must call cache.configure() once in their own configure() method
* They must call cache.open() and cache.close() from their own open() resp. close().
*
*
* @author Gerrit van Brakel
* @since 4.11
*/
public interface ICacheEnabled<K,V> {

/** optional {@link nl.nn.adapterframework.cache.EhCache cache} definition */
/** optional {@link EhCache cache} definition */
void setCache(ICache<K,V> cache);
ICache<K,V> getCache();
}
7 changes: 4 additions & 3 deletions core/src/main/java/nl/nn/adapterframework/configuration/ConfigurationDigester.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
import nl.nn.adapterframework.util.ClassUtils;
import nl.nn.adapterframework.util.LogUtil;
import nl.nn.adapterframework.util.SpringUtils;
import nl.nn.adapterframework.util.StringResolver;
import nl.nn.adapterframework.util.TransformerPool;
import nl.nn.adapterframework.util.XmlUtils;
import nl.nn.adapterframework.xml.AttributePropertyResolver;
Expand All @@ -67,8 +68,8 @@
* The configurationDigester reads the configuration.xml and the digester rules
* in XML format and factors a Configuration.
*
* <p>Since 4.0.1, the configuration.xml is first resolved using the {@link nl.nn.adapterframework.util.StringResolver resolver},
* with tries to resolve ${variable} with the {@link nl.nn.adapterframework.util.AppConstants AppConstants}, so that
* <p>Since 4.0.1, the configuration.xml is first resolved using the {@link StringResolver resolver},
* with tries to resolve ${variable} with the {@link AppConstants}, so that
* both the values from the property files as the environment setting are available.<p>
* <p>Since 4.1.1 the configuration.xml is parsed with a entityresolver that uses the classpath, which
* means that you may specify entities that will be resolved during parsing.
Expand Down Expand Up @@ -135,7 +136,7 @@ private void logErrorMessage(String prefix, SAXParseException exception) {
private Digester getDigester(Configuration configuration) throws ConfigurationException, ParserConfigurationException, SAXException {
XMLReader reader = XmlUtils.getXMLReader(configuration);
Digester digester = new Digester(reader) {
// override Digester.createSAXException() implementations to obtain a clear unduplicated message and a properly nested stacktrace on IBM JDK
// override Digester.createSAXException() implementations to obtain a clear unduplicated message and a properly nested stacktrace on IBM JDK
@Override
public SAXException createSAXException(String message, Exception e) {
return SaxException.createSaxException(message, getDocumentLocator(), e);
Expand Down
3 changes: 2 additions & 1 deletion core/src/main/java/nl/nn/adapterframework/configuration/digester/DigesterRuleBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
import lombok.Setter;
import nl.nn.adapterframework.configuration.ApplicationWarnings;
import nl.nn.adapterframework.configuration.ConfigurationWarnings;
import nl.nn.adapterframework.configuration.classloaders.IConfigurationClassLoader;
import nl.nn.adapterframework.core.INamedObject;
import nl.nn.adapterframework.core.IbisException;
import nl.nn.adapterframework.scheduler.job.IJob;
Expand Down Expand Up @@ -91,7 +92,7 @@ protected final void addGlobalWarning(String message) {
}

/**
* @return an {@link nl.nn.adapterframework.configuration.classloaders.IConfigurationClassLoader IConfigurationClassLoader}.
* @return an {@link IConfigurationClassLoader}.
*/
protected final ClassLoader getClassLoader() {
if(applicationContext == null) {
Expand Down
20 changes: 10 additions & 10 deletions core/src/main/java/nl/nn/adapterframework/core/IListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@

/**
* Base-interface for IPullingListener and IPushingListener.
* @param <M> the raw message type
*
* @param <M> the raw message type
*
* @author Gerrit van Brakel
* @since 4.2
*/
@FrankDocGroup(order = 30, name = "Listeners")
public interface IListener<M> extends IConfigurable {

/**
* <code>configure()</code> is called once at startup of the framework in the <code>configure()</code> method
* of the owner of this listener.
* Purpose of this method is to reduce creating connections to databases etc. in the {@link nl.nn.adapterframework.core.IPullingListener#getRawMessage(Map)} method.
* <code>configure()</code> is called once at startup of the framework in the <code>configure()</code> method
* of the owner of this listener.
* Purpose of this method is to reduce creating connections to databases etc. in the {@link IPullingListener#getRawMessage(Map)} method.
* As much as possible class-instantiating should take place in the
* <code>configure()</code> or <code>open()</code> method, to improve performance.
*/
Expand All @@ -54,7 +54,7 @@ public interface IListener<M> extends IConfigurable {
public void close() throws ListenerException;

/**
* Extracts ID-string from message obtained from {@link nl.nn.adapterframework.core.IPullingListener#getRawMessage(Map)}. May also extract
* Extracts ID-string from message obtained from {@link IPullingListener#getRawMessage(Map)}. May also extract
* other parameters from the message and put those in the context.
* <br>
* Common entries in the session context are:
Expand All @@ -64,21 +64,21 @@ public interface IListener<M> extends IConfigurable {
* <li>tsReceived: timestamp of reception of the message, formatted as yyyy-MM-dd HH:mm:ss.SSS</li>
* <li>tsSent: timestamp of sending of the message (only when available), formatted as yyyy-MM-dd HH:mm:ss.SSS</li>
* </ul>
*
*
* @return Correlation ID string.
*/
String getIdFromRawMessage(M rawMessage, Map<String,Object> context) throws ListenerException;

/**
* Extracts string from message obtained from {@link nl.nn.adapterframework.core.IPullingListener#getRawMessage(Map)}. May also extract
* Extracts string from message obtained from {@link IPullingListener#getRawMessage(Map)}. May also extract
* other parameters from the message and put those in the threadContext.
* @return input message for adapter.
*/
Message extractMessage(M rawMessage, Map<String,Object> context) throws ListenerException;

/**
* Called to perform actions (like committing or sending a reply) after a message has been processed by the
* Pipeline.
* Called to perform actions (like committing or sending a reply) after a message has been processed by the
* Pipeline.
*/
void afterMessageProcessed(PipeLineResult processResult, Object rawMessageOrWrapper, Map<String,Object> context) throws ListenerException;

Expand Down
10 changes: 5 additions & 5 deletions core/src/main/java/nl/nn/adapterframework/core/IReceiverStatistics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,21 @@

import nl.nn.adapterframework.statistics.StatisticsKeeper;
/**
* Methods for Receivers to supply statistics to a maintenance clients. Receivers indicate
* by implementing this interface that process- and idle statistics may be available for
* Methods for Receivers to supply statistics to a maintenance clients. Receivers indicate
* by implementing this interface that process- and idle statistics may be available for
* displaying.
*
*
* @author Gerrit van Brakel
*/
public interface IReceiverStatistics {
/**
* @return an iterator of {@link nl.nn.adapterframework.statistics.StatisticsKeeper}s describing the durations of time that
* @return an iterator of {@link StatisticsKeeper}s describing the durations of time that
* the receiver has been waiting between messages.
*/
Iterable<StatisticsKeeper> getIdleStatistics();

/**
* @return an iterator of {@link nl.nn.adapterframework.statistics.StatisticsKeeper}s describing the durations of time that
* @return an iterator of {@link StatisticsKeeper}s describing the durations of time that
* the receiver has been waiting for the adapter to process messages.
*/
Iterable<StatisticsKeeper> getProcessStatistics();
Expand Down
4 changes: 3 additions & 1 deletion core/src/main/java/nl/nn/adapterframework/core/ISenderWithParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@
*/
package nl.nn.adapterframework.core;

import nl.nn.adapterframework.parameters.Parameter;

/**
* The <code>ISenderWithParameters</code> allows Senders to declare that they accept and may use {@link nl.nn.adapterframework.parameters.Parameter parameters}
* The <code>ISenderWithParameters</code> allows Senders to declare that they accept and may use {@link Parameter parameters}
*
* @author Gerrit van Brakel
*/
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/nl/nn/adapterframework/extensions/api/ApiStreamPipe.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
import org.apache.commons.lang3.StringUtils;

import nl.nn.adapterframework.configuration.ConfigurationException;
import nl.nn.adapterframework.core.PipeLineSession;
import nl.nn.adapterframework.core.ITransactionalStorage;
import nl.nn.adapterframework.core.PipeLineSession;
import nl.nn.adapterframework.core.PipeRunException;
import nl.nn.adapterframework.jdbc.FixedQuerySender;
import nl.nn.adapterframework.jdbc.JdbcException;
Expand All @@ -34,7 +34,7 @@
/**
* Extension to StreamPipe for API Management.
* <p>
* In {@link nl.nn.adapterframework.pipes.StreamPipe} for parameter <code>httpRequest</code> and attribute
* In {@link StreamPipe} for parameter <code>httpRequest</code> and attribute
* <code>extractFirstStringPart=true</code> the first part is returned to the pipeline.
* In this class the first part is checked. If it contains a 'MessageID' with namespace "http://www.w3.org/2005/08/addressing",
* then the message to return to the pipeline is retrieved from the MessageStore.
Expand Down
5 changes: 2 additions & 3 deletions core/src/main/java/nl/nn/adapterframework/filesystem/MailListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,13 @@
import nl.nn.adapterframework.configuration.ConfigurationWarning;
import nl.nn.adapterframework.core.ListenerException;
import nl.nn.adapterframework.doc.IbisDoc;
import nl.nn.adapterframework.receivers.Receiver;
import nl.nn.adapterframework.stream.Message;
import nl.nn.adapterframework.xml.SaxElementBuilder;
import nl.nn.adapterframework.xml.XmlWriter;

/**
* Implementation of a {@link nl.nn.adapterframework.filesystem.FileSystemListener
* FileSystemListener} that enables a
* {@link nl.nn.adapterframework.receivers.Receiver} to look in a folder
* Implementation of a {@link FileSystemListener} that enables a {@link Receiver} to look in a folder
* for received mails. When a mail is found, it is moved to an output folder (or
* it's deleted), so that it isn't found more then once. A xml string with
* information about the mail is passed to the pipeline.
Expand Down
15 changes: 8 additions & 7 deletions core/src/main/java/nl/nn/adapterframework/http/HttpListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,24 @@
*/
package nl.nn.adapterframework.http;

import org.apache.commons.lang3.StringUtils;

import lombok.Getter;
import nl.nn.adapterframework.core.HasPhysicalDestination;
import nl.nn.adapterframework.core.IPushingListener;
import nl.nn.adapterframework.core.ListenerException;
import nl.nn.adapterframework.doc.IbisDoc;
import nl.nn.adapterframework.http.rest.ApiListener;
import nl.nn.adapterframework.receivers.Receiver;
import nl.nn.adapterframework.receivers.ServiceDispatcher;

import org.apache.commons.lang3.StringUtils;

import lombok.Getter;

/**
* Implementation of a {@link IPushingListener IPushingListener} that enables a {@link nl.nn.adapterframework.receivers.Receiver}
* Implementation of a {@link IPushingListener IPushingListener} that enables a {@link Receiver}
* to receive messages from HTTP requests. If you are writing a new configuration, you are recommended to use
* an {@link nl.nn.adapterframework.http.rest.ApiListener} or a {@link nl.nn.adapterframework.http.WebServiceListener}
* an {@link ApiListener} or a {@link WebServiceListener}
* instead.
*
* @author Gerrit van Brakel
* @author Gerrit van Brakel
* @since 4.4.x (still experimental)
*/
@Deprecated
Expand Down
3 changes: 2 additions & 1 deletion core/src/main/java/nl/nn/adapterframework/http/PushingListenerAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,13 @@
import nl.nn.adapterframework.core.PipeLineResult;
import nl.nn.adapterframework.core.PipeLineSession;
import nl.nn.adapterframework.doc.Protected;
import nl.nn.adapterframework.receivers.Receiver;
import nl.nn.adapterframework.receivers.ServiceClient;
import nl.nn.adapterframework.stream.Message;
import nl.nn.adapterframework.util.LogUtil;

/**
* Baseclass of a {@link IPushingListener IPushingListener} that enables a {@link nl.nn.adapterframework.receivers.Receiver}
* Baseclass of a {@link IPushingListener IPushingListener} that enables a {@link Receiver}
* to receive messages from Servlets.
* </table>
* @author Gerrit van Brakel
Expand Down
10 changes: 6 additions & 4 deletions core/src/main/java/nl/nn/adapterframework/http/RestListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,16 @@
import nl.nn.adapterframework.core.PipeRunException;
import nl.nn.adapterframework.core.PipeRunResult;
import nl.nn.adapterframework.doc.IbisDoc;
import nl.nn.adapterframework.http.rest.ApiListener;
import nl.nn.adapterframework.pipes.JsonPipe;
import nl.nn.adapterframework.pipes.JsonPipe.Direction;
import nl.nn.adapterframework.receivers.Receiver;
import nl.nn.adapterframework.stream.Message;

/**
* Listener that allows a {@link nl.nn.adapterframework.receivers.Receiver} to receive messages as a REST webservice.
* Listener that allows a {@link Receiver} to receive messages as a REST webservice.
* Prepends the configured URI pattern with <code>rest/</code>. When you are writing a new Frank config, you are recommended
* to use an {@link nl.nn.adapterframework.http.rest.ApiListener} instead. You can find all serviced URI patterns
* to use an {@link ApiListener} instead. You can find all serviced URI patterns
* in the Frank!Console: main menu item Webservice, heading Available REST Services.
*
* <p>
Expand Down Expand Up @@ -253,12 +255,12 @@ public void setRetrieveMultipart(boolean b) {
retrieveMultipart = b;
}

@IbisDoc({"Mediatype (e.g. XML, JSON, TEXT) the {@link nl.nn.adapterframework.http.RestServiceDispatcher restServiceDispatcher} receives as input", "XML"})
@IbisDoc({"Mediatype (e.g. XML, JSON, TEXT) the {@link RestServiceDispatcher} receives as input", "XML"})
public void setConsumes(MediaTypes consumes) {
this.consumes = consumes;
}

@IbisDoc({"Mediatype (e.g. XML, JSON, TEXT) the {@link nl.nn.adapterframework.http.RestServiceDispatcher restServiceDispatcher} sends as output, if set to json the ibis will automatically try to convert the xml message", "XML"})
@IbisDoc({"Mediatype (e.g. XML, JSON, TEXT) the {@link RestServiceDispatcher} sends as output, if set to json the ibis will automatically try to convert the xml message", "XML"})
public void setProduces(MediaTypes produces) {
this.produces = produces;
}
Expand Down
5 changes: 2 additions & 3 deletions core/src/main/java/nl/nn/adapterframework/http/RestListenerUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,8 @@
import nl.nn.adapterframework.util.StreamUtil;

/**
* Some utilities for working with
* {@link nl.nn.adapterframework.http.RestListener RestListener}.
*
* Some utilities for working with {@link RestListener}.
*
* @author Peter Leeuwenburgh
*/
public class RestListenerUtils {
Expand Down
3 changes: 2 additions & 1 deletion core/src/main/java/nl/nn/adapterframework/http/WebServiceListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,15 @@
import nl.nn.adapterframework.core.PipeLineSession;
import nl.nn.adapterframework.doc.IbisDoc;
import nl.nn.adapterframework.http.cxf.MessageProvider;
import nl.nn.adapterframework.receivers.Receiver;
import nl.nn.adapterframework.receivers.ServiceDispatcher;
import nl.nn.adapterframework.soap.SoapWrapper;
import nl.nn.adapterframework.stream.Message;
import nl.nn.adapterframework.util.AppConstants;
import nl.nn.adapterframework.util.XmlBuilder;

/**
* Listener that allows a {@link nl.nn.adapterframework.receivers.Receiver} to receive messages as a SOAP webservice.
* Listener that allows a {@link Receiver} to receive messages as a SOAP webservice.
* The structure of the SOAP messages is expressed in a WSDL (Web Services Description Language) document.
* The Frank!Framework generates a WSDL document for each adapter that contains WebServiceListeners. You can
* find these documents in the Frank!Console under main menu item Webservices, heading Available WSDL's.
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/nl/nn/adapterframework/http/rest/ApiListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

// TODO: Link to https://swagger.io/specification/ when anchors are supported by the Frank!Doc.
/**
* Listener that allows a {@link nl.nn.adapterframework.receivers.Receiver} to receive messages as a REST webservice.
* Listener that allows a {@link Receiver} to receive messages as a REST webservice.
* Prepends the configured URI pattern with <code>api/</code>. The structure of REST messages is described
* by OpenAPI specifications. The Frank!Framework generates an OpenAPI specification for each ApiListener and
* also an OpenAPI specification for all ApiListeners in all configurations. You can
Expand Down
Loading