Skip to content
Snippets Groups Projects
Commit 7cf50cbe authored by gmantele's avatar gmantele
Browse files

[TAP] Add missing javadoc (for the function ServiceConnection.getNbMaxAsyncJob).

parent d2cf3702
No related branches found
No related tags found
No related merge requests found
......@@ -16,7 +16,8 @@ package tap;
* You should have received a copy of the GNU Lesser General Public License
* along with TAPLibrary. If not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2012 - UDS/Centre de Données astronomiques de Strasbourg (CDS)
* Copyright 2012,2014 - UDS/Centre de Données astronomiques de Strasbourg (CDS),
* Astronomisches Rechen Institut (ARI)
*/
import java.util.Collection;
......@@ -28,6 +29,12 @@ import tap.log.TAPLog;
import tap.metadata.TAPMetadata;
import uws.service.UserIdentifier;
/**
* TODO JAVADOC OF THE WHOLE CLASS!
*
* @author Gr&eacute;gory Mantelet (CDS;ARI)
* @version 2.0 (09/2014)
*/
public interface ServiceConnection {
public static enum LimitUnit{
......@@ -64,6 +71,15 @@ public interface ServiceConnection {
public Collection<String> getCoordinateSystems();
/**
* <p>Get the maximum number of asynchronous jobs that can run in the same time.</p>
*
* <p>A null or negative value means <b>no limit</b> on the number of running asynchronous jobs.</p>
*
* @return Maximum number of running jobs (&le;0 => no limit).
*
* @since 2.0
*/
public int getNbMaxAsyncJobs();
public TAPLog getLogger();
......
......@@ -137,8 +137,8 @@ public abstract class TAPFactory extends AbstractUWSFactory {
* <p>This function is called particularly by the queue manager in order to determine whether a job can start.
* It won't start if no connection is available.</p>
*
* <p><i>Note:
* If the implementation of this factory creates connections on the fly, the value 1 (or bigger) must always be returned.
* <p><i><b>Important note:</b>
* If the implementation of this factory creates connections on the fly, the value 2 (or bigger) must always be returned.
* However, if the connections are managed by a connection pool, the count value must be asked to it.
* </i></p>
*
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment