com.portal.bas

Interface PInfranetAppController

All Known Implementing Classes:

PInfranetAppControllerImpl, PInfranetConnectionImpl

public interface PInfranetAppController

PInfranetAppController, one of the main server-side classes, contains application information and services of interest only to other server-side classes. One instance of PInfranetAppController is created for each client session, and it ties together all controllers that are created for that session.

The class contains the client session's locale, application name, and other optional data. It is used to establish connections between controllers on the server side, using handles passed through the client. This is how server-side event listeners work, for example, PRemoteListenerProxy.

When a connection to Portal is created, this class is used to cache the connection.

All controllers can call getAppController() to get their instance of PInfranetAppController.

Version:

%version: 3.1.2 % %date_modified: Tue Jan 08 20:30:33 2002 %

Author:

larrylf

See Also:

PApplicationServices.getAppController(), PControllerImpl.getAppController()

Method Summary

Modifier and Type	Method and Description
PInfranetAppController	duplicate() Duplicates the application controller.
PInfranetAppController	duplicate(PortalContext c)
PModelHandle	getAccountHandle()
String	getAppName() Gets the application name.
Locale	getClientLocale() Gets the application/client locale.
PCachedContext	getConnection() Returns the current connection context.
EventListener	getEventListener(Object handle) Gets an event listener, given a handle generated by postEventListener.
Object	getOtherData() Gets any other data sent by the client application.
PPermission	getPermissions() Gets a PPermission object.
PModelHandle	getServiceHandle()
boolean	isBrandingEnabled()
PControllerImpl	lookupController(PControllerBean comp) Looks up a controller for a given component.
Object	postEventListener(Object src, EventListener l) Posts an event listener and returns a handle for it.
void	registerController(PControllerBean comp, PControllerImpl impl) Registers the client portion of a component's controller with the server.
void	releaseConnection(PCachedContext ctx) Releases the connection retrieved by getConnection().
void	removeEventListener(Object handle) Removes a posted event listener.
void	setBrandContext(Poid brandPoid)
void	setConnection(PCachedContext conn) Sets a connection object for application use.
void	unregisterController(PControllerImpl impl) Unregisters the client portion of a component's controller with the server.
void	unregisterControllers() Unregisters the client portion of all component's controller with the server.
void	verifyAndSwitchToUser(String user, String password, String service)

Method Detail

duplicate

PInfranetAppController duplicate()
                          throws RemoteException

Duplicates the application controller. It is not the same as cloning, because the new and original application controllers share most features. It makes a shallow copy of the application controller that contains unique contexts.

Returns:

A duplicate application controller.

Throws:

RemoteException - thrown in case of failure

duplicate

PInfranetAppController duplicate(PortalContext c)
                          throws RemoteException

Throws:

RemoteException

lookupController

PControllerImpl lookupController(PControllerBean comp)
                          throws RemoteException

Looks up a controller for a given component.

Parameters:

comp - a remote component stub

Returns:

The controller, if any, associated with the component.

Throws:

RemoteException - thrown in case of failure

postEventListener

Object postEventListener(Object src,
                         EventListener l)
                  throws RemoteException

Posts an event listener and returns a handle for it. This is used for passing events, where the events are passed on the server side but listeners are registered on the client side.

Parameters:

src - the source of the event

l - an event listener

Returns:

A handle to pass to the client.

Throws:

RemoteException - thrown in case of failure

getEventListener

EventListener getEventListener(Object handle)
                        throws RemoteException

Gets an event listener, given a handle generated by postEventListener.

Parameters:

handle - a token generated by postEventListener

Returns:

The posted listener for the handle.

Throws:

RemoteException - thrown in case of failure

removeEventListener

void removeEventListener(Object handle)
                  throws RemoteException

Removes a posted event listener.

Parameters:

handle - the handle to the listener

Throws:

RemoteException - thrown in case of failure

setConnection

void setConnection(PCachedContext conn)
            throws RemoteException

Sets a connection object for application use.

Parameters:

conn - a new, cached context object

Throws:

RemoteException - thrown in case of failure

getConnection

PCachedContext getConnection()
                      throws RemoteException

Returns the current connection context. May be null if no connection to Portal has been made. For every call to getConnection() there must be a corresponding call to releaseConnection().

Returns:

A PCachedContext object or null.

Throws:

RemoteException - thrown in case of failure

See Also:

releaseConnection(com.portal.bas.PCachedContext)

releaseConnection

void releaseConnection(PCachedContext ctx)
                throws RemoteException

Releases the connection retrieved by getConnection(). For every call to getConnection() there must be a corresponding call to releaseConnection().

Parameters:

ctx - the connection to be released.

Throws:

RemoteException

See Also:

getConnection()

registerController

void registerController(PControllerBean comp,
                        PControllerImpl impl)
                 throws RemoteException

Registers the client portion of a component's controller with the server.

Parameters:

comp - the component to register

impl - the component's controller

Throws:

RemoteException - thrown in case of failure

unregisterController

void unregisterController(PControllerImpl impl)
                   throws RemoteException

Unregisters the client portion of a component's controller with the server.

Parameters:

impl - the component's controller

Throws:

RemoteException - thrown in case of failure

getPermissions

PPermission getPermissions()
                    throws RemoteException

Gets a PPermission object.

Returns:

A PPermission object.

Throws:

RemoteException - thrown for remote errors

getAppName

String getAppName()
           throws RemoteException

Gets the application name.

Returns:

A String with the application name,

Throws:

RemoteException - thrown in case of failure

getClientLocale

Locale getClientLocale()
                throws RemoteException

Gets the application/client locale.

Returns:

The client's locale.

Throws:

RemoteException - thrown in case of failure

getOtherData

Object getOtherData()
             throws RemoteException

Gets any other data sent by the client application.

Returns:

An object containing application-specific data.

Throws:

RemoteException - thrown in case of failure

getServiceHandle

PModelHandle getServiceHandle()
                       throws RemoteException

Throws:

RemoteException

getAccountHandle

PModelHandle getAccountHandle()
                       throws RemoteException

Throws:

RemoteException

isBrandingEnabled

boolean isBrandingEnabled()
                   throws RemoteException

Throws:

RemoteException

setBrandContext

void setBrandContext(Poid brandPoid)
              throws RemoteException

Throws:

RemoteException

verifyAndSwitchToUser

void verifyAndSwitchToUser(String user,
                           String password,
                           String service)
                    throws RemoteException

Throws:

RemoteException

unregisterControllers

void unregisterControllers()

Unregisters the client portion of all component's controller with the server.