com.aoindustries.aoserv.client.IpReputationLimiter 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  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;

import com.aoindustries.io.CompressedDataInputStream;
import com.aoindustries.io.CompressedDataOutputStream;
import java.io.IOException;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.List;

/**
 * An IpReputationLimiter rate-limits traffic by class and type.
 *
 * @author  AO Industries, Inc.
 */
final public class IpReputationLimiter extends CachedObjectIntegerKey {

	static final int
		COLUMN_PKEY=0,
		COLUMN_NET_DEVICE=1
	;

	static final String COLUMN_NET_DEVICE_name= "net_device";
	static final String COLUMN_IDENTIFIER_name= "identifier";

	int netDevice;
	private String identifier;
	private String description;

	@Override
	public SchemaTable.TableID getTableID() {
	return SchemaTable.TableID.IP_REPUTATION_LIMITERS;
	}

	@Override
	public void init(ResultSet result) throws SQLException {
		int pos = 1;
		pkey        = result.getInt(pos++);
		netDevice   = result.getInt(pos++);
		identifier  = result.getString(pos++);
		description = result.getString(pos++);
	}

	@Override
	public void write(CompressedDataOutputStream out, AOServProtocol.Version version) throws IOException {
		out.writeCompressedInt(pkey);
		out.writeCompressedInt(netDevice);
		out.writeUTF          (identifier);
		out.writeNullUTF      (description);
	}

	@Override
	public void read(CompressedDataInputStream in) throws IOException {
		pkey        = in.readCompressedInt();
		netDevice   = in.readCompressedInt();
		identifier  = in.readUTF();
		description = in.readNullUTF();
	}

	@Override
	Object getColumnImpl(int i) {
		switch(i) {
			case COLUMN_PKEY :       return pkey;
			case COLUMN_NET_DEVICE : return netDevice;
			case 2 :                 return identifier;
			case 3 :                 return description;
			default: throw new IllegalArgumentException("Invalid index: "+i);
		}
	}

	public NetDevice getNetDevice() throws SQLException, IOException {
		NetDevice nd = table.connector.getNetDevices().get(netDevice);
		if(nd==null) throw new SQLException("Unable to find NetDevice: " + netDevice);
		return nd;
	}

	/**
	 * Gets the per-net device unique identifier for this reputation limiter.
	 */
	public String getIdentifier() {
		return identifier;
	}

	/**
	 * Gets the optional description of the limiter.
	 */
	public String getDescription() {
		return description;
	}

	public List getLimits() throws IOException, SQLException {
		return table.connector.getIpReputationLimiterLimits().getLimits(this);
	}

	public List getSets() throws IOException, SQLException {
		return table.connector.getIpReputationLimiterSets().getSets(this);
	}
}