IpGroup.java

package edu.harvard.iq.dataverse.authorization.groups.impl.ipaddress;

import edu.harvard.iq.dataverse.authorization.groups.GroupProvider;
import edu.harvard.iq.dataverse.authorization.groups.impl.PersistedGlobalGroup;
import edu.harvard.iq.dataverse.authorization.groups.impl.ipaddress.ip.IPv4Address;
import edu.harvard.iq.dataverse.authorization.groups.impl.ipaddress.ip.IPv4Range;
import edu.harvard.iq.dataverse.authorization.groups.impl.ipaddress.ip.IPv6Range;
import edu.harvard.iq.dataverse.authorization.groups.impl.ipaddress.ip.IpAddress;
import edu.harvard.iq.dataverse.authorization.groups.impl.ipaddress.ip.IpAddressRange;
import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
import java.util.Collection;
import java.util.HashSet;
import java.util.Objects;
import java.util.Set;
import javax.persistence.CascadeType;
import javax.persistence.Entity;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.OneToMany;
import javax.persistence.Transient;

@NamedQueries({
    @NamedQuery(name="IpGroup.findAll",
               query="SELECT g FROM IpGroup g"),
    @NamedQuery(name="IpGroup.findByPersistedGroupAlias",
               query="SELECT g FROM IpGroup g WHERE g.persistedGroupAlias=:persistedGroupAlias")
})
@Entity
public class IpGroup extends PersistedGlobalGroup {
    
    @OneToMany(mappedBy = "owner", cascade=CascadeType.ALL, orphanRemoval = true)
    private Set<IPv6Range> ipv6Ranges;

    @OneToMany(mappedBy = "owner", cascade=CascadeType.ALL, orphanRemoval = true)
    private Set<IPv4Range> ipv4Ranges;
    
    @Transient
    private IpGroupProvider provider;
    
    public IpGroup() {}
    
    public IpGroup(IpGroupProvider provider) {
        this.provider = provider;
    }
    
    @Override
    public boolean contains( DataverseRequest rq ) {
        IpAddress addr = rq.getSourceAddress();
        if ( addr == null ) return false;
        
        for ( IpAddressRange r : ((addr instanceof IPv4Address) ? ipv4Ranges : ipv6Ranges) ) {
           Boolean containment =  r.contains(addr);
           if ( (containment != null) && containment ) {
               return true;
           }
        }
        return false;
    }
    
    public <T extends IpAddressRange> T add( T range ) {
        if ( ipv4Ranges==null ) ipv4Ranges = new HashSet<>();
        if ( ipv6Ranges==null ) ipv6Ranges = new HashSet<>();
        
        range.setOwner(this);
        if ( range instanceof IPv4Range ) {
            ipv4Ranges.add((IPv4Range) range);
        } else {
            ipv6Ranges.add((IPv6Range) range);
        }
        return range;
    }
    
    @SuppressWarnings("element-type-mismatch")
    public void remove( IpAddressRange range ) {
        ( (range instanceof IPv4Range) ? ipv4Ranges : ipv6Ranges ).remove(range);
    }
    
    @Override
    public boolean isEditable() {
        return true;
    }
    
    public void setGroupProvider( IpGroupProvider prv ) {
        provider = prv;
    }
    
    @Override
    public GroupProvider getGroupProvider() {
        return provider;
    }

    /**
     * Returns a <strong>read only</strong> set of all the ranges  in the group,
     * both IPv6 and IPv4.
     * @return 
     */
    public Set<IpAddressRange> getRanges() {
        Set<IpAddressRange> ranges = new HashSet<>();
        ranges.addAll( getIpv4Ranges() );
        ranges.addAll( getIpv6Ranges() );
        return ranges;
    }

    /**
     * Low-level JPA accessor
     * @return 
     * @see #getRanges() 
     */
    public Set<IPv6Range> getIpv6Ranges() {
        return ipv6Ranges;
    }

    /**
     * Low-level JPA accessor
     * @param ipv6Ranges 
     */
    public void setIpv6Ranges(Set<IPv6Range> ipv6Ranges) {
        this.ipv6Ranges = ipv6Ranges;
        updateRangeOwnership(ipv6Ranges);
    }
    /**
     * Low-level JPA accessor
     * @return 
     * @see #getRanges() 
     */
    public Set<IPv4Range> getIpv4Ranges() {
        return ipv4Ranges;
    }

    public void setIpv4Ranges(Set<IPv4Range> ipv4Ranges) {
        this.ipv4Ranges = ipv4Ranges;
        updateRangeOwnership(ipv4Ranges);
    }
    
    @Override
    public boolean equals( Object o ) {
        if ( o == null ) return false;
        if ( o == this ) return true;
        if ( ! (o instanceof IpGroup) ) return false;
        
        IpGroup other = (IpGroup) o;
        
        if ( ! Objects.equals(getId(), other.getId()) ) return false;
        if ( ! Objects.equals(getDescription(), other.getDescription()) ) return false;
        if ( ! Objects.equals(getDisplayName(), other.getDisplayName()) ) return false;
        if ( ! Objects.equals(getPersistedGroupAlias(), other.getPersistedGroupAlias()) ) return false;
        return getRanges().equals( other.getRanges() );
    }

    @Override
    public int hashCode() {
        return getPersistedGroupAlias().hashCode();
    }
    
    @Override
    public String toString() {
        return "[IpGroup alias:" + getPersistedGroupAlias() +" id:" + getId() + " ranges:" + getIpv4Ranges() + "," + getIpv6Ranges() + "]";
    }
    
    private void updateRangeOwnership( Collection<? extends IpAddressRange> ranges ) {
        for ( IpAddressRange rng : ranges ) {
            rng.setOwner(this);
        }
    }
}