com.portal.bas

Interface PBAServer

All Superinterfaces:

Remote

All Known Implementing Classes:

PBAServerImpl

public interface PBAServer
extends Remote

PBAServer is the BAS server interface. The BAS server is a simple application server. Its main function is to serve as a single point of contact for BAS clients to start their server-side activities, for example, a single name server lookup. The createConnection methods create a PInfranetAppController for each user session. The user session in turn uses these connections to create the controllers for the various client-side components. Note: In previous releases, these connections also needed valid Portal logins, but this is no longer required.

Version:

6

Author:

Larry Lynch-Freshner

Method Summary

Modifier and Type	Method and Description
PInfranetConnection	createConnection(boolean useConnectionPool) Creates a user session and returns it.
PInfranetConnection	createConnection(PInfranetConnection session) Creates a duplicate of session and returns it.
PInfranetConnection	createConnection(String name, String password, String connectInfo) Deprecated. No replacement
PInfranetConnection	createDefaultConnection() Gets a new PInfranetConnection using information stored in the PortalUser.properties file.
String[]	getPossibleConnections() Deprecated. No replacement
void	logRemote(String src, String msg) Logs a request from a client.
void	shutDown() Does necessary clean-up for shut-down.

Method Detail

createDefaultConnection

PInfranetConnection createDefaultConnection()
                                     throws RemoteException

Gets a new PInfranetConnection using information stored in the PortalUser.properties file. If the required information is not present in Infranet.properties, the connection to Portal is not made. The connection object returned in this case can still be used to log remotely, and can be used to create controllers.

Returns:

A new connection.

Throws:

RemoteException - thrown in case of failure

See Also:

logRemote( String src, String msg )

createConnection

PInfranetConnection createConnection(String name,
                                     String password,
                                     String connectInfo)
                              throws RemoteException

Deprecated. No replacement

Gets a new PInfranetConnection. Logging in is now handled in a component controller.

Parameters:

name - a user name for logging in to the server

password - the password associated with the user name

connectInfo - the connection information in URL form, which must at a minimum the contain host and port (for example, pcp://host:11960/)

Returns:

A new connection.

Throws:

RemoteException - thrown for errors

createConnection

PInfranetConnection createConnection(boolean useConnectionPool)
                              throws RemoteException

Creates a user session and returns it. A user session does not necessarily have a connection to the Portal server, but for historical reasons it's represented by PInfranetConnection whose name is misleading.

Parameters:

useConnectionPool - if true the created user session will get a connection from the connection pool; otherwise, it will use a dedicated connection throughout its life-time

Returns:

A new user session.

Throws:

RemoteException

createConnection

PInfranetConnection createConnection(PInfranetConnection session)
                              throws RemoteException

Creates a duplicate of session and returns it. A user session does not necessarily have a connection to the Portal server, but for historical reasons it's represented by PInfranetConnection whose name is misleading.

Parameters:

session - the session to be duplicated

Returns:

A new user session.

Throws:

RemoteException

shutDown

void shutDown()
       throws RemoteException

Does necessary clean-up for shut-down.

Throws:

RemoteException

getPossibleConnections

String[] getPossibleConnections()
                         throws RemoteException

Deprecated. No replacement

Gets a list of available Portal hosts to connect to.

Returns:

A String array with each element containing an available host and port in Portal connection information format

Throws:

RemoteException - thrown for errors

logRemote

void logRemote(String src,
               String msg)
        throws RemoteException

Logs a request from a client.

Parameters:

src - the source identifier string

msg - a message to log

Throws:

RemoteException - thrown for errors