cz.gyarab.util.rmi.client

Class Connection

java.lang.Object

cz.gyarab.util.rmi.client.Connection

All Implemented Interfaces:

java.io.Serializable, java.lang.AutoCloseable

public class Connection
extends java.lang.Object
implements java.io.Serializable, java.lang.AutoCloseable

Centrální objekt klientské strany v klient-serverovém prostředí. Pomocí tohoto objektu klientský kód přistupuje ke vzdáleným objektům.

Základní paradigma:

 try (Connection c = new Connection()) {
   try (RemoteSupplier<SomeInterface> s = c.get(SomeInterface.class)) {
     SomeInterface i = s.get();
     i.someMethod();
   }
 }
 

Since:

1.4

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Connection.VersionCheckStrictness Hned po připojení automaticky nebo i kdykoliv potom manuálně lze zkontrolovat shodu verzí knihovny ArabTools na klientu a na serveru.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_HOST Výchozí jméno hostitele.
static int	DEFAULT_PORT Výchozí TCP pro RMI připojení k serveru.

Constructor Summary

Constructors

Constructor and Description
Connection() Vytvoří instanci připojení k výchozímu serveru na jeho výchozí port.
Connection(java.lang.String serverHostName) Vytvoří instanci připojení k serveru se specifikovaným doménovým názvem na jeho výchozí port.
Connection(java.lang.String serverHostName, int serverPort) Vytvoří instanci připojení k serveru se specifikovaným názvem a na specifikované číslo portu.

Method Summary

Modifier and Type	Method and Description
void	close() Zavře spojení se serverem a uzavře tento objekt tak, že už ho nelze použít pro další připojení nebo získání jakýchkoliv informací ze serveru.
protected void	finalize()
<I> RemoteSupplier<I>	get(java.lang.Class<I> iface) Získá dodavatele cílového rozhraní.
<I> RemoteSupplier<I>	get(java.lang.Class<I> iface, java.io.Serializable key) Získá dodavatele cílového rozhraní.
java.util.Date	getLastHeartbeat() Zjistí serverový čas poslední kontroly dostupnosti serveru.
static java.util.logging.Level	getLogLevel() Zjistí úroveň logování.
java.lang.String	getServerHostName() Zjistí jméno nebo IP adresu serveru, ke kterému se klient připojuje.
int	getServerPort() Zjistí číslo TCP portu RMI spojení k serveru.
Version	getServerVersion() Zjistí verzi knihovny ArabTools.
java.lang.String	getUserName() Zjistí uživatelské jméno, pod kterým se klient přihlašuje.
Connection.VersionCheckStrictness	getVersionCheckStrictness() Zjistí současnou přísnost kontroly verze serveru proti klientu.
void	checkServerVersion() Zkontroluje shodu verze místní knihovny ArabTools a té na serveru.
static void	main(java.lang.String[] args) Demostrace použití.
static void	setLogLevel(java.util.logging.Level logLevel) Mastaví úroveň logování.
void	setPassword(java.lang.String password) Nastaví heslo pro uživatele.
void	setUserName(java.lang.String userName) Nastaví uživatelské jméno.
void	setVersionCheckStrictness(Connection.VersionCheckStrictness versionCheckStrictness) Nastaví přísnost kontroly verze serveru proti klientu.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

Výchozí TCP pro RMI připojení k serveru.

See Also:

RemoteServer.CONNECTION_PORT, Constant Field Values

DEFAULT_HOST

public static final java.lang.String DEFAULT_HOST

Výchozí jméno hostitele. Při testování se obvykle klient připojuje k lokálnímu počítači, kde je již také spuštěn testovací server.

See Also:

Constant Field Values

Constructor Detail

Connection

public Connection()

Vytvoří instanci připojení k výchozímu serveru na jeho výchozí port.

Connection

public Connection(java.lang.String serverHostName)

Vytvoří instanci připojení k serveru se specifikovaným doménovým názvem na jeho výchozí port. Názvem může být i IP adresa.

Parameters:

serverHostName - název nebo IP adresa serveru

Connection

public Connection(java.lang.String serverHostName,
                  int serverPort)

Vytvoří instanci připojení k serveru se specifikovaným názvem a na specifikované číslo portu. Názvem může být i IP adresa.

Parameters:

serverHostName - název nebo IP adresa serveru

serverPort - číslo portu (výchozí je DEFAULT_PORT), musí být stejné jako číslo portu serveru, ke kterému se klient připojuje)

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.rmi.RemoteException

Demostrace použití. Pro svou funkci potřebuje mít lokálně spuštěný server poskytující rozhraní SimpleChat (např. SimpleSampleChat.runServer()).

Parameters:

args - (ignoruje)

Throws:

java.rmi.RemoteException - při I/O problému

getLogLevel

public static java.util.logging.Level getLogLevel()

Zjistí úroveň logování.

Returns:

úroveň logování

setLogLevel

public static void setLogLevel(java.util.logging.Level logLevel)

Mastaví úroveň logování.

Parameters:

logLevel - úroveň logování

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

close

public void close()

Zavře spojení se serverem a uzavře tento objekt tak, že už ho nelze použít pro další připojení nebo získání jakýchkoliv informací ze serveru.

Specified by:

close in interface java.lang.AutoCloseable

getServerHostName

public java.lang.String getServerHostName()

Zjistí jméno nebo IP adresu serveru, ke kterému se klient připojuje.

Returns:

jméno resp. IP adresa serveru

getServerPort

public int getServerPort()

Zjistí číslo TCP portu RMI spojení k serveru.

Returns:

číslo portu

getServerVersion

public Version getServerVersion()

Zjistí verzi knihovny ArabTools. Pokud je přísnost kontroly nastavená na Connection.VersionCheckStrictness.EXCEPTION a verze se neshodují, tato metoda skončí s výjimkou WrongVersionException v kauzálním řetězu ServerRuntimeException. Verzi je pak možné získat z této výjimky voláním WrongVersionException.getServerVersion(). A nebo dočasně vypnout kontrolu Connection.VersionCheckStrictness.IGNORE.

Returns:

verzi knihovny ArabTools na serveru

checkServerVersion

public void checkServerVersion()
                        throws WrongVersionException

Zkontroluje shodu verze místní knihovny ArabTools a té na serveru. V případě shody metoda nic neprovede. V opačném případě záleží na nastavení přísnosti kontroly. Může být i vyvolána výjimka. Metoda je rovněž interně volána samotnou třídou při navazování spojení se serverem, takže výjimka může být také vyvolána a předána do řetězu kauz ServerRuntimeException prakticky v libovolné metodě.

Throws:

WrongVersionException - pokud verze nesouhlasí a přísnost kontroly je nastavena na Connection.VersionCheckStrictness.EXCEPTION

getVersionCheckStrictness

public Connection.VersionCheckStrictness getVersionCheckStrictness()

Zjistí současnou přísnost kontroly verze serveru proti klientu.

Returns:

přísnost kontroly verze

See Also:

checkServerVersion()

setVersionCheckStrictness

public void setVersionCheckStrictness(Connection.VersionCheckStrictness versionCheckStrictness)

Nastaví přísnost kontroly verze serveru proti klientu.

Parameters:

versionCheckStrictness - přísnost kontroly verze

See Also:

checkServerVersion()

getUserName

public java.lang.String getUserName()

Zjistí uživatelské jméno, pod kterým se klient přihlašuje.

Returns:

uživatelské jméno

setUserName

public final void setUserName(java.lang.String userName)

Nastaví uživatelské jméno. Pokud už byl server připojen, bude odpojen a tím přestanou být platné všechny dříve získané vzdálené objekty.

Parameters:

userName - nové uživatelské jméno; může být null, v takovém případě se použije systémové jméno uživatele (výchozí hodnota)

setPassword

public void setPassword(java.lang.String password)

Nastaví heslo pro uživatele. Pokud už byl server připojen, bude odpojen a tím přestanou být platné všechny dříve získané vzdálené objekty.

Hesla nejsou nijak šifrována a i sítí se přenášejí v otevřené podobě. Použití oblíbených hesel pro tyto demonstrační účely je krajně nezodpovědné.

Parameters:

password - uživatelské heslo

getLastHeartbeat

public java.util.Date getLastHeartbeat()

Zjistí serverový čas poslední kontroly dostupnosti serveru.

Po připojení klientu k serveru klient zahájí (v samostatném vlákně) pravidelné kontroly dostupnosti serveru. Při kontrole server odpoví svým lokálním systémovým časem. Tato metoda zjistí a předá poslední známé časové razítko této úspěšné kontroly.

Returns:

null, pokud kontrola ještě neproběhla, nebo poslední známý čas serveru

See Also:

RemoteSession.heartbeat()

get

public <I> RemoteSupplier<I> get(java.lang.Class<I> iface)
                          throws ServerRuntimeException

Získá dodavatele cílového rozhraní. V závislosti na implementaci serverové části může opakované volání této metody vracet referenci na stejnou nebo jinou instanci vzdáleného objektu.

Type Parameters:

I - cílové rozhraní

Parameters:

iface - cílové rozhraní

Returns:

dodavatele proxy objektu implementujícího cílové rozhraní

Throws:

ServerRuntimeException - v případě problému takový proxy objekt vytvořit, v kauzálním řetězci je možné dohledat pravou příčinu, např. WrongVersionException, AuthException; je možné v kauzálním řetězu najít i další výjimky ServerRuntimeException

See Also:

get(iface, key)

get

public <I> RemoteSupplier<I> get(java.lang.Class<I> iface,
                                 java.io.Serializable key)
                          throws ServerRuntimeException

Získá dodavatele cílového rozhraní. V závislosti na implementaci serverové části může opakované volání této metody vracet referenci na stejnou nebo jinou instanci vzdáleného objektu. Také záleží na hodnotě klíče, pokud server implementuje tuto schopnost, je možné získat více různých objektů a rozlišit je právě tím unikátním klíčem.

Type Parameters:

I - cílové rozhraní

Parameters:

iface - cílové rozhraní

key - klíč, pokud to serverová implementace umožňuje, může být klíčem null (stejně jako v případě volání přetížené verze metody) nebo naopak nesmí; některé implementace mohou povolit obě možnosti, jiné klíč mohou ignorovat úplně

Returns:

dodavatele proxy objektu implementujícího cílové rozhraní

Throws:

ServerRuntimeException - v případě problému takový proxy objekt vytvořit, v kauzálním řetězci je možné dohledat pravou příčinu, např. WrongVersionException, AuthException; je možné v kauzálním řetězu najít i další výjimky ServerRuntimeException

See Also:

get(iface)