com.aoindustries.aoserv.client.EmailDomain 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.aoserv.client.validator.DomainName;
import com.aoindustries.aoserv.client.validator.ValidationException;
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.ArrayList;
import java.util.List;

/**
 * A EmailDomain is one hostname/domain of email
 * addresses hosted on a Server.  Multiple, unique
 * email addresses may be hosted within the EmailDomain.
 * In order for mail to be routed to the Server, a
 * DNSRecord entry of type MX must
 * point to the Server.
 *
 * @see  EmailAddress
 * @see  DNSRecord
 * @see  DNSType#MX
 * @see  AOServer
 *
 * @author  AO Industries, Inc.
 */
public final class EmailDomain extends CachedObjectIntegerKey implements Removable {

	static final int
		COLUMN_PKEY=0,
		COLUMN_AO_SERVER=2,
		COLUMN_PACKAGE=3
	;
	static final String COLUMN_AO_SERVER_name = "ao_server";
	static final String COLUMN_DOMAIN_name = "domain";

	private DomainName domain;
	int ao_server;
	String packageName;

	public int addEmailAddress(String address) throws SQLException, IOException {
		return table.connector.getEmailAddresses().addEmailAddress(address, this);
	}

	public void addMajordomoServer(
		LinuxServerAccount linuxServerAccount,
		LinuxServerGroup linuxServerGroup,
		MajordomoVersion majordomoVersion
	) throws IOException, SQLException {
		table.connector.getMajordomoServers().addMajordomoServer(
			this,
			linuxServerAccount,
			linuxServerGroup,
			majordomoVersion
		);
	}

	@Override
	Object getColumnImpl(int i) {
		switch(i) {
			case COLUMN_PKEY: return pkey;
			case 1: return domain;
			case COLUMN_AO_SERVER: return ao_server;
			case COLUMN_PACKAGE: return packageName;
			default: throw new IllegalArgumentException("Invalid index: "+i);
		}
	}

	public DomainName getDomain() {
		return domain;
	}

	public EmailAddress getEmailAddress(String address) throws IOException, SQLException {
		return table.connector.getEmailAddresses().getEmailAddress(address, this);
	}

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

	public MajordomoServer getMajordomoServer() throws IOException, SQLException {
		return table.connector.getMajordomoServers().get(pkey);
	}

	public Package getPackage() throws SQLException, IOException {
		Package packageObject = table.connector.getPackages().get(packageName);
		if (packageObject == null) throw new SQLException("Unable to find Package: " + packageName);
		return packageObject;
	}

	public AOServer getAOServer() throws SQLException, IOException {
		AOServer ao=table.connector.getAoServers().get(ao_server);
		if(ao==null) throw new SQLException("Unable to find AOServer: "+ao_server);
		return ao;
	}

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

	@Override
	public void init(ResultSet result) throws SQLException {
		try {
			pkey=result.getInt(1);
			domain=DomainName.valueOf(result.getString(2));
			ao_server=result.getInt(3);
			packageName=result.getString(4);
		} catch(ValidationException e) {
			throw new SQLException(e);
		}
	}

	/**
	 * @deprecated  Use DomainName.validate instead.
	 */
	@Deprecated
	public static boolean isValidFormat(String name) {
		if("localhost".equals(name)) return false;

		// Must contain at least one period
		int pos = name.indexOf('.');
		// Must have something before
		if (pos > 0) {
			// The first character must not be -
			if (name.charAt(0) == '-') return false;
			// Must have something afterwards
			int len = name.length();
			if (pos < (len - 1)) {
				// Must not end with .
				if (name.charAt(len - 1) != '.') {
					// Must not have ..
					if (name.indexOf("..") == -1) {
						// All remaining characters must be [a-z,0-9,.,-]
						for (int c = 0; c < len; c++) {
							char ch = name.charAt(c);
							if ((ch < 'a' || ch > 'z') && (ch < '0' || ch > '9') && ch != '.' && ch != '-') return false;
						}
						return true;
					}
				}
			}
		}
		return false;
	}

	@Override
	public void read(CompressedDataInputStream in) throws IOException {
		try {
			pkey=in.readCompressedInt();
			domain=DomainName.valueOf(in.readUTF());
			ao_server=in.readCompressedInt();
			packageName=in.readUTF().intern();
		} catch(ValidationException e) {
			throw new IOException(e);
		}
	}

	@Override
	public List getCannotRemoveReasons() throws SQLException, IOException {
		List reasons=new ArrayList<>();

		MajordomoServer ms=getMajordomoServer();
		if(ms!=null) {
			EmailDomain ed=ms.getDomain();
			reasons.add(new CannotRemoveReason<>("Used by Majordomo server "+ed.getDomain()+" on "+ed.getAOServer().getHostname(), ms));
		}

		for(EmailAddress ea : getEmailAddresses()) reasons.addAll(ea.getCannotRemoveReasons());

		return reasons;
	}

	@Override
	public void remove() throws IOException, SQLException {
		table.connector.requestUpdateIL(
			true,
			AOServProtocol.CommandID.REMOVE,
			SchemaTable.TableID.EMAIL_DOMAINS,
			pkey
		);
	}

	@Override
	public void write(CompressedDataOutputStream out, AOServProtocol.Version version) throws IOException {
		out.writeCompressedInt(pkey);
		out.writeUTF(domain.toString());
		out.writeCompressedInt(ao_server);
		out.writeUTF(packageName);
	}
}