hadoop-ozone/common/src/main/java/org/apache/hadoop/ozone/security/acl/RequestContext.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.hadoop.ozone.security.acl;

import org.apache.hadoop.ipc.ProtobufRpcEngine;
import org.apache.hadoop.security.UserGroupInformation;
import org.apache.hadoop.ozone.security.acl.IAccessAuthorizer.ACLIdentityType;
import org.apache.hadoop.ozone.security.acl.IAccessAuthorizer.ACLType;

import java.net.InetAddress;

/**
 * This class encapsulates information required for Ozone ACLs.
 * */
public class RequestContext {
  private final String host;
  private final InetAddress ip;
  private final UserGroupInformation clientUgi;
  private final String serviceId;
  private final ACLIdentityType aclType;
  private final ACLType aclRights;
  private final String ownerName;

  @SuppressWarnings("parameternumber")
  public RequestContext(String host, InetAddress ip,
      UserGroupInformation clientUgi, String serviceId,
      ACLIdentityType aclType, ACLType aclRights,
      String ownerName) {
    this.host = host;
    this.ip = ip;
    this.clientUgi = clientUgi;
    this.serviceId = serviceId;
    this.aclType = aclType;
    this.aclRights = aclRights;
    this.ownerName = ownerName;
  }

  /**
   * Builder class for @{@link RequestContext}.
   */
  public static class Builder {
    private String host;
    private InetAddress ip;
    private UserGroupInformation clientUgi;
    private String serviceId;
    private IAccessAuthorizer.ACLIdentityType aclType;
    private IAccessAuthorizer.ACLType aclRights;

    /**
     *  ownerName is specially added to allow
     *  authorizer to honor owner privilege.
     */
    private String ownerName;

    public Builder setHost(String bHost) {
      this.host = bHost;
      return this;
    }

    public Builder setIp(InetAddress cIp) {
      this.ip = cIp;
      return this;
    }

    public Builder setClientUgi(UserGroupInformation cUgi) {
      this.clientUgi = cUgi;
      return this;
    }

    public Builder setServiceId(String sId) {
      this.serviceId = sId;
      return this;
    }

    public Builder setAclType(ACLIdentityType acl) {
      this.aclType = acl;
      return this;
    }

    public ACLType getAclRights() {
      return this.aclRights;
    }

    public Builder setAclRights(ACLType aclRight) {
      this.aclRights = aclRight;
      return this;
    }

    public Builder setOwnerName(String owner) {
      this.ownerName = owner;
      return this;
    }

    public RequestContext build() {
      return new RequestContext(host, ip, clientUgi, serviceId, aclType,
          aclRights, ownerName);
    }
  }

  public static Builder newBuilder() {
    return new Builder();
  }

  public static RequestContext.Builder getBuilder(
      UserGroupInformation ugi, InetAddress remoteAddress, String hostName,
      ACLType aclType, String ownerName) {
    RequestContext.Builder contextBuilder = RequestContext.newBuilder()
        .setClientUgi(ugi)
        .setIp(remoteAddress)
        .setHost(hostName)
        .setAclType(ACLIdentityType.USER)
        .setAclRights(aclType)
        .setOwnerName(ownerName);
    return contextBuilder;
  }

  public static RequestContext.Builder getBuilder(UserGroupInformation ugi,
      ACLType aclType, String ownerName) {
    return getBuilder(ugi,
        ProtobufRpcEngine.Server.getRemoteIp(),
        ProtobufRpcEngine.Server.getRemoteIp().getHostName(),
        aclType, ownerName);
  }

  public String getHost() {
    return host;
  }

  public InetAddress getIp() {
    return ip;
  }

  public UserGroupInformation getClientUgi() {
    return clientUgi;
  }

  public String getServiceId() {
    return serviceId;
  }

  public ACLIdentityType getAclType() {
    return aclType;
  }

  public ACLType getAclRights() {
    return aclRights;
  }

  public String getOwnerName() {
    return ownerName;
  }
}