com.iizix.server.client

Class ClientParams

java.lang.Object

com.iizix.server.client.ClientParams

public class ClientParams
extends Object

Class used to hold the information for the client parameters and to parse the Query string in the Client WebSocket URI.

Author:

Christopher Mindus

Field Summary

Fields

Modifier and Type	Field and Description
AppFactory	app The application to use, null if not found.
String	appID The Application ID, null if not found.
String	error The error message, null for OK.
String	hash The user hash when the user is returning.
String	query The original query.
static String	SERVER_CONFIGURATION_ENVIRONMENT The Server configuration environment property: "env".
SessionUserIdentifier	user The session user identifier, null if not defined properly.

Constructor Summary

Constructors

Constructor and Description
ClientParams(ServerShell server, String query) Constructor with public key required from remote party.
ClientParams(ServerShell server, String query, boolean doRequireKey) Constructor.

Method Summary

Modifier and Type	Method and Description
void	appendPublicKey(Transaction trans) Appends the server public key for the Diffie-Hellman key exchange with the client.
SessionUserIdentifier	assignSessionID(String sessionID) Assigns a new Session ID for this session.
String	getParameterValue(String name) Gets a property that is defined as the "other" properties, e.g.
String	toString() Returns a string representation of this client parameters and its values.
String	updatePassword(Transaction trans) Updates the instance with the encrypted password in the transaction from a client.

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_CONFIGURATION_ENVIRONMENT

public static final String SERVER_CONFIGURATION_ENVIRONMENT

The Server configuration environment property: "env".

See Also:

Constant Field Values

query

public final String query

The original query.

error

public final String error

The error message, null for OK.

appID

public final String appID

The Application ID, null if not found.

app

public final AppFactory app

The application to use, null if not found.

user

public SessionUserIdentifier user

The session user identifier, null if not defined properly.

hash

public final String hash

The user hash when the user is returning.

Constructor Detail

ClientParams

public ClientParams(ServerShell server,
                    String query)

Constructor with public key required from remote party.

Parameters:

server - The server instance.

query - The Query string from the URI.

ClientParams

public ClientParams(ServerShell server,
                    String query,
                    boolean doRequireKey)

Constructor.

Parameters:

server - The server instance.

query - The Query string from the URI.

doRequireKey - Public key required in "&k=" parameter and Application ID in "&app=".

Method Detail

assignSessionID

public SessionUserIdentifier assignSessionID(String sessionID)

Assigns a new Session ID for this session. This changes the user instance to a new SessionUserIdentifier instance.

Parameters:

sessionID - The session ID.

Returns:

The new SessionUserIdentifier.

appendPublicKey

public void appendPublicKey(Transaction trans)

Appends the server public key for the Diffie-Hellman key exchange with the client.

Parameters:

trans - The transaction.

updatePassword

public final String updatePassword(Transaction trans)
                            throws InvalidKeyException,
                                   NoSuchAlgorithmException,
                                   NoSuchPaddingException,
                                   IllegalBlockSizeException,
                                   BadPaddingException,
                                   UnsupportedEncodingException,
                                   InvalidAlgorithmParameterException

Updates the instance with the encrypted password in the transaction from a client.

Parameters:

trans - The transaction.

Returns:

The password.

Throws:

IllegalArgumentException - If the password encoding is invalid.

UnsupportedEncodingException - If the named charset is not supported.

BadPaddingException

IllegalBlockSizeException

NoSuchPaddingException

NoSuchAlgorithmException

InvalidKeyException

InvalidAlgorithmParameterException

getParameterValue

public String getParameterValue(String name)

Gets a property that is defined as the "other" properties, e.g. SERVER_CONFIGURATION_ENVIRONMENT for server configuration environment.

Parameters:

name - The parameter name, e.g. "env".

Returns:

The defined parameter value, or null if undefined.

toString

public String toString()

Returns a string representation of this client parameters and its values.

Overrides:

toString in class Object

Returns:

A string representation.