/*!
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* 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 Lesser General Public License for more details.
*
* Copyright (c) 2002-2013 Pentaho Corporation.. All rights reserved.
*/
package org.pentaho.platform.api.repository2.unified;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.EnumSet;
import java.util.List;
/**
* Immutable access control list (ACL). Use the {@link Builder} to create instances.
*
* @author mlowery
*/
public class RepositoryFileAcl implements Serializable {
// ~ Static fields/initializers
// ======================================================================================
private static final long serialVersionUID = 6661340152568187033L;
// ~ Instance fields
// =================================================================================================
private final List<RepositoryFileAce> aces;
private final Serializable id;
private final RepositoryFileSid owner;
private final boolean entriesInheriting;
// ~ Constructors
// ====================================================================================================
public RepositoryFileAcl( Serializable id, RepositoryFileSid owner, boolean entriesInheriting,
List<RepositoryFileAce> aces ) {
super();
notNull( owner );
notNull( aces );
this.id = id;
this.owner = owner;
this.entriesInheriting = entriesInheriting;
this.aces = new ArrayList<RepositoryFileAce>( aces );
}
// ~ Methods
// =========================================================================================================
private void notNull( final Object obj ) {
if ( obj == null ) {
throw new IllegalArgumentException();
}
}
public List<RepositoryFileAce> getAces() {
return Collections.unmodifiableList( aces );
}
public Serializable getId() {
return id;
}
public RepositoryFileSid getOwner() {
return owner;
}
public boolean isEntriesInheriting() {
return entriesInheriting;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ( ( aces == null ) ? 0 : aces.hashCode() );
result = prime * result + ( entriesInheriting ? 1231 : 1237 );
result = prime * result + ( ( id == null ) ? 0 : id.hashCode() );
result = prime * result + ( ( owner == null ) ? 0 : owner.hashCode() );
return result;
}
@Override
public boolean equals( Object obj ) {
if ( this == obj ) {
return true;
}
if ( obj == null ) {
return false;
}
if ( getClass() != obj.getClass() ) {
return false;
}
RepositoryFileAcl other = (RepositoryFileAcl) obj;
if ( aces == null ) {
if ( other.aces != null ) {
return false;
}
} else if ( !aces.equals( other.aces ) ) {
return false;
}
if ( entriesInheriting != other.entriesInheriting ) {
return false;
}
if ( id == null ) {
if ( other.id != null ) {
return false;
}
} else if ( !id.equals( other.id ) ) {
return false;
}
if ( owner == null ) {
if ( other.owner != null ) {
return false;
}
} else if ( !owner.equals( other.owner ) ) {
return false;
}
return true;
}
@Override
public String toString() {
return "RepositoryFileAcl [id=" + id + ", owner=" + owner + ", entriesInheriting=" + entriesInheriting + ", aces=" //$NON-NLS-1$ //$NON-NLS-2$//$NON-NLS-3$ //$NON-NLS-4$
+ aces + "]"; //$NON-NLS-1$
}
// ~ Inner classes
// ===================================================================================================
public static class Builder {
private List<RepositoryFileAce> aces = new ArrayList<RepositoryFileAce>();
private Serializable id;
private RepositoryFileSid owner;
private boolean entriesInheriting = true;
/**
* Creates a {@code Builder} where the {@code owner} is a {@code RepositoryFileSid.Type.USER}.
*
* @param owner
*/
public Builder( final String owner ) {
this( new RepositoryFileSid( owner ) );
}
public Builder( final RepositoryFileSid owner ) {
this( (Serializable) null, owner );
}
public Builder( final Serializable id, final RepositoryFileSid owner ) {
this.id = id;
this.owner = owner;
}
public Builder( final String name, final RepositoryFileSid.Type type ) {
this( null, new RepositoryFileSid( name, type ) );
}
public Builder( final Serializable id, final String name, final RepositoryFileSid.Type type ) {
this( id, new RepositoryFileSid( name, type ) );
}
public Builder( final RepositoryFileAcl other ) {
this( other.id, other.owner );
this.entriesInheriting( other.entriesInheriting );
for ( RepositoryFileAce ace : other.aces ) {
this.ace( ace );
}
}
public RepositoryFileAcl build() {
return new RepositoryFileAcl( id, owner, this.entriesInheriting, this.aces );
}
public Builder entriesInheriting( final boolean entriesInheriting1 ) {
this.entriesInheriting = entriesInheriting1;
return this;
}
public Builder id( final Serializable id1 ) {
this.id = id1;
return this;
}
public Builder owner( final RepositoryFileSid owner1 ) {
this.owner = owner1;
return this;
}
/**
* Entries inheriting is set to false when this method is called.
*/
public Builder ace( final RepositoryFileAce ace1 ) {
entriesInheriting( false );
this.aces.add( ace1 );
return this;
}
/**
* Entries inheriting is set to false when this method is called.
*/
public Builder ace( final RepositoryFileSid recipient, final RepositoryFilePermission first,
final RepositoryFilePermission... rest ) {
return ace( new RepositoryFileAce( recipient, EnumSet.of( first, rest ) ) );
}
/**
* Entries inheriting is set to false when this method is called.
*/
public Builder ace( final RepositoryFileSid recipient, final EnumSet<RepositoryFilePermission> permissions ) {
return ace( new RepositoryFileAce( recipient, permissions ) );
}
/**
* Entries inheriting is set to false when this method is called.
*/
public Builder ace( final String name, final RepositoryFileSid.Type type, final RepositoryFilePermission first,
final RepositoryFilePermission... rest ) {
return ace( new RepositoryFileAce( new RepositoryFileSid( name, type ), EnumSet.of( first, rest ) ) );
}
/**
* Entries inheriting is set to false when this method is called.
*/
public Builder ace( final String name, final RepositoryFileSid.Type type,
final EnumSet<RepositoryFilePermission> permissions ) {
return ace( new RepositoryFileAce( new RepositoryFileSid( name, type ), permissions ) );
}
/**
* Replaces the ACEs with the given ACEs. Entries inheriting is set to false when this method is called.
*/
public Builder aces( final List<RepositoryFileAce> aces1 ) {
clearAces();
entriesInheriting( false );
this.aces.addAll( aces1 );
return this;
}
public Builder clearAces() {
this.aces.clear();
return this;
}
}
}