com.enonic.xp.security.acl.AccessControlEntry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core-api Show documentation
core-api
There is a newer version: 7.14.4
package com.enonic.xp.security.acl;

import java.util.Arrays;
import java.util.EnumSet;
import java.util.Objects;

import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;

import com.enonic.xp.annotation.PublicApi;
import com.enonic.xp.security.PrincipalKey;

import static com.google.common.base.Preconditions.checkNotNull;

@PublicApi
public final class AccessControlEntry
{
    private final PrincipalKey principal;

    private final ImmutableSet allowedPermissions;

    private final ImmutableSet deniedPermissions;

    private AccessControlEntry( final Builder builder )
    {
        this.principal = checkNotNull( builder.principal, "ACE principal cannot be null" );
        this.allowedPermissions = Sets.immutableEnumSet( builder.allowedPermissions );
        this.deniedPermissions = Sets.immutableEnumSet( builder.deniedPermissions );
    }

    public PrincipalKey getPrincipal()
    {
        return principal;
    }

    public Iterable getAllowedPermissions()
    {
        return allowedPermissions;
    }

    public Iterable getDeniedPermissions()
    {
        return deniedPermissions;
    }

    public boolean isAllowed( final Permission permission )
    {
        return this.allowedPermissions.contains( permission );
    }

    public boolean isAllowed( final Permission... permissions )
    {
        return this.allowedPermissions.containsAll( Arrays.asList( permissions ) );
    }

    public boolean isDenied( final Permission... permissions )
    {
        return !this.isAllowed( permissions );
    }

    public boolean isSet( final Permission permission )
    {
        return this.allowedPermissions.contains( permission ) || this.deniedPermissions.contains( permission );
    }

    public boolean isAllowedAll()
    {
        return this.allowedPermissions.containsAll( Arrays.asList( Permission.values() ) );
    }

    @Override
    public String toString()
    {
        final StringBuilder sb = new StringBuilder( principal.toString() );
        sb.append( "[" );
        boolean empty = true;
        for ( Permission permission : Permission.values() )
        {
            if ( allowedPermissions.contains( permission ) )
            {
                if ( !empty )
                {
                    sb.append( ", " );
                }
                sb.append( "+" ).append( permission.toString().toLowerCase() );
                empty = false;
            }
            else if ( deniedPermissions.contains( permission ) )
            {
                if ( !empty )
                {
                    sb.append( ", " );
                }
                sb.append( "-" ).append( permission.toString().toLowerCase() );
                empty = false;
            }
        }
        sb.append( "]" );
        return sb.toString();
    }

    @Override
    public boolean equals( final Object o )
    {
        if ( this == o )
        {
            return true;
        }
        if ( !( o instanceof AccessControlEntry ) )
        {
            return false;
        }
        final AccessControlEntry that = (AccessControlEntry) o;

        if ( !principal.equals( that.principal ) )
        {
            return false;
        }
        if ( !allowedPermissions.equals( that.allowedPermissions ) )
        {
            return false;
        }
        return deniedPermissions.equals( that.deniedPermissions );
    }

    @Override
    public int hashCode()
    {
        return Objects.hash( principal, allowedPermissions, deniedPermissions );
    }

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

    public static Builder create( final AccessControlEntry ace )
    {
        return new Builder( ace );
    }

    public static class Builder
    {
        private PrincipalKey principal;

        private final EnumSet allowedPermissions;

        private final EnumSet deniedPermissions;

        private Builder()
        {
            this.allowedPermissions = EnumSet.noneOf( Permission.class );
            this.deniedPermissions = EnumSet.noneOf( Permission.class );
        }

        private Builder( final AccessControlEntry ace )
        {
            this.principal = ace.principal;
            this.allowedPermissions = EnumSet.copyOf( ace.allowedPermissions );
            this.deniedPermissions = EnumSet.copyOf( ace.deniedPermissions );
        }

        public Builder principal( final PrincipalKey principal )
        {
            this.principal = principal;
            return this;
        }

        public Builder allow( final Permission... permissions )
        {
            return allow( Arrays.asList( permissions ) );
        }

        public Builder allow( final Iterable permissions )
        {
            for ( final Permission permission : permissions )
            {
                this.deniedPermissions.remove( permission );
                this.allowedPermissions.add( permission );
            }
            return this;
        }

        public Builder deny( final Permission... permissions )
        {
            return deny( Arrays.asList( permissions ) );
        }

        public Builder deny( final Iterable permissions )
        {
            for ( Permission permission : permissions )
            {
                this.allowedPermissions.remove( permission );
                this.deniedPermissions.add( permission );
            }
            return this;
        }

        public Builder remove( final Permission permission )
        {
            this.allowedPermissions.remove( permission );
            this.deniedPermissions.remove( permission );
            return this;
        }

        public Builder allowAll()
        {
            for ( Permission permission : Permission.values() )
            {
                this.allow( permission );
            }
            return this;
        }

        public AccessControlEntry build()
        {
            return new AccessControlEntry( this );
        }
    }

}