Skip to content

Commit f790d6d

Browse files
author
ehennum
committed
caveats for database parameter in JavaDoc #1065
1 parent b983015 commit f790d6d

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

marklogic-client-api/src/main/java/com/marklogic/client/DatabaseClientFactory.java

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1127,6 +1127,10 @@ static public DatabaseClient newClient(String host, int port) {
11271127
* without any authentication. Such clients can be convenient for
11281128
* experimentation but should not be used in production.
11291129
*
1130+
* The CallManager interface can only call an endpoint for the configured content database
1131+
* of the appserver. You cannot specify the database when constructing a client for working
1132+
* with a CallManager.
1133+
*
11301134
* @param host the host with the REST server
11311135
* @param port the port for the REST server
11321136
* @param database the database to access (default: configured database for the REST server)
@@ -1171,6 +1175,10 @@ static public DatabaseClient newClient(String host, int port, SecurityContext se
11711175
/**
11721176
* Creates a client to access the database by means of a REST server.
11731177
*
1178+
* The CallManager interface can only call an endpoint for the configured content database
1179+
* of the appserver. You cannot specify the database when constructing a client for working
1180+
* with a CallManager.
1181+
*
11741182
* @param host the host with the REST server
11751183
* @param port the port for the REST server
11761184
* @param database the database to access (default: configured database for
@@ -1187,6 +1195,10 @@ static public DatabaseClient newClient(String host, int port, String database, S
11871195
/**
11881196
* Creates a client to access the database by means of a REST server.
11891197
*
1198+
* The CallManager interface can only call an endpoint for the configured content database
1199+
* of the appserver. You cannot specify the database when constructing a client for working
1200+
* with a CallManager.
1201+
*
11901202
* @param host the host with the REST server
11911203
* @param port the port for the REST server
11921204
* @param database the database to access (default: configured database for
@@ -1260,6 +1272,10 @@ static public DatabaseClient newClient(String host, int port, String user, Strin
12601272
/**
12611273
* Creates a client to access the database by means of a REST server.
12621274
*
1275+
* The CallManager interface can only call an endpoint for the configured content database
1276+
* of the appserver. You cannot specify the database when constructing a client for working
1277+
* with a CallManager.
1278+
*
12631279
* @param host the host with the REST server
12641280
* @param port the port for the REST server
12651281
* @param database the database to access (default: configured database for the REST server)
@@ -1292,6 +1308,10 @@ static public DatabaseClient newClient(String host, int port, String user, Strin
12921308
/**
12931309
* Creates a client to access the database by means of a REST server.
12941310
*
1311+
* The CallManager interface can only call an endpoint for the configured content database
1312+
* of the appserver. You cannot specify the database when constructing a client for working
1313+
* with a CallManager.
1314+
*
12951315
* @param host the host with the REST server
12961316
* @param port the port for the REST server
12971317
* @param database the database to access (default: configured database for the REST server)
@@ -1326,6 +1346,10 @@ static public DatabaseClient newClient(String host, int port, String user, Strin
13261346
/**
13271347
* Creates a client to access the database by means of a REST server.
13281348
*
1349+
* The CallManager interface can only call an endpoint for the configured content database
1350+
* of the appserver. You cannot specify the database when constructing a client for working
1351+
* with a CallManager.
1352+
*
13291353
* @param host the host with the REST server
13301354
* @param port the port for the REST server
13311355
* @param database the database to access (default: configured database for the REST server)
@@ -1564,6 +1588,11 @@ public String getDatabase() {
15641588
/**
15651589
* Specifies the database for clients created with a
15661590
* DatabaseClientFactory.Bean object.
1591+
*
1592+
* The CallManager interface can only call an endpoint for the configured content database
1593+
* of the appserver. You cannot specify the database when constructing a client for working
1594+
* with a CallManager.
1595+
*
15671596
* @param database a database to pass along to new DocumentManager and QueryManager instances
15681597
*/
15691598
public void setDatabase(String database) {

0 commit comments

Comments
 (0)