RoleDefault.java

/**
 * This file is part of Waarp Project.
 * 
 * Copyright 2009, Frederic Bregier, and individual contributors by the @author tags. See the
 * COPYRIGHT.txt in the distribution for a full listing of individual contributors.
 * 
 * All Waarp Project is free software: you can redistribute it and/or modify it under the terms of
 * the GNU General Public License as published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 * 
 * Waarp 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 General
 * Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with Waarp . If not, see
 * <http://www.gnu.org/licenses/>.
 */
package org.waarp.common.role;

/**
 * Role to be used in Waarp projects
 * 
 * 
 * @author Frederic Bregier
 * 
 */
public class RoleDefault {
    public static enum ROLE {
        /**
         * No access to any function
         */
        NOACCESS(0),
        /**
         * Read only access, no action
         */
        READONLY(1),
        /**
         * Ability to starts transfer
         */
        TRANSFER(2),
        /**
         * Ability to control rules
         */
        RULE(4),
        /**
         * Ability to control hosts
         */
        HOST(8),
        /**
         * Ability to control bandwidth limitation
         */
        LIMIT(16),
        /**
         * Ability to control the system configuration and to control transfers
         */
        SYSTEM(32),
        /**
         * Ability to control the logging
         */
        LOGCONTROL(64),
        /**
         * Unused Role value
         */
        UNUSED(-128),
        /**
         * Default partner : ability to read and starts transfers
         */
        PARTNER(READONLY, TRANSFER),
        /**
         * Administrator on configuration (partner, rule, host)
         */
        CONFIGADMIN(PARTNER, RULE, HOST),
        /**
         * Administrator on all
         */
        FULLADMIN(CONFIGADMIN, LIMIT, SYSTEM, LOGCONTROL);

        private byte role;

        private ROLE(int val) {
            this.role = (byte) val;
        }

        private ROLE(ROLE... name) {
            for (ROLE role : name) {
                this.role |= role.role;
            }
        }

        public boolean isContained(byte value) {
            if (this == NOACCESS) {
                return value == NOACCESS.role;
            }
            return (value & role) == role;
        }

        public byte getAsByte() {
            return role;
        }

        public final static String toString(byte fromRole) {
            StringBuilder result = new StringBuilder("[ ");
            ROLE[] values = ROLE.values();
            for (ROLE role : values) {
                if (role.isContained(fromRole)) {
                    result.append(role.name()).append(' ');
                }
            }
            result.append(']');
            return result.toString();
        }

        public final static ROLE fromByte(byte role) {
            switch (role) {
                case 0:
                    return NOACCESS;
                case 1:
                    return READONLY;
                case 2:
                    return TRANSFER;
                case 4:
                    return RULE;
                case 8:
                    return HOST;
                case 16:
                    return LIMIT;
                case 32:
                    return SYSTEM;
                case 64:
                    return LOGCONTROL;
                case -128:
                    return UNUSED;
                default:
                    return NOACCESS;
            }
        }
    };

    private byte role;

    public RoleDefault() {
        this.role = ROLE.NOACCESS.role;
    }

    public RoleDefault(ROLE role) {
        this.role = role.role;
    }

    public byte getRoleAsByte() {
        return role;
    }

    @Override
    public String toString() {
        return ROLE.toString(role);
    }

    public RoleDefault addRole(ROLE newrole) {
        this.role |= newrole.role;
        return this;
    }

    public RoleDefault setRole(ROLE newrole) {
        this.role = newrole.role;
        return this;
    }

    public RoleDefault setRoleDefault(RoleDefault newrole) {
        this.role = newrole.role;
        return this;
    }

    public void clear() {
        this.role = ROLE.NOACCESS.role;
    }

    public boolean isContaining(ROLE otherrole) {
        return otherrole.isContained(role);
    }

    public boolean hasNoAccess() {
        return role == ROLE.NOACCESS.role;
    }

    public boolean hasReadOnly() {
        return ROLE.READONLY.isContained(role);
    }

    public boolean hasTransfer() {
        return ROLE.TRANSFER.isContained(role);
    }

    public boolean hasRule() {
        return ROLE.RULE.isContained(role);
    }

    public boolean hasHost() {
        return ROLE.HOST.isContained(role);
    }

    public boolean hasLimit() {
        return ROLE.LIMIT.isContained(role);
    }

    public boolean hasSystem() {
        return ROLE.SYSTEM.isContained(role);
    }

    public boolean hasUnused() {
        return ROLE.UNUSED.isContained(role);
    }

    public boolean hasLogControl() {
        return ROLE.LOGCONTROL.isContained(role);
    }

    public final static boolean hasNoAccess(byte role) {
        return role == ROLE.NOACCESS.role;
    }

    public final static boolean hasReadOnly(byte role) {
        return ROLE.READONLY.isContained(role);
    }

    public final static boolean hasTransfer(byte role) {
        return ROLE.TRANSFER.isContained(role);
    }

    public final static boolean hasRule(byte role) {
        return ROLE.RULE.isContained(role);
    }

    public final static boolean hasHost(byte role) {
        return ROLE.HOST.isContained(role);
    }

    public final static boolean hasLimit(byte role) {
        return ROLE.LIMIT.isContained(role);
    }

    public final static boolean hasSystem(byte role) {
        return ROLE.SYSTEM.isContained(role);
    }

    public final static boolean hasUnused(byte role) {
        return ROLE.UNUSED.isContained(role);
    }

    public final static boolean hasLogControl(byte role) {
        return ROLE.LOGCONTROL.isContained(role);
    }

}