com.prosyst.mprm.net.connection

Interface P2PConnection

All Superinterfaces:

Connection

public interface P2PConnection
extends Connection

Encapsulates the 'physical' network connection between two mPRM backend hosts or between a Remote Access Client and mPRM backend host.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BACKEND_HOST The ID of the remote backend host.
static java.lang.String	HOST_ROLES The mPRM host roles of the remote backend host.

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(P2PConnectionListener listener) Adds a listener which will receives notification for changing the status of this point-to-point connection.
void	close(int code) Closes the connection.
java.lang.Object	getConnectionContext(java.lang.String key) Returns the object associated with the supplied key, or null of there is no such key.
ConnectionManager	getConnectionManager() Returns the ConnectionManager instance which is managing this point-to-point connection.
NetService	getNetService(java.lang.String netServiceName) Returns the NetService instance representing the net service with the given name registered on the remote host.
java.lang.String	getProperty(java.lang.String propertyName) Returns the value of the basic remote backend host configuration property with a given name - i.e.
java.lang.String	getRemoteHostId() Returns the identifier of the remote mPRM host or null if the remote host is not mPRM backend server.
java.lang.String[]	getRemoteHostRoles() Returns the roles of the remote mPRM host or null if the remote host is not mPRM backend server.
java.lang.String	getRemoteURL() Returns the url of the remote end point of this point-to-point connection.
boolean	isClosed() Returns if this connection is closed
boolean	isConnectedToBackendHost() Returns if the remote host of this connection is a mPRM backend server.
boolean	isOriginator() Returns true if this connection was initiated by the local host or false if it is accepted from the remote host
void	removeConnectionListener(P2PConnectionListener listener) Removes the listener from the list of the registsred connection listeners.
void	setConnectionAcceptor(java.lang.String netServiceName, ServiceConnectionAcceptor acceptor) Registers a Net service with a given name and associated with this net service connection acceptor.
void	setConnectionContext(java.lang.String key, java.lang.Object context) Associates a named object with this point-to-point connection.

Methods inherited from interface javax.microedition.io.Connection

close

Field Detail

BACKEND_HOST

static final java.lang.String BACKEND_HOST

The ID of the remote backend host.

See Also:

getProperty(String propertyName), Constant Field Values

HOST_ROLES

static final java.lang.String HOST_ROLES

The mPRM host roles of the remote backend host.

See Also:

getProperty(String propertyName), Constant Field Values

Method Detail

getRemoteURL

java.lang.String getRemoteURL()

Returns the url of the remote end point of this point-to-point connection.

Returns:

the url of the remote host

isConnectedToBackendHost

boolean isConnectedToBackendHost()

Returns if the remote host of this connection is a mPRM backend server.

Returns:

true if the remote host is a mPRM backend server, false otherwise (Remote Access client).

getRemoteHostId

java.lang.String getRemoteHostId()

Returns the identifier of the remote mPRM host or null if the remote host is not mPRM backend server.

Returns:

the host id of the remote host.

getRemoteHostRoles

java.lang.String[] getRemoteHostRoles()

Returns the roles of the remote mPRM host or null if the remote host is not mPRM backend server.

Returns:

array of backend server roles.

getProperty

java.lang.String getProperty(java.lang.String propertyName)

Returns the value of the basic remote backend host configuration property with a given name - i.e. BACKEND_HOST or HOST_ROLES.

Parameters:

propertyName - the key of the property.

Returns:

the value of the property.

isOriginator

boolean isOriginator()

Returns true if this connection was initiated by the local host or false if it is accepted from the remote host

Returns:

if the localhost is the originator of the connection.

setConnectionAcceptor

void setConnectionAcceptor(java.lang.String netServiceName,
                           ServiceConnectionAcceptor acceptor)

Registers a Net service with a given name and associated with this net service connection acceptor. This registration is valid only for this connection and overrides the registration for the same Net service performed via the ConnectionManager.setNetService(String, ServiceConnectionAcceptor) method.

Parameters:

netServiceName - the identifier of the Net service

acceptor - Net service specific instance which will handle connection request in the scope of this Net service.

getNetService

NetService getNetService(java.lang.String netServiceName)
                  throws java.io.IOException

Returns the NetService instance representing the net service with the given name registered on the remote host. If there is no such NetService registered this method will still return a NetService instance but it cannot be used until the correspodning Net service is registered on the remote side by registering the correspodning ServiceConnectionAcceptor.

Parameters:

netServiceName - the name of the remote Net service.

Returns:

the NetService instance.

Throws:

java.io.IOException - if communication level error has occured.

addConnectionListener

void addConnectionListener(P2PConnectionListener listener)

Adds a listener which will receives notification for changing the status of this point-to-point connection.

Parameters:

listener - the listener instance.

removeConnectionListener

void removeConnectionListener(P2PConnectionListener listener)

Removes the listener from the list of the registsred connection listeners. If there is no such listener the method does nothing.

Parameters:

listener - the listener being removed.

close

void close(int code)

Closes the connection. This method closes all currently active Net services and mulitiplexed connections in the scope of this point-to-point connection.

Parameters:

code - specifies the reason for closing the connection.

isClosed

boolean isClosed()

Returns if this connection is closed

Returns:

true if the connection is closed, false otherwise.

setConnectionContext

void setConnectionContext(java.lang.String key,
                          java.lang.Object context)

Associates a named object with this point-to-point connection. The associated object can be obtained later using its the same supplied key.

Parameters:

key - the key of the object

context - the object which will be assigned to the key in the scope of this connection object.

getConnectionContext

java.lang.Object getConnectionContext(java.lang.String key)

Returns the object associated with the supplied key, or null of there is no such key.

Parameters:

key - the key of the association.

Returns:

the object associated with the supplied key.

getConnectionManager

ConnectionManager getConnectionManager()

Returns the ConnectionManager instance which is managing this point-to-point connection.

Returns:

the ConnectionManager object.