sentry-core/sentry-core-common/src/main/java/org/apache/sentry/core/common/transport/SentryPolicyClientTransportConfig.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */

package org.apache.sentry.core.common.transport;

import org.apache.hadoop.conf.Configuration;
import org.apache.sentry.core.common.exception.MissingConfigurationException;
import org.apache.sentry.core.common.utils.SentryConstants;

import static org.apache.sentry.core.common.transport.SentryClientTransportConstants.PolicyClientConstants.*;

/**
 * Provides configuration values and the configuration string for the policy based
 * clients.
 * <p>
 * Curently used by policy based clients <code>SentryPolicyServiceClient</code> and
 * <code>SentryGenericServiceClient</code>
 */
public final class SentryPolicyClientTransportConfig
  implements SentryClientTransportConfigInterface {

  @Override
  public boolean isKerberosEnabled(Configuration conf) {
    return (conf.get(SECURITY_MODE, SentryConstants.KERBEROS_MODE).trim()
      .equalsIgnoreCase((SentryConstants.KERBEROS_MODE)));
  }

  @Override
  public int getSentryRpcRetryTotal(Configuration conf) {
    return conf.getInt(SENTRY_RPC_RETRY_TOTAL, SENTRY_RPC_RETRY_TOTAL_DEFAULT);
  }

  @Override
  public boolean useUserGroupInformation(Configuration conf) {
    return Boolean.valueOf(conf.get(SECURITY_USE_UGI_TRANSPORT, "true"));
  }

  /**
   * @throws MissingConfigurationException
   */
  @Override
  public String getSentryPrincipal(Configuration conf) {
    String principle = conf.get(PRINCIPAL);
    if ((principle != null) && !principle.isEmpty()) {
      return principle;
    }
    throw new MissingConfigurationException(PRINCIPAL);
  }

  /**
   * @throws MissingConfigurationException
   */
  @Override
  public String getSentryServerRpcAddress(Configuration conf) {
    String serverAddress = conf.get(SERVER_RPC_ADDRESS);
    if ((serverAddress != null) && !serverAddress.isEmpty()) {
      return serverAddress;
    }
    throw new MissingConfigurationException(SERVER_RPC_ADDRESS);
  }

  @Override
  public int getServerRpcPort(Configuration conf) {
    return conf.getInt(SERVER_RPC_PORT, SentryClientTransportConstants.RPC_PORT_DEFAULT);
  }

  @Override
  public int getServerRpcConnTimeoutInMs(Configuration conf) {
    return conf.getInt(SERVER_RPC_CONN_TIMEOUT, SERVER_RPC_CONN_TIMEOUT_DEFAULT);
  }

  @Override
  public int getPoolMaxTotal(Configuration conf) {
    return conf.getInt(SENTRY_POOL_MAX_TOTAL, SENTRY_POOL_MAX_TOTAL_DEFAULT);
  }

  @Override
  public int getPoolMinIdle(Configuration conf) {
    return conf.getInt(SENTRY_POOL_MIN_IDLE, SENTRY_POOL_MIN_IDLE_DEFAULT);
  }

  @Override
  public int getPoolMaxIdle(Configuration conf) {
    return conf.getInt(SENTRY_POOL_MAX_IDLE, SENTRY_POOL_MAX_IDLE_DEFAULT);
  }

  @Override
  public long getMinEvictableTimeSec(Configuration conf) {
    return conf.getLong(SENTRY_POOL_MIN_EVICTION_TIME_SEC,
            SENTRY_POOL_MIN_EVICTION_TIME_SEC_DEFAULT);
  }

  @Override
  public long getTimeBetweenEvictionRunsSec(Configuration conf) {
    return conf.getLong(SENTRY_POOL_EVICTION_INTERVAL_SEC,
            SENTRY_POOL_EVICTION_INTERVAL_SEC_DEFAULT);
  }

  @Override
  public boolean isLoadBalancingEnabled(Configuration conf) {
    return conf.getBoolean(SENTRY_CLIENT_LOAD_BALANCING, SENTRY_CLIENT_LOAD_BALANCING_DEFAULT);
  }

  @Override
  public boolean isTransportPoolEnabled(Configuration conf) {
    return conf.getBoolean(SENTRY_POOL_ENABLE, SENTRY_POOL_ENABLE_DEFAULT);
  }
}