com.aoindustries.aoserv.client.Protocol 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-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.io.CompressedDataInputStream;
import com.aoindustries.io.CompressedDataOutputStream;
import java.io.IOException;
import java.sql.ResultSet;
import java.sql.SQLException;

/**
 * A Protocol represents one type of application
 * protocol used in NetBinds.  Monitoring is performed
 * in protocol-specific ways.
 *
 * @see  NetBind
 *
 * @author  AO Industries, Inc.
 */
final public class Protocol extends GlobalObjectStringKey {

	static final int COLUMN_PROTOCOL=0;
	static final String COLUMN_PORT_name = "port";
	static final String COLUMN_NET_PROTOCOL_name = "net_protocol";

	private int port;
	private String name;
	private boolean is_user_service;
	private String net_protocol;

	public static final String
		AOSERV_DAEMON="aoserv-daemon",
		AOSERV_DAEMON_SSL="aoserv-daemon-ssl",
		AOSERV_MASTER="aoserv-master",
		AOSERV_MASTER_SSL="aoserv-master-ssl",
		AUTH="auth",
		CVSPSERVER="cvspserver",
		DNS="DNS",
		FTP="FTP",
		FTP_DATA="FTP-DATA",
		HTTP="HTTP",
		HTTPS="HTTPS",
		HYPERSONIC="hypersonic",
		IMAP2="IMAP2",
		JMX="JMX",
		JNP="JNP",
		MILTER="milter",
		MYSQL="MySQL",
		NTALK="ntalk",
		POP3="POP3",
		POSTGRESQL="PostgreSQL",
		RMI="RMI",
		SIEVE="sieve",
		SIMAP="SIMAP",
		SPOP3="SPOP3",
		SSH="SSH",
		SMTP="SMTP",
		SMTPS="SMTPS",
		SUBMISSION="submission",
		TALK="talk",
		TELNET="Telnet",
		TOMCAT4_SHUTDOWN="tomcat4-shutdown",
		WEBSERVER="webserver"
	;

	@Override
	Object getColumnImpl(int i) {
		switch(i) {
			case COLUMN_PROTOCOL: return pkey;
			case 1: return port;
			case 2: return name;
			case 3: return is_user_service;
			case 4: return net_protocol;
			default: throw new IllegalArgumentException("Invalid index: "+i);
		}
	}

	public HttpdJKProtocol getHttpdJKProtocol(AOServConnector connector) throws IOException, SQLException {
		return connector.getHttpdJKProtocols().get(pkey);
	}

	public String getName() {
		return name;
	}

	public boolean isUserService() {
		return is_user_service;
	}

	public NetProtocol getNetProtocol(AOServConnector connector) throws SQLException, IOException {
		NetProtocol np=connector.getNetProtocols().get(net_protocol);
		if(np==null) throw new SQLException("Unable to find NetProtocol: "+net_protocol);
		return np;
	}

	public NetPort getPort(AOServConnector connector) throws SQLException {
		NetPort obj=connector.getNetPorts().get(port);
		if(obj==null) throw new SQLException("Unable to find NetPort: "+port);
		return obj;
	}

	/**
	 * Gets the unique name of the protocol.
	 */
	public String getProtocol() {
		return pkey;
	}

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

	@Override
	public void init(ResultSet result) throws SQLException {
		pkey = result.getString(1);
		port = result.getInt(2);
		name = result.getString(3);
		is_user_service = result.getBoolean(4);
		net_protocol = result.getString(5);
	}

	@Override
	public void read(CompressedDataInputStream in) throws IOException {
		pkey=in.readUTF().intern();
		port=in.readCompressedInt();
		name=in.readUTF();
		is_user_service=in.readBoolean();
		net_protocol=in.readUTF().intern();
	}

	@Override
	public void write(CompressedDataOutputStream out, AOServProtocol.Version version) throws IOException {
		out.writeUTF(pkey);
		out.writeCompressedInt(port);
		out.writeUTF(name);
		if(version.compareTo(AOServProtocol.Version.VERSION_1_0_A_105)>=0) {
			out.writeBoolean(is_user_service);
			out.writeUTF(net_protocol);
		}
	}
}