com.aoindustries.aoserv.client.web.tomcat.JkMount 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) 2017, 2018, 2019  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.web.tomcat;

import com.aoindustries.aoserv.client.CachedObjectIntegerKey;
import com.aoindustries.aoserv.client.CannotRemoveReason;
import com.aoindustries.aoserv.client.Removable;
import com.aoindustries.aoserv.client.schema.AoservProtocol;
import com.aoindustries.aoserv.client.schema.Table;
import com.aoindustries.io.stream.StreamableInput;
import com.aoindustries.io.stream.StreamableOutput;
import java.io.IOException;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Collections;
import java.util.List;

/**
 * Each {@link Site} has independently configured JkMount and JkUnMount directives.
 *
 * @see  Site
 *
 * @author  AO Industries, Inc.
 */
final public class JkMount extends CachedObjectIntegerKey implements Removable {

	static final int
		COLUMN_PKEY = 0,
		COLUMN_HTTPD_TOMCAT_SITE = 1
	;
	static final String COLUMN_HTTPD_TOMCAT_SITE_name = "httpd_tomcat_site";
	static final String COLUMN_PATH_name = "path";
	static final String COLUMN_MOUNT_name = "mount";

	/**
	 * Checks if the path is valid for JkMount
	 * and JkUnMount.
	 */
	public static boolean isValidPath(String path) {
		return
			path.length() > 1
			&& path.charAt(0) == '/'
			&& !path.contains("//")
			&& !path.contains("..")
			&& path.indexOf('"') == -1
			&& path.indexOf('\\') == -1
			&& path.indexOf('\n') == -1
			&& path.indexOf('\r') == -1
			&& path.indexOf('\0') == -1
		;
	}

	int httpd_tomcat_site;
	private String path;
	private boolean mount;

	@Override
	public List> getCannotRemoveReasons() {
		return Collections.emptyList();
	}

	@Override
	protected Object getColumnImpl(int i) {
		switch(i) {
			case COLUMN_PKEY: return pkey;
			case COLUMN_HTTPD_TOMCAT_SITE: return httpd_tomcat_site;
			case 2: return path;
			case 3: return mount;
			default: throw new IllegalArgumentException("Invalid index: " + i);
		}
	}

	public Site getHttpdTomcatSite() throws SQLException, IOException {
		Site obj = table.getConnector().getWeb_tomcat().getSite().get(httpd_tomcat_site);
		if(obj == null) throw new SQLException("Unable to find HttpdTomcatSite: " + httpd_tomcat_site);
		return obj;
	}

	public String getPath() {
		return path;
	}

	/**
	 * When {@code true} is a JkMount directive.
	 * When {@code false} is a JkUnMount directive.
	 */
	public boolean isMount() {
		return mount;
	}

	@Override
	public Table.TableID getTableID() {
		return Table.TableID.HTTPD_TOMCAT_SITE_JK_MOUNTS;
	}

	@Override
	public void init(ResultSet result) throws SQLException {
		pkey = result.getInt(1);
		httpd_tomcat_site = result.getInt(2);
		path = result.getString(3);
		mount = result.getBoolean(4);
		if(!isValidPath(path)) throw new SQLException("Invalid path: " + path);
	}

	@Override
	public void read(StreamableInput in, AoservProtocol.Version protocolVersion) throws IOException {
		pkey = in.readCompressedInt();
		httpd_tomcat_site = in.readCompressedInt();
		path = in.readUTF();
		mount = in.readBoolean();
		if(!isValidPath(path)) throw new IOException("Invalid path: " + path);
	}

	@Override
	public String toStringImpl() {
		return (mount ? "JkMount " : "JkUnMount ") + path;
	}

	@Override
	public void remove() throws IOException, SQLException {
		table.getConnector().requestUpdateIL(true, AoservProtocol.CommandID.REMOVE, Table.TableID.HTTPD_TOMCAT_SITE_JK_MOUNTS, pkey);
	}

	@Override
	public void write(StreamableOutput out, AoservProtocol.Version protocolVersion) throws IOException {
		out.writeCompressedInt(pkey);
		out.writeCompressedInt(httpd_tomcat_site);
		out.writeUTF(path);
		out.writeBoolean(mount);
	}
}