Skip to content

Commit 6fe8bfb

Browse files
committed
refactor: Rename base service class and change references
1 parent 2ed1d5c commit 6fe8bfb

File tree

3 files changed

+30
-39
lines changed

3 files changed

+30
-39
lines changed

src/main/java/com/ibm/cloud/sdk/core/http/HttpClientSingleton.java

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@
1212
*/
1313
package com.ibm.cloud.sdk.core.http;
1414

15-
import com.ibm.cloud.sdk.core.service.WatsonService;
15+
import com.ibm.cloud.sdk.core.service.BaseService;
1616
import com.ibm.cloud.sdk.core.service.security.DelegatingSSLSocketFactory;
1717
import com.ibm.cloud.sdk.core.util.HttpLogging;
18-
1918
import okhttp3.ConnectionSpec;
2019
import okhttp3.OkHttpClient;
2120
import okhttp3.OkHttpClient.Builder;
@@ -52,7 +51,7 @@
5251
public class HttpClientSingleton {
5352
private static HttpClientSingleton instance = null;
5453

55-
private static final Logger LOG = Logger.getLogger(WatsonService.class.getName());
54+
private static final Logger LOG = Logger.getLogger(BaseService.class.getName());
5655

5756
/**
5857
* TrustManager for disabling SSL verification, which essentially lets everything through.
@@ -130,7 +129,7 @@ private void addCookieJar(final OkHttpClient.Builder builder) {
130129
final CookieManager cookieManager = new CookieManager();
131130
cookieManager.setCookiePolicy(CookiePolicy.ACCEPT_ALL);
132131

133-
builder.cookieJar(new WatsonCookieJar(cookieManager));
132+
builder.cookieJar(new ServiceCookieJar(cookieManager));
134133
}
135134

136135
/**
@@ -213,7 +212,7 @@ protected SSLSocket configureSocket(SSLSocket socket) throws IOException {
213212
}
214213

215214
/**
216-
* Creates an {@link OkHttpClient} instance with a new {@link WatsonCookieJar}.
215+
* Creates an {@link OkHttpClient} instance with a new {@link ServiceCookieJar}.
217216
*
218217
* @return the client
219218
*/

src/main/java/com/ibm/cloud/sdk/core/service/WatsonService.java renamed to src/main/java/com/ibm/cloud/sdk/core/service/BaseService.java

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
*
6060
* @see <a href="http://www.ibm.com/watson/developercloud/"> IBM Watson Developer Cloud</a>
6161
*/
62-
public abstract class WatsonService {
62+
public abstract class BaseService {
6363

6464
private static final String URL = "url";
6565
private static final String PATH_AUTHORIZATION_V1_TOKEN = "/v1/token";
@@ -68,11 +68,7 @@ public abstract class WatsonService {
6868
private static final String BEARER = "Bearer ";
6969
private static final String APIKEY_AS_USERNAME = "apikey";
7070
private static final String ICP_PREFIX = "icp-";
71-
private static final Logger LOG = Logger.getLogger(WatsonService.class.getName());
72-
private static final String AUTH_HEADER_DEPRECATION_MESSAGE = "Authenticating with the X-Watson-Authorization-Token"
73-
+ "header is deprecated. The token continues to work with Cloud Foundry services, but is not supported for "
74-
+ "services that use Identity and Access Management (IAM) authentication. For details see the IAM "
75-
+ "authentication section in the README.";
71+
private static final Logger LOG = Logger.getLogger(BaseService.class.getName());
7672
private String apiKey;
7773
private String username;
7874
private String password;
@@ -104,11 +100,11 @@ public abstract class WatsonService {
104100
Pattern.compile("(?i)application\\/json\\-patch\\+json(;.*)?");
105101

106102
/**
107-
* Instantiates a new Watson service.
103+
* Instantiates a new IBM Cloud service.
108104
*
109105
* @param name the service name
110106
*/
111-
public WatsonService(final String name) {
107+
public BaseService(final String name) {
112108
this.name = name;
113109

114110
// file credentials take precedence
@@ -343,10 +339,6 @@ protected void setAuthentication(final Builder builder) {
343339
builder.addHeader(HttpHeaders.AUTHORIZATION, BEARER + accessToken);
344340
} else if (getApiKey() == null) {
345341
if (skipAuthentication) {
346-
Headers currentHeaders = builder.build().headers();
347-
if (currentHeaders.get(HttpHeaders.X_WATSON_AUTHORIZATION_TOKEN) != null) {
348-
LOG.warning(AUTH_HEADER_DEPRECATION_MESSAGE);
349-
}
350342
return;
351343
}
352344
throw new IllegalArgumentException("apiKey or username and password were not specified");

src/test/java/com/ibm/cloud/sdk/core/test/service/WatsonServiceTest.java

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -17,35 +17,35 @@
1717

1818
import org.junit.Test;
1919

20-
import com.ibm.cloud.sdk.core.service.WatsonService;
20+
import com.ibm.cloud.sdk.core.service.BaseService;
2121

2222
/**
23-
* Unit tests associated with the WatsonService core class.
23+
* Unit tests associated with the BaseService core class.
2424
*
2525
*/
26-
public class WatsonServiceTest {
26+
public class BaseServiceTest {
2727

2828
@Test
2929
public void testMimeTypes() {
30-
assertTrue(WatsonService.isJsonMimeType("application/json"));
31-
assertTrue(WatsonService.isJsonMimeType("application/json; charset=utf-8"));
32-
assertTrue(WatsonService.isJsonMimeType("application/json;charset=utf-8"));
33-
assertTrue(WatsonService.isJsonMimeType("APPLICATION/JSON;charset=utf-16"));
34-
assertFalse(WatsonService.isJsonMimeType("application/notjson"));
35-
assertFalse(WatsonService.isJsonMimeType("application/json-patch+json"));
36-
assertFalse(WatsonService.isJsonMimeType("APPlication/JSON-patCH+jSoN;charset=utf-8"));
37-
assertTrue(WatsonService.isJsonPatchMimeType("APPlication/JSON-patCH+jSoN;charset=utf-8"));
38-
assertTrue(WatsonService.isJsonMimeType("application/merge-patch+json"));
39-
assertTrue(WatsonService.isJsonMimeType("application/merge-patch+json;charset=utf-8"));
40-
assertFalse(WatsonService.isJsonMimeType("application/json2-patch+json"));
41-
assertFalse(WatsonService.isJsonMimeType("application/merge-patch+json-blah"));
42-
assertFalse(WatsonService.isJsonMimeType("application/merge patch json"));
30+
assertTrue(BaseService.isJsonMimeType("application/json"));
31+
assertTrue(BaseService.isJsonMimeType("application/json; charset=utf-8"));
32+
assertTrue(BaseService.isJsonMimeType("application/json;charset=utf-8"));
33+
assertTrue(BaseService.isJsonMimeType("APPLICATION/JSON;charset=utf-16"));
34+
assertFalse(BaseService.isJsonMimeType("application/notjson"));
35+
assertFalse(BaseService.isJsonMimeType("application/json-patch+json"));
36+
assertFalse(BaseService.isJsonMimeType("APPlication/JSON-patCH+jSoN;charset=utf-8"));
37+
assertTrue(BaseService.isJsonPatchMimeType("APPlication/JSON-patCH+jSoN;charset=utf-8"));
38+
assertTrue(BaseService.isJsonMimeType("application/merge-patch+json"));
39+
assertTrue(BaseService.isJsonMimeType("application/merge-patch+json;charset=utf-8"));
40+
assertFalse(BaseService.isJsonMimeType("application/json2-patch+json"));
41+
assertFalse(BaseService.isJsonMimeType("application/merge-patch+json-blah"));
42+
assertFalse(BaseService.isJsonMimeType("application/merge patch json"));
4343

44-
assertTrue(WatsonService.isJsonPatchMimeType("application/json-patch+json"));
45-
assertTrue(WatsonService.isJsonPatchMimeType("application/json-patch+json;charset=utf-8"));
46-
assertFalse(WatsonService.isJsonPatchMimeType("application/json"));
47-
assertFalse(WatsonService.isJsonPatchMimeType("APPLICATION/JsOn; charset=utf-8"));
48-
assertFalse(WatsonService.isJsonPatchMimeType("application/merge-patch+json"));
49-
assertFalse(WatsonService.isJsonPatchMimeType("application/merge-patch+json;charset=utf-8"));
44+
assertTrue(BaseService.isJsonPatchMimeType("application/json-patch+json"));
45+
assertTrue(BaseService.isJsonPatchMimeType("application/json-patch+json;charset=utf-8"));
46+
assertFalse(BaseService.isJsonPatchMimeType("application/json"));
47+
assertFalse(BaseService.isJsonPatchMimeType("APPLICATION/JsOn; charset=utf-8"));
48+
assertFalse(BaseService.isJsonPatchMimeType("application/merge-patch+json"));
49+
assertFalse(BaseService.isJsonPatchMimeType("application/merge-patch+json;charset=utf-8"));
5050
}
5151
}

0 commit comments

Comments
 (0)