com.google.apphosting.runtime.SessionsConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of runtime-impl-jetty12 Show documentation

There is a newer version: 2.0.31

/*
 * Copyright 2021 Google LLC
 *
 * 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
 *
 *     https://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.
 */

package com.google.apphosting.runtime;

import javax.annotation.Nullable;

/**
 * Http Sessions config options.
 *
 */
public class SessionsConfig {
  private final boolean enabled;
  private final boolean asyncPersistence;
  @Nullable private final String asyncPersistenceQueueName;

  public SessionsConfig(
      boolean enabled, boolean asyncPersistence, @Nullable String asyncPersistenceQueueName) {
    this.enabled = enabled;
    this.asyncPersistence = asyncPersistence;
    this.asyncPersistenceQueueName = asyncPersistenceQueueName;
  }

  /**
   * Returns true if sessions are enabled.  Otherwise, for JSPs which always
   * use getSessions(), we'll make a dummy session object, but not allow real
   * operations on it.
   */
  public boolean isEnabled() {
    return enabled;
  }

  /**
   * Returns true if sessions are asynchronously written to the datastore.
   */
  public boolean isAsyncPersistence() {
    return asyncPersistence;
  }

  /**
   * Returns the name of the queue to use for async session persistence.  If
   * {@code null}, the default queue will be used.
   */
  public String getAsyncPersistenceQueueName() {
    return asyncPersistenceQueueName;
  }
}