com.aoindustries.aoserv.client.NetDevice 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) 2001-2013, 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.aoserv.client.validator.InetAddress;
import com.aoindustries.aoserv.client.validator.ValidationException;
import com.aoindustries.io.CompressedDataInputStream;
import com.aoindustries.io.CompressedDataOutputStream;
import com.aoindustries.lang.ObjectUtils;
import com.aoindustries.util.InternUtils;
import java.io.IOException;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;

/**
 * Each server has multiple network devices, each listening on different
 * IP addresses.
 *
 * @author  AO Industries, Inc.
 */
final public class NetDevice extends CachedObjectIntegerKey {

	static final int
		COLUMN_PKEY=0,
		COLUMN_SERVER=1
	;
	static final String COLUMN_SERVER_name = "server";
	static final String COLUMN_DEVICE_ID_name = "device_id";

	int server;
	String device_id;
	private String description;
	private String delete_route;
	private InetAddress gateway;
	private InetAddress network;
	private InetAddress broadcast;
	private String mac_address;
	private long max_bit_rate;
	private long monitoring_bit_rate_low;
	private long monitoring_bit_rate_medium;
	private long monitoring_bit_rate_high;
	private long monitoring_bit_rate_critical;
	private boolean monitoring_enabled;

	@Override
	Object getColumnImpl(int i) {
		switch(i) {
			case COLUMN_PKEY: return pkey;
			case COLUMN_SERVER: return server;
			case 2: return device_id;
			case 3: return description;
			case 4: return delete_route;
			case 5: return gateway;
			case 6: return network;
			case 7: return broadcast;
			case 8: return mac_address;
			case 9: return max_bit_rate==-1 ? null : max_bit_rate;
			case 10: return monitoring_bit_rate_low==-1 ? null : monitoring_bit_rate_low;
			case 11: return monitoring_bit_rate_medium==-1 ? null : monitoring_bit_rate_medium;
			case 12: return monitoring_bit_rate_high==-1 ? null : monitoring_bit_rate_high;
			case 13: return monitoring_bit_rate_critical==-1 ? null : monitoring_bit_rate_critical;
			case 14: return monitoring_enabled;
			default: throw new IllegalArgumentException("Invalid index: "+i);
		}
	}

	public String getDeleteRoute() {
		return delete_route;
	}

	public String getDescription() {
		return description;
	}

	public InetAddress getGateway() {
		return gateway;
	}

	public IPAddress getIPAddress(InetAddress ipAddress) throws IOException, SQLException {
		return table.connector.getIpAddresses().getIPAddress(this, ipAddress);
	}

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

	public NetDeviceID getNetDeviceID() throws SQLException, IOException {
		NetDeviceID ndi=table.connector.getNetDeviceIDs().get(device_id);
		if(ndi==null) throw new SQLException("Unable to find NetDeviceID: "+device_id);
		return ndi;
	}

	public InetAddress getNetwork() {
		return network;
	}

	public InetAddress getBroadcast() {
		return broadcast;
	}

	public String getMacAddress() {
		return mac_address;
	}

	/**
	 * Gets the maximum bit rate this interface can support or -1
	 * if unknown.
	 */
	public long getMaxBitRate() {
		return max_bit_rate;
	}

	/**
	 * Gets the 5-minute average that is considered a low-priority alert or
	 * -1 if no alert allowed at this level.
	 */
	public long getMonitoringBitRateLow() {
		return monitoring_bit_rate_low;
	}

	/**
	 * Gets the 5-minute average that is considered a medium-priority alert or
	 * -1 if no alert allowed at this level.
	 */
	public long getMonitoringBitRateMedium() {
		return monitoring_bit_rate_medium;
	}

	/**
	 * Gets the 5-minute average that is considered a high-priority alert or
	 * -1 if no alert allowed at this level.
	 */
	public long getMonitoringBitRateHigh() {
		return monitoring_bit_rate_high;
	}

	/**
	 * Gets the 5-minute average that is considered a critical-priority alert or
	 * -1 if no alert allowed at this level.  This is the level
	 * that will alert people 24x7.
	 */
	public long getMonitoringBitRateCritical() {
		return monitoring_bit_rate_critical;
	}

	/**
	 * The monitoring of a net_devices may be enabled or disabled.
	 */
	public boolean isMonitoringEnabled() {
		return monitoring_enabled;
	}

	public IPAddress getPrimaryIPAddress() throws SQLException, IOException {
		List ips=getIPAddresses();
		List matches=new ArrayList<>();
		for (IPAddress ip : ips) {
			if(!ip.isAlias()) matches.add(ip);
		}
		if(matches.isEmpty()) throw new SQLException("Unable to find primary IPAddress for NetDevice: "+device_id+" on "+server);
		if(matches.size()>1) throw new SQLException("Found more than one primary IPAddress for NetDevice: "+device_id+" on "+server);
		return matches.get(0);
	}

	public Server getServer() throws SQLException, IOException {
		Server se=table.connector.getServers().get(server);
		if(se==null) throw new SQLException("Unable to find Server: "+server);
		return se;
	}

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

	@Override
	public void init(ResultSet result) throws SQLException {
		try {
			int pos = 1;
			pkey=result.getInt(pos++);
			server=result.getInt(pos++);
			device_id=result.getString(pos++);
			description=result.getString(pos++);
			delete_route=result.getString(pos++);
			gateway=InetAddress.valueOf(result.getString(pos++));
			network=InetAddress.valueOf(result.getString(pos++));
			broadcast=InetAddress.valueOf(result.getString(pos++));
			mac_address=result.getString(pos++);
			max_bit_rate=result.getLong(pos++);
			if(result.wasNull()) max_bit_rate=-1;
			monitoring_bit_rate_low = result.getLong(pos++);
			if(result.wasNull()) monitoring_bit_rate_low = -1;
			monitoring_bit_rate_medium = result.getLong(pos++);
			if(result.wasNull()) monitoring_bit_rate_medium = -1;
			monitoring_bit_rate_high = result.getLong(pos++);
			if(result.wasNull()) monitoring_bit_rate_high = -1;
			monitoring_bit_rate_critical = result.getLong(pos++);
			if(result.wasNull()) monitoring_bit_rate_critical = -1;
			monitoring_enabled = result.getBoolean(pos++);
		} catch(ValidationException e) {
			throw new SQLException(e);
		}
	}

	@Override
	public void read(CompressedDataInputStream in) throws IOException {
		try {
			pkey=in.readCompressedInt();
			server=in.readCompressedInt();
			device_id=in.readUTF().intern();
			description=in.readUTF();
			delete_route=InternUtils.intern(in.readNullUTF());
			gateway=InternUtils.intern(InetAddress.valueOf(in.readNullUTF()));
			network=InternUtils.intern(InetAddress.valueOf(in.readNullUTF()));
			broadcast=InternUtils.intern(InetAddress.valueOf(in.readNullUTF()));
			mac_address=in.readNullUTF();
			max_bit_rate=in.readLong();
			monitoring_bit_rate_low = in.readLong();
			monitoring_bit_rate_medium = in.readLong();
			monitoring_bit_rate_high = in.readLong();
			monitoring_bit_rate_critical = in.readLong();
			monitoring_enabled = in.readBoolean();
		} catch(ValidationException e) {
			throw new IOException(e);
		}
	}

	@Override
	String toStringImpl() throws SQLException, IOException {
		return getServer().toStringImpl()+'|'+device_id;
	}

	@Override
	public void write(CompressedDataOutputStream out, AOServProtocol.Version version) throws IOException {
		out.writeCompressedInt(pkey);
		out.writeCompressedInt(server);
		out.writeUTF(device_id);
		out.writeUTF(description);
		out.writeNullUTF(delete_route);
		out.writeNullUTF(ObjectUtils.toString(gateway));
		if(version.compareTo(AOServProtocol.Version.VERSION_1_37)<=0) out.writeUTF("255.255.255.0");
		if(version.compareTo(AOServProtocol.Version.VERSION_1_0_A_112)>=0) {
			out.writeNullUTF(ObjectUtils.toString(network));
			out.writeNullUTF(ObjectUtils.toString(broadcast));
		}
		if(version.compareTo(AOServProtocol.Version.VERSION_1_0_A_128)>=0) {
			out.writeNullUTF(mac_address);
		}
		if(version.compareTo(AOServProtocol.Version.VERSION_1_2)>=0) {
			out.writeLong(max_bit_rate);
		}
		if(version.compareTo(AOServProtocol.Version.VERSION_1_35)>=0) {
			out.writeLong(monitoring_bit_rate_low);
			out.writeLong(monitoring_bit_rate_medium);
			out.writeLong(monitoring_bit_rate_high);
			out.writeLong(monitoring_bit_rate_critical);
		}
		if(version.compareTo(AOServProtocol.Version.VERSION_1_70)>=0) {
			out.writeBoolean(monitoring_enabled);
		}
	}

	/**
	 * Gets the bonding report from /proc/net/bonding/[p]bond#
	 * or null if not a bonded device.
	 */
	public String getBondingReport() throws IOException, SQLException {
		if(!device_id.startsWith("bond")) return null;
		return table.connector.requestStringQuery(true, AOServProtocol.CommandID.GET_NET_DEVICE_BONDING_REPORT, pkey);
	}

	/**
	 * Gets the report from /sys/class/net/device/statistics/...
	 * or null if not an AOServer.
	 */
	public String getStatisticsReport() throws IOException, SQLException {
		return table.connector.requestStringQuery(true, AOServProtocol.CommandID.GET_NET_DEVICE_STATISTICS_REPORT, pkey);
	}
}