expose getCookies() in implementation but not public interface #973

Author: ehennum

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

@@ -15,11 +15,16 @@
  */
 package com.marklogic.client;
 
-import com.marklogic.client.impl.ClientCookie;
-
-import java.util.List;
-
+/**
+ * Identifies a server state for sharing across multiple calls to server endpoints.
+ *
+ * Internally, the identifier is sent to the server as a session cookie.
+ * The session cookie can be used for load balancing.
+ */
 public interface SessionState {
+  /**
+   * Provides the identifier used for the server state (for instance, for use in logging).
+   * @return   the session identifier
+   */
   public String getSessionId();
-  List<ClientCookie> getCookies();
 }

marklogic-client-api/src/main/java/com/marklogic/client/impl/OkHttpServices.java

@@ -5414,7 +5414,7 @@ public void writeTo(BufferedSink sink) throws IOException {
   }
 
   public class CallRequestImpl implements CallRequest {
-    private SessionState session;
+    private SessionStateImpl session;
     private Request.Builder requestBldr;
     private RequestBody requestBody;
     private boolean hasStreamingPart;
@@ -5423,9 +5423,12 @@ public class CallRequestImpl implements CallRequest {
     private HttpUrl callBaseUri;
 
     CallRequestImpl(String endpoint, HttpMethod method, SessionState session) {
+      if (session != null && !(session instanceof SessionStateImpl)) {
+        throw new IllegalArgumentException("Session state must be implemented by internal class: "+session.getClass().getName());
+      }
       this.endpoint = endpoint;
       this.method = method;
-      this.session = session;
+      this.session = (SessionStateImpl) session;
       this.hasStreamingPart = false;
       this.callBaseUri = new HttpUrl.Builder()
           .scheme(baseUri.scheme())
@@ -5484,8 +5487,8 @@ public HttpMethod getHttpMethod() {
     private void prepareRequestBuilder() {
       this.requestBldr = setupRequest(callBaseUri, endpoint, null);
       if (session != null) {
-        Calendar expiration = ((SessionStateImpl) session).getCreatedTimestamp() != null ?
-            (Calendar) ((SessionStateImpl) session).getCreatedTimestamp().clone() : null;
+        Calendar expiration = session.getCreatedTimestamp() != null ?
+            (Calendar) session.getCreatedTimestamp().clone() : null;
         this.requestBldr = addCookies(this.requestBldr, session.getCookies(), expiration);
         // Add the Cookie header for SessionId if we have a session object passed
         this.requestBldr.addHeader(HEADER_COOKIE, "SessionID="+session.getSessionId());

marklogic-client-api/src/main/java/com/marklogic/client/impl/SessionStateImpl.java

@@ -40,12 +40,11 @@ public String getSessionId() {
       return sessionId;
    }
 
-   @Override
-   public List<ClientCookie> getCookies() {
+   List<ClientCookie> getCookies() {
       return cookies;
    }
 
-   public void setCookies(List<ClientCookie> cookies) {
+   void setCookies(List<ClientCookie> cookies) {
       if ( cookies != null ) {
          if(setCreatedTimestamp.compareAndSet(false, true)) {
             created = Calendar.getInstance();
@@ -61,7 +60,7 @@ public void setCookies(List<ClientCookie> cookies) {
       }
    }
 
-   public Calendar getCreatedTimestamp() {
+   Calendar getCreatedTimestamp() {
       return created;
    }
 }