schemacrawler.crawl.MutablePrivilege Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of schemacrawler Show documentation

SchemaCrawler is an open-source Java API that makes working with database metadata as easy as working with plain old Java objects. SchemaCrawler is also a database schema discovery and comprehension, and schema documentation tool. You can search for database schema objects using regular expressions, and output the schema and data in a readable text format. The output is designed to be diff-ed against other database schemas.

There is a newer version: 16.24.2

Show newest version

/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2024, Sualeh Fatehi .
All rights reserved.
------------------------------------------------------------------------

SchemaCrawler is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

SchemaCrawler and the accompanying materials are made available under
the terms of the Eclipse Public License v1.0, GNU General Public License
v3 or GNU Lesser General Public License v3.

You may elect to redistribute this code under any of these licenses.

The Eclipse Public License is available at:
http://www.eclipse.org/legal/epl-v10.html

The GNU General Public License v3 and the GNU Lesser General Public
License v3 are available at:
http://www.gnu.org/licenses/

========================================================================
*/

package schemacrawler.crawl;

import static java.util.Comparator.naturalOrder;
import static us.fatehi.utility.Utility.isBlank;
import static us.fatehi.utility.Utility.trimToEmpty;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;

import schemacrawler.schema.DatabaseObject;
import schemacrawler.schema.Grant;
import schemacrawler.schema.Privilege;

/** Represents a privilege of a table or column. */
final class MutablePrivilege extends AbstractDependantObject
    implements Privilege {

  final class PrivilegeGrant implements Grant {

    private static final long serialVersionUID = 356151825191631484L;
    private final String grantee;
    private final String grantor;
    private final boolean isGrantable;

    PrivilegeGrant(final String grantor, final String grantee, final boolean isGrantable) {
      this.grantor = grantor;
      this.grantee = grantee;
      this.isGrantable = isGrantable;
    }

    /**
     * {@inheritDoc}
     *
     * NOTE: compareTo is not compatible with equals. equals compares the full name of a database
     * object, but compareTo uses more fields to define a "natural" sorting order. compareTo may
     * return incorrect results until the object is fully built by SchemaCrawler.
     */
    @Override
    public int compareTo(final Grant otherGrant) {
      int compare = 0;
      if (compare == 0) {
        if (grantor == null) {
          return -1;
        } else {
          compare = grantor.compareTo(otherGrant.getGrantor());
        }
      }
      if (compare == 0) {
        if (grantee == null) {
          return -1;
        } else {
          compare = grantee.compareTo(otherGrant.getGrantee());
        }
      }
      return compare;
    }

    @Override
    public boolean equals(final Object obj) {
      if (this == obj) {
        return true;
      }
      if (obj == null) {
        return false;
      }
      if (getClass() != obj.getClass()) {
        return false;
      }
      final PrivilegeGrant other = (PrivilegeGrant) obj;
      return Objects.equals(getParent(), other.getParent())
          && Objects.equals(grantee, other.grantee)
          && Objects.equals(grantor, other.grantor)
          && isGrantable == other.isGrantable;
    }

    /** {@inheritDoc} */
    @Override
    public String getGrantee() {
      return grantee;
    }

    /** {@inheritDoc} */
    @Override
    public String getGrantor() {
      return grantor;
    }

    @Override
    public Privilege getParent() {
      return MutablePrivilege.this;
    }

    @Override
    public int hashCode() {
      return Objects.hash(getParent(), grantee, grantor, isGrantable);
    }

    /** {@inheritDoc} */
    @Override
    public boolean isGrantable() {
      return isGrantable;
    }

    @Override
    public String toString() {
      return String.format(
          "%s --> %s%s",
          trimToEmpty(grantor), trimToEmpty(grantee), isGrantable ? " (grantable)" : "");
    }
  }

  private static final long serialVersionUID = -1117664231494271886L;

  private final Set> grants;

  MutablePrivilege(final DatabaseObjectReference parent, final String name) {
    super(parent, name);
    grants = ConcurrentHashMap.newKeySet();
  }

  @Override
  public Collection> getGrants() {
    final List> values = new ArrayList<>(grants);
    values.sort(naturalOrder());
    return values;
  }

  void addGrant(final String grantor, final String grantee, final boolean isGrantable) {
    if (!(isBlank(grantor) && isBlank(grantee))) {
      grants.add(new PrivilegeGrant(grantor, grantee, isGrantable));
    }
  }
}