com.aoindustries.aoserv.client.LinuxGroupAccount 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, 2014, 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;
import java.util.ArrayList;
import java.util.List;

/**
 * Each LinuxGroup may be accessed by any number
 * of LinuxAccounts.  The accounts are granted access
 * to a group via a LinuxGroupAccount.  One account
 * may access a maximum of 31 different groups.  Also, a
 * LinuxAccount must have one and only one primary
 * LinuxGroupAccount.
 *
 * @see  LinuxAccount
 * @see  LinuxGroup
 *
 * @author  AO Industries, Inc.
 */
final public class LinuxGroupAccount extends CachedObjectIntegerKey implements Removable {

	static final int COLUMN_PKEY=0;
	static final String COLUMN_GROUP_NAME_name = "group_name";
	static final String COLUMN_USERNAME_name = "username";

	/**
	 * The maximum number of groups allowed for one account.
	 * 
	 * /usr/include/linux/limits.h:#define NGROUPS_MAX    65536
	 */
	public static final int MAX_GROUPS = 65536;

	String group_name;
	String username;
	boolean is_primary;

	@Override
	Object getColumnImpl(int i) {
		switch(i) {
			case COLUMN_PKEY: return pkey;
			case 1: return group_name;
			case 2: return username;
			case 3: return is_primary;
			default: throw new IllegalArgumentException("Invalid index: "+i);
		}
	}

	public LinuxAccount getLinuxAccount() throws SQLException, IOException {
		LinuxAccount usernameObject = table.connector.getUsernames().get(username).getLinuxAccount();
		if (usernameObject == null) throw new SQLException("Unable to find LinuxAccount: " + username);
		return usernameObject;
	}

	public LinuxGroup getLinuxGroup() throws SQLException, IOException {
		LinuxGroup groupNameObject = table.connector.getLinuxGroups().get(group_name);
		if (groupNameObject == null) throw new SQLException("Unable to find LinuxGroup: " + group_name);
		return groupNameObject;
	}

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

	@Override
	public void init(ResultSet result) throws SQLException {
		pkey = result.getInt(1);
		group_name = result.getString(2);
		username = result.getString(3);
		is_primary = result.getBoolean(4);
	}

	public boolean isPrimary() {
		return is_primary;
	}

	@Override
	public void read(CompressedDataInputStream in) throws IOException {
		pkey=in.readCompressedInt();
		group_name=in.readUTF().intern();
		username=in.readUTF().intern();
		is_primary=in.readBoolean();
	}

	@Override
	public List getCannotRemoveReasons() {
		List reasons=new ArrayList<>();
		if(is_primary) reasons.add(new CannotRemoveReason<>("Not allowed to drop a primary group", this));
		return reasons;
	}

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

	void setAsPrimary() throws IOException, SQLException {
		table.connector.requestUpdateIL(
			true,
			AOServProtocol.CommandID.SET_PRIMARY_LINUX_GROUP_ACCOUNT,
			pkey
		);
	}

	@Override
	String toStringImpl() {
		return group_name+'|'+username+(is_primary?"|p":"|a");
	}

	@Override
	public void write(CompressedDataOutputStream out, AOServProtocol.Version version) throws IOException {
		out.writeCompressedInt(pkey);
		out.writeUTF(group_name);
		out.writeUTF(username);
		out.writeBoolean(is_primary);
	}
}