marklogic/lib/session-state.js

The official MarkLogic Node.js client API.

/*
 * Copyright (c) 2020 MarkLogic Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
'use strict';

/**
 * 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.
 */
class SessionState {
  /**
   * Constructs an identifier for session state on the server.
   */
  constructor() {
    // TODO: use BigInt?
    this._sessionId = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
  }

  /**
   * Provides the identifier used for the server state (for instance, for use in logging).
   * @returns {number} the session identifier
   */
  sessionId() {
    return this._sessionId;
  }
}

module.exports = SessionState;