com.aoindustries.aoserv.client.Resource 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) 2000-2009, 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 static com.aoindustries.aoserv.client.ApplicationResources.accessor;
import com.aoindustries.io.CompressedDataInputStream;
import com.aoindustries.io.CompressedDataOutputStream;
import java.io.IOException;
import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * A Resource is a measurable hardware resource.  A Package
 * comes with a set of resources, and when those PackageDefinitionLimits are exceeded,
 * an additional amount is charged to the Business.
 *
 * @see  Package
 *
 * @author  AO Industries, Inc.
 */
final public class Resource extends GlobalObjectStringKey {

	static final int COLUMN_NAME=0;
	static final String COLUMN_NAME_name = "name";

	public static final String
		AOSERV_DAEMON="aoserv_daemon",
		AOSERV_MASTER="aoserv_master",
		BANDWIDTH="bandwidth",
		CONSULTING="consulting",
		DISK="disk",
		DISTRIBUTION_SCAN="distribution_scan",
		DRUPAL="drupal",
		EMAIL="email",
		FAILOVER="failover",
		HARDWARE_DISK_7200_120="hardware_disk_7200_120",
		HTTPD="httpd",
		IP="ip",
		JAVAVM="javavm",
		JOOMLA="joomla",
		MYSQL_REPLICATION="mysql_replication",
		RACK="rack",
		SERVER_DATABASE="server_database",
		SERVER_ENTERPRISE="server_enterprise",
		SERVER_P4="server_p4",
		SERVER_SCSI="server_scsi",
		SERVER_XEON="server_xeon",
		SITE="site",
		SYSADMIN="sysadmin",
		USER="user"
	;

	@Override
	Object getColumnImpl(int i) {
		switch(i) {
			case COLUMN_NAME: return pkey;
			default: throw new IllegalArgumentException("Invalid index: "+i);
		}
	}

	/**
	 * Gets the unique name of this resource.
	 */
	public String getName() {
		return pkey;
	}

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

	public String getDisplayUnit(int quantity) {
		if(quantity==1) return accessor.getMessage("Resource."+pkey+".singularDisplayUnit", quantity);
		else return accessor.getMessage("Resource."+pkey+".pluralDisplayUnit", quantity);
	}

	public String getPerUnit(Object amount) {
		return accessor.getMessage("Resource."+pkey+".perUnit", amount);
	}

	@Override
	public void init(ResultSet result) throws SQLException {
		pkey = result.getString(1);
	}

	@Override
	public void read(CompressedDataInputStream in) throws IOException {
		pkey=in.readUTF().intern();
	}

	@Override
	String toStringImpl() {
		return accessor.getMessage("Resource."+pkey+".toString");
	}

	@Override
	public void write(CompressedDataOutputStream out, AOServProtocol.Version version) throws IOException {
		out.writeUTF(pkey);
		if(version.compareTo(AOServProtocol.Version.VERSION_1_60)<=0) {
			out.writeUTF(accessor.getMessage("Resource."+pkey+".singularDisplayUnit", ""));
		}
		if(version.compareTo(AOServProtocol.Version.VERSION_1_0_A_123)>=0 && version.compareTo(AOServProtocol.Version.VERSION_1_60)<=0) {
			out.writeUTF(accessor.getMessage("Resource."+pkey+".pluralDisplayUnit", ""));
			out.writeUTF(getPerUnit(""));
		}
		if(version.compareTo(AOServProtocol.Version.VERSION_1_60)<=0) out.writeUTF(toString()); // description
	}
}