com.aoindustries.aoserv.master.RequestSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aoserv-master Show documentation

Master server for the AOServ Platform.

There is a newer version: 1.91.8

/*
 * aoserv-master - Master server for the AOServ Platform.
 * Copyright (C) 2001-2013, 2017, 2018, 2019, 2020  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of aoserv-master.
 *
 * aoserv-master 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-master 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-master.  If not, see .
 */
package com.aoindustries.aoserv.master;

import com.aoindustries.aoserv.client.account.User;
import com.aoindustries.aoserv.client.schema.AoservProtocol;
import com.aoindustries.collections.IntList;
import com.aoindustries.security.Identifier;
import java.io.IOException;

/**
 * Obtains information necessary for request processing.
 */
public interface RequestSource {

	void cachesInvalidated(IntList tableList) throws IOException;

	Identifier getConnectorId();

	InvalidateCacheEntry getNextInvalidatedTables();

	String getSecurityMessageHeader();

	User.Name getCurrentAdministrator();

	/**
	 * Determines if the communication with the client is currently secure.
	 */
	boolean isSecure() throws IOException;

	boolean isClosed();

	/**
	 * Gets the id of the server that this connection is created from.  This
	 * is only used by connections initiated by daemons.
	 *
	 * @return  the id of the server or -1 for none
	 */
	int getDaemonServer();

	/**
	 * Gets the protocol version number supported by the client.
	 */
	AoservProtocol.Version getProtocolVersion();
}