# BitFlagsRights.java

    /*
    ** Module   : BitFlagsRights.java
    ** Abstract : Implements the Rights interface for the "bitflags" abstract resource.
    **
    ** Copyright (c) 2005-2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ------------------------------Description------------------------------------
    ** 001 GES 20200115 First version based on the NetRights implementation.
    ** 002 HC  20230427 Implemented management for file-system resource. This includes Admin and
    **                  server directory changes.
    */

    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program 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.  See the
    ** GNU Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */

    package com.goldencode.p2j.security;

    import java.io.*;
    import java.util.*;

    /**
     * Implements the "bitflags" rights object.  A "bitflags" resource is anything that can be
     * effectively protected using a bitset with the following 5 perms: C (create), D (delete),
     * R (read), W (write) and N (denied or no access).
     */
    public class BitFlagsRights
    implements Rights,
               Serializable,
               BitFlagsConstants
    {
       /* Stores the perms for this instance. */
       protected BitSet perms = null;

       /**
        * Default constructor.
        */
       public BitFlagsRights()
       {
          perms = new BitSet(BITSET_SIZE);
          // unset all bits
          for (int i = 0; i < BITSET_SIZE; i++)
          {
             perms.unset(i);
          }
       }

       /**
        * Constructor which initializes the permissions from the given argument.
        *
        * @param    perms
        *           Bitfield of perms (CDRWN).
        */
       public BitFlagsRights(BitSet perms)
       {
          this.perms = perms;
       }

       /**
        * Gets the value (set or unset) of the indexed bit in the stored permissons.
        *
        * @param    index
        *           The index of the permissons bit to query.
        *
        * @return   {@code true} if the indexed bit is set.
        */
       public boolean get(int index)
       {
          return perms.isSet(index);
       }

       /**
        * Gets the entire set of permissions.
        *
        * @return   All permissions as a <code>BitSet</code>.
        */
       public BitSet getPermissions()
       {
          return perms;
       }

       /**
        * Converts this object into a string.
        *
        * @return   The string representation of this object.
        */
       public String toString()
       {
          StringBuilder sb = new StringBuilder();

          sb.append("{");

          if (perms.isSet(BIT_CREATE_ACCESS))
          {
             sb.append("C");
          }
          else
          {
             sb.append(".");
          }

          if (perms.isSet(BIT_DELETE_ACCESS))
          {
             sb.append("D");
          }
          else
          {
             sb.append(".");
          }

          if (perms.isSet(BIT_READ_ACCESS))
          {
             sb.append("R");
          }
          else
          {
             sb.append(".");
          }

          if (perms.isSet(BIT_WRITE_ACCESS))
          {
             sb.append("W");
          }
          else
          {
             sb.append(".");
          }

          // render the reserved bits
          sb.append("...");

          if (perms.isSet(BIT_DENIED_ACCESS))
          {
             sb.append("N");
          }
          else
          {
             sb.append(".");
          }

          sb.append("}");

          return new String(sb);
       }

       /**
        * Returns rights name that is registered in the directory.
        *
        * @return   A class name that is registered in the directory.
        */
       @Override
       public String getRightsName()
       {
          return "bitFlagsRights";
       }

       /**
        * Returns its attributes map.
        *
        * @return   A map of an attribute name to its value.
        */
       @Override
       public Map<String, Object[]> getAttributes()
       {
          Map<String, Object[]> map = new LinkedHashMap<>(1);

          map.put("permissions", new Object[] {perms});

          return map;
       }
    }