com.aoindustries.aoserv.client.net.reputation.LimiterClass Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aoserv-client Show documentation
Java client for the AOServ Platform.
There is a newer version: 1.92.0
/*
 * aoserv-client - Java client for the AOServ Platform.
 * Copyright (C) 2012, 2016, 2017, 2018, 2019  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of aoserv-client.
 *
 * aoserv-client is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * aoserv-client 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.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with aoserv-client.  If not, see .
 */
package com.aoindustries.aoserv.client.net.reputation;

import com.aoindustries.aoserv.client.CachedObjectIntegerKey;
import com.aoindustries.aoserv.client.schema.AoservProtocol;
import com.aoindustries.aoserv.client.schema.Table;
import com.aoindustries.io.stream.StreamableInput;
import com.aoindustries.io.stream.StreamableOutput;
import java.io.IOException;
import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * The limit for one class of a IpReputationLimiter.
 *
 * @author  AO Industries, Inc.
 */
final public class LimiterClass extends CachedObjectIntegerKey {

	static final int
		COLUMN_PKEY    = 0,
		COLUMN_LIMITER = 1
	;
	static final String
		COLUMN_LIMITER_name = "limiter",
		COLUMN_CLASS_name = "class"
	;

	/**
	 * The set of possible units
	 */
	// Matches aoserv-master-db/aoindustries/net/reputation/LimiterClass.TimeUnit-type.sql
	public enum TimeUnit {
		second,
		minute,
		hour,
		day
	}

			int          limiter;
	private Class clazz;
	private short        synPerIpBurst;
	private short        synPerIpRate;
	private TimeUnit     synPerIpUnit;
	private short        synPerIpSize;
	private short        synBurst;
	private short        synRate;
	private TimeUnit     synUnit;
	private int          packetPerIpBurst;
	private int          packetPerIpRate;
	private TimeUnit     packetPerIpUnit;
	private int          packetPerIpSize;
	private int          packetBurst;
	private int          packetRate;
	private TimeUnit     packetUnit;

	@Override
	public Table.TableID getTableID() {
		return Table.TableID.IP_REPUTATION_LIMITER_LIMITS;
	}

	@Override
	public void init(ResultSet result) throws SQLException {
		int pos = 1;
		pkey             = result.getInt(pos++);
		limiter          = result.getInt(pos++);
		clazz            = Class.valueOf(result.getString(pos++));
		synPerIpBurst    = result.getShort(pos++);
		synPerIpRate     = result.getShort(pos++);
		synPerIpUnit     = TimeUnit.valueOf(result.getString(pos++));
		synPerIpSize     = result.getShort(pos++);
		synBurst         = result.getShort(pos++);
		synRate          = result.getShort(pos++);
		synUnit          = TimeUnit.valueOf(result.getString(pos++));
		packetPerIpBurst = result.getInt(pos++);
		packetPerIpRate  = result.getInt(pos++);
		packetPerIpUnit  = TimeUnit.valueOf(result.getString(pos++));
		packetPerIpSize  = result.getInt(pos++);
		packetBurst      = result.getInt(pos++);
		packetRate       = result.getInt(pos++);
		packetUnit       = TimeUnit.valueOf(result.getString(pos++));
	}

	@Override
	public void write(StreamableOutput out, AoservProtocol.Version protocolVersion) throws IOException {
		out.writeCompressedInt(pkey);
		out.writeCompressedInt(limiter);
		out.writeUTF          (clazz.name());
		out.writeShort        (synPerIpBurst);
		out.writeShort        (synPerIpRate);
		out.writeUTF          (synPerIpUnit.name());
		out.writeShort        (synPerIpSize);
		out.writeShort        (synBurst);
		out.writeShort        (synRate);
		out.writeUTF          (synUnit.name());
		out.writeInt          (packetPerIpBurst);
		out.writeInt          (packetPerIpRate);
		out.writeUTF          (packetPerIpUnit.name());
		out.writeInt          (packetPerIpSize);
		out.writeInt          (packetBurst);
		out.writeInt          (packetRate);
		out.writeUTF          (packetUnit.name());
	}

	@Override
	public void read(StreamableInput in, AoservProtocol.Version protocolVersion) throws IOException {
		pkey             = in.readCompressedInt();
		limiter          = in.readCompressedInt();
		clazz            = Class.valueOf(in.readUTF());
		synPerIpBurst    = in.readShort();
		synPerIpRate     = in.readShort();
		synPerIpUnit     = TimeUnit.valueOf(in.readUTF());
		synPerIpSize     = in.readShort();
		synBurst         = in.readShort();
		synRate          = in.readShort();
		synUnit          = TimeUnit.valueOf(in.readUTF());
		packetPerIpBurst = in.readInt();
		packetPerIpRate  = in.readInt();
		packetPerIpUnit  = TimeUnit.valueOf(in.readUTF());
		packetPerIpSize  = in.readInt();
		packetBurst      = in.readInt();
		packetRate       = in.readInt();
		packetUnit       = TimeUnit.valueOf(in.readUTF());
	}

	@Override
	protected Object getColumnImpl(int i) {
		switch(i) {
			case COLUMN_PKEY     : return pkey;
			case COLUMN_LIMITER  : return limiter;
			case 2               : return clazz.name();
			case 3               : return synPerIpBurst;
			case 4               : return synPerIpRate;
			case 5               : return synPerIpUnit.name();
			case 6               : return synPerIpSize;
			case 7               : return synBurst;
			case 8               : return synRate;
			case 9               : return synUnit.name();
			case 10              : return packetPerIpBurst;
			case 11              : return packetPerIpRate;
			case 12              : return packetPerIpUnit.name();
			case 13              : return packetPerIpSize;
			case 14              : return packetBurst;
			case 15              : return packetRate;
			case 16              : return packetUnit.name();
			default: throw new IllegalArgumentException("Invalid index: " + i);
		}
	}

	public Limiter getLimiter() throws SQLException, IOException {
		Limiter obj = table.getConnector().getNet().getReputation().getLimiter().get(limiter);
		if(obj==null) throw new SQLException("Unable to find IpReputationLimiter: " + limiter);
		return obj;
	}

	/**
	 * Gets the class of this limit.
	 */
	public Class getLimiterClass() {
		return clazz;
	}

	public short getSynPerIpBurst() {
		return synPerIpBurst;
	}

	public short getSynPerIpRate() {
		return synPerIpRate;
	}

	public TimeUnit getSynPerIpUnit() {
		return synPerIpUnit;
	}

	public short getSynPerIpSize() {
		return synPerIpSize;
	}

	public short getSynBurst() {
		return synBurst;
	}

	public short getSynRate() {
		return synRate;
	}

	public TimeUnit getSynUnit() {
		return synUnit;
	}

	public int getPacketPerIpBurst() {
		return packetPerIpBurst;
	}

	public int getPacketPerIpRate() {
		return packetPerIpRate;
	}

	public TimeUnit getPacketPerIpUnit() {
		return packetPerIpUnit;
	}

	public int getPacketPerIpSize() {
		return packetPerIpSize;
	}

	public int getPacketBurst() {
		return packetBurst;
	}

	public int getPacketRate() {
		return packetRate;
	}

	public TimeUnit getPacketUnit() {
		return packetUnit;
	}
}