ReplicatedPermissionsContainer.java 2.73 KB
package net.eq2online.permissions;

import java.io.*;
import java.util.Collection;
import java.util.Set;
import java.util.TreeSet;

/**
 * Serializable container object
 * 
 * @author Adam Mummery-Smith
 */
public class ReplicatedPermissionsContainer implements Serializable
{
	/**
	 * Serial version UID to suppoer Serializable interface 
	 */
	private static final long serialVersionUID = -764940324881984960L;
	
	/**
	 * Mod name
	 */
	public String modName = "all";
	
	/**
	 * Mod version
	 */
	public Float modVersion = 0.0F;

	/**
	 * List of permissions to replicate, prepend "-" for a negated permission and "+" for a granted permission
	 */
	public Set<String> permissions = new TreeSet<String>();
	
	/**
	 * Amount of time in seconds that the client will trust these permissions for before requesting an update 
	 */
	public long remoteCacheTimeSeconds = 600L;	// 10 minutes
	
	public static final String CHANNEL = "PERMISSIONSREPL";
	
	public ReplicatedPermissionsContainer()
	{
	}
	
	public ReplicatedPermissionsContainer(String modName, Float modVersion, Collection<String> permissions)
	{
		this.modName = modName;
		this.modVersion = modVersion;
		this.permissions.addAll(permissions);
	}
	
	/**
	 * Add all of the listed permissions to this container
	 * 
	 * @param permissions
	 */
	public void addAll(Collection<String> permissions)
	{
		this.permissions.addAll(permissions);
	}

	/**
	 * Check and correct  
	 */
	public void sanitise()
	{
		if (this.modName == null || this.modName.length() < 1) this.modName = "all";
		if (this.modVersion == null || this.modVersion < 0.0F) this.modVersion = 0.0F;
		if (this.remoteCacheTimeSeconds < 0) this.remoteCacheTimeSeconds = 600L;
	}

	/**
	 * Serialise this container to a byte array for transmission to a remote host
	 * 
	 * @return
	 */
	public byte[] getBytes()
	{
		try
		{
			ByteArrayOutputStream byteStream = new ByteArrayOutputStream();
			new ObjectOutputStream(byteStream).writeObject(this);
			return byteStream.toByteArray();
		}
		catch (IOException e) {}
		
		return new byte[0];
	}
	
	/**
	 * Deserialises a replicated permissions container from a byte array
	 * 
	 * @param data Byte array containing the serialised data
	 * @return new container or null if deserialisation failed
	 */
	public static ReplicatedPermissionsContainer fromBytes(byte[] data)
	{
		try
		{
			ObjectInputStream inputStream = new ObjectInputStream(new ByteArrayInputStream(data));
			ReplicatedPermissionsContainer object = (ReplicatedPermissionsContainer)inputStream.readObject();
			return object;
		}
		catch (IOException e) { }
		catch (ClassNotFoundException e) { }
		catch (ClassCastException e) { }
		
		return null;
	}
}