Package com.portal.bas

Class PInfranetAppControllerImpl

java.lang.Object

com.portal.bas.PInfranetAppControllerImpl

All Implemented Interfaces:

PInfranetAppController, PInfranetConnection, CMConnectionListener, Remote

Direct Known Subclasses:

PInfranetConnectionImpl

public class PInfranetAppControllerImpl
extends Object
implements PInfranetConnection, PInfranetAppController, CMConnectionListener

PInfranetAppControllerImpl is the implementation of PInfranetAppController and PInfranetConnection interfaces. See that class for more details on usage and purpose.

Field Summary

Fields

Modifier and Type	Field	Description
protected Hashtable	mCompMap

Constructor Summary

Constructors

Constructor	Description
PInfranetAppControllerImpl()	Initializes this application controller without a connection pool.
PInfranetAppControllerImpl(PortalContext ctx)	Initialize PInfranetAppContollerImpl using an existing PortalContext

Method Summary

Modifier and Type	Method	Description
void	close(boolean logout)	Closes the connection to the Portal server.
void	cmreconnected(CMConnectionEvent event)	Implementation for CMConnectionListener.
PControllerBean	createController(String controllerClass)	Registers the client portion of a component with the server.
PModelHandle	createNewModel(String type)	Creates a new, empty data model.
PInfranetAppController	duplicate()	Duplicates the application controller.
PInfranetAppController	duplicate(PortalContext ctx)	Duplicates the application controller, but instead of opening a new connection to Portal uses the one passed in.
PModelHandle	getAccountHandle()
String	getAppName()	Gets the application name.
Locale	getClientLocale()	Get the client application's locale.
PCachedContext	getConnection()	Returns the current connection context.
PortalContext	getContext()	Get the internal PortalContext.
EventListener	getEventListener(Object handle)	Gets an event listener, given a handle generated by postEventListener.
Object	getModelField(PModelHandle data, String desc)	Gets a field from a model.
Object	getOtherData()	Gets any other data sent by the client application.
boolean	getPermissionFor(String componentName)	Gets permission to use a component.
PPermission	getPermissions()	Gets a PPermission object.
PRestriction	getRestrictionOn(String fieldSpecification)	Gets the restrictions for a field.
PModelHandle	getServiceHandle()
Properties	getUserPreferences()	Gets the user's UI preferences.
boolean	isBrandingEnabled()	Returns true if Portal is brand-enabled.
void	login(String user, String password, String url)	Logs user into the Portal server specified by url.
PControllerImpl	lookupController(PControllerBean comp)	Looks up a controller for a given component.
Object	postEventListener(Object src, EventListener l)	Posts an EventListener and returns a handle for it.
void	registerApp(String appName, Locale locale, Object data)	Registers the application with the server.
void	registerComponent(PRemoteComponent comp, String controllerClass)	Deprecated. As of Release 6.1, replaced by createController and registerController.
void	registerController(PControllerBean comp, PControllerImpl impl)	Registers the client portion of a component with the server.
void	releaseConnection(PCachedContext ctx)	Releases the connection retrieved by getConnection().
void	releaseContext(PortalContext ctx)	Release the PortalContext to the pool if one exists.
void	removeEventListener(Object handle)	Removes a posted event listener.
void	saveUserPreferences()	Save user preferences Properties object to PIN_FLD_USER_PREFS field in /service/admin_client.
void	setBrandContext(Poid brandPoid)	Sets the brand scope of this user session to the account represented by brandPoid.
void	setConnection(PCachedContext conn)	Sets a connection object for application use.
void	setModelField(PModelHandle data, String desc, Object val)	Sets a field in a model to a new value.
void	setUserPreferences(Properties userPrefs)	Deprecated. Don't pass a Properties object explicitly.
protected void	storeUserPrefs(Properties userPrefs)	Save preferences Properties object to PIN_FLD_USER_PREFS field in /service/admin_client.
void	throwInfranetException(EBufException e)	A utility method that retrieves message information from an EBufException, and uses it to build a PInfranetException, which is then thrown.
void	unregisterComponent(PRemoteComponent comp)	Deprecated. As of Release 6.1, replaced by unregisterController.
void	unregisterController(PControllerImpl impl)	Unregisters a component.
void	unregisterControllers()	Unregisters the client portion of a component's controller with the server.
void	unsetBrandContext()	Reverts the brand scope of this user session to the account of the user who logged in.
void	verifyAndSwitchToUser(String user, String password, String service)	Calls Portal to authenticate user, and sets the brand scope of this session to user's account if authentication succeeds.

Methods inherited from class java.lang.Object

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

Field Details

mCompMap

protected Hashtable mCompMap

Constructor Details

PInfranetAppControllerImpl

public PInfranetAppControllerImpl()
                           throws RemoteException

Initializes this application controller without a connection pool.

Throws:

RemoteException

PInfranetAppControllerImpl

public PInfranetAppControllerImpl(PortalContext ctx)
                           throws Exception

Initialize PInfranetAppContollerImpl using an existing PortalContext

Parameters:

PortalContext - whose connection to Portal BAS will use internally. Note that the PortalContext is reset to its default values after being used.

Throws:

Exception

Method Details

duplicate

public PInfranetAppController duplicate(PortalContext ctx)
                                 throws RemoteException

Duplicates the application controller, but instead of opening a new connection to Portal uses the one passed in. 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.

Specified by:

duplicate in interface PInfranetAppController

Parameters:

ctx - The connection to be used by the new PInfranetAppController

Throws:

RemoteException - thrown for errors

duplicate

public 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.

Specified by:

duplicate in interface PInfranetAppController

Returns:

A duplicate application controller.

Throws:

RemoteException - thrown for errors

login

public void login(String user,
 String password,
 String url)
           throws RemoteException

Logs user into the Portal server specified by url.

Specified by:

login in interface PInfranetConnection

Parameters:

user - the username

password - user's password

url - a string containing connection information in URL format, e.g., pcp://host:port

Throws:

RemoteException - if login fails.

close

public void close(boolean logout)
           throws RemoteException

Closes the connection to the Portal server.

Specified by:

close in interface PInfranetConnection

Parameters:

logout - if true, logs out before closing the connection

Throws:

RemoteException - thrown for errors

Since:

Release 6.2

getPermissionFor

public boolean getPermissionFor(String componentName)
                         throws RemoteException

Gets permission to use a component.

Specified by:

getPermissionFor in interface PInfranetConnection

Parameters:

componentName - the name of the component to get permissions for

Returns:

True, if permitted; false otherwise.

Throws:

RemoteException - thrown for errors

getRestrictionOn

public PRestriction getRestrictionOn(String fieldSpecification)
                              throws RemoteException

Gets the restrictions for a field.

Specified by:

getRestrictionOn in interface PInfranetConnection

Parameters:

fieldSpecification - a String with the field's specification

Returns:

A PRestriction object.

Throws:

RemoteException - thrown for errors

registerApp

public void registerApp(String appName,
 Locale locale,
 Object data)
                 throws RemoteException

Registers the application with the server. This gives the server-side components access to the application name and client locale.

Specified by:

registerApp in interface PInfranetConnection

Parameters:

appName - the application name

locale - the client's locale

data - other application-specific data

Throws:

RemoteException - thrown for errors

createController

public PControllerBean createController(String controllerClass)
                                 throws RemoteException

Registers the client portion of a component with the server.

Specified by:

createController in interface PInfranetConnection

Parameters:

controllerClass - the class name of the component's controller

Returns:

A controller.

Throws:

RemoteException - thrown in case of failure

registerComponent

public void registerComponent(PRemoteComponent comp,
 String controllerClass)
                       throws RemoteException

Deprecated.

As of Release 6.1, replaced by createController and registerController.

Registers the client portion of a component with the server.

Specified by:

registerComponent in interface PInfranetConnection

Parameters:

comp - the component to register

controllerClass - the class name of the component controller

Throws:

RemoteException - thrown in case of failure

unregisterComponent

public void unregisterComponent(PRemoteComponent comp)
                         throws RemoteException

Deprecated.

As of Release 6.1, replaced by unregisterController.

Unregisters a component.

Specified by:

unregisterComponent in interface PInfranetConnection

Parameters:

comp - the component to unregister

Throws:

RemoteException - thrown in case of failure

registerController

public void registerController(PControllerBean comp,
 PControllerImpl impl)
                        throws RemoteException

Registers the client portion of a component with the server. This essentially sends the stub back to the server. registerController is used to associate the RMI stub class with the actual implementation class, which gets the implementation later when the stub is passed as a parameter. This is useful in implementing remote event listeners.

The framework calls this automatically when a new controller is created.

Specified by:

registerController in interface PInfranetAppController

Parameters:

comp - a remote component stub

impl - the component to register

Throws:

RemoteException - thrown in case of failure

unregisterController

public void unregisterController(PControllerImpl impl)
                          throws RemoteException

Unregisters a component. This frees it for garbage collection.

Specified by:

unregisterController in interface PInfranetAppController

Parameters:

impl - the component to unregister

Throws:

RemoteException - thrown in case of failure

createNewModel

public PModelHandle createNewModel(String type)
                            throws RemoteException

Creates a new, empty data model.

Specified by:

createNewModel in interface PInfranetConnection

Parameters:

type - a String that defines the type of model to create

Returns:

A new model handle.

Throws:

RemoteException - thrown for errors

getModelField

public Object getModelField(PModelHandle data,
 String desc)
                     throws RemoteException

Gets a field from a model. This version returns a PModelHandle only for a field that is itself a model. Use this method when the returned field data will be sent to the client. For compound specifications, an object array is returned.

Specified by:

getModelField in interface PInfranetConnection

Parameters:

data - the model from which to get a field

desc - a description of which field(s) to get

Returns:

The contents of the field. This is an Integer, BigDecimal, Date, Double, byte array, String, or PModelHandle.

Throws:

RemoteException - thrown for errors

setModelField

public void setModelField(PModelHandle data,
 String desc,
 Object val)
                   throws RemoteException

Sets a field in a model to a new value. This version handles the case where the new value is a PModelHandle.

Specified by:

setModelField in interface PInfranetConnection

Parameters:

data - the model to set a field in

desc - a description of which field to set

val - the new value to be set

Throws:

RemoteException - thrown for errors

getUserPreferences

public Properties getUserPreferences()
                              throws RemoteException

Gets the user's UI preferences. If user preferences have already been cached in this class, that instance is returned. Otherwise data from the PIN_FLD_USER_PREFS field in /service/admin_client is returned.

Specified by:

getUserPreferences in interface PInfranetConnection

Returns:

A Properties object that contains the user's preferences, or null for errors or if no preferences were retrieved from the server.

Throws:

RemoteException - thrown for errors

saveUserPreferences

public void saveUserPreferences()
                         throws RemoteException

Save user preferences Properties object to PIN_FLD_USER_PREFS field in /service/admin_client. Saves the object managed by this class that is retrieved using getUserPreferences() method. Always use this preferred method to save user prefs.

Specified by:

saveUserPreferences in interface PInfranetConnection

Throws:

RemoteException

setUserPreferences

public void setUserPreferences(Properties userPrefs)
                        throws RemoteException

Deprecated.

Don't pass a Properties object explicitly. Use saveUserPreferences() instead and have this class manage the preferences.

Saves changes to the user's UI preferences Properties object to the PIN_FLD_USER_PREFS field in /service/admin_client.

Specified by:

setUserPreferences in interface PInfranetConnection

Parameters:

userPrefs - the Properties object that contains the user's preferences; must not be null

Throws:

RemoteException - thrown for errors

cmreconnected

public void cmreconnected(CMConnectionEvent event)

Implementation for CMConnectionListener. Sets the cached scope to the reset connection

Specified by:

cmreconnected in interface CMConnectionListener

storeUserPrefs

protected void storeUserPrefs(Properties userPrefs)
                       throws RemoteException

Save preferences Properties object to PIN_FLD_USER_PREFS field in /service/admin_client. This actually writes it to the db.

Parameters:

A - non-null Properties object containing the users preferences.

Throws:

RemoteException

lookupController

public PControllerImpl lookupController(PControllerBean comp)
                                 throws RemoteException

Looks up a controller for a given component.

Specified by:

lookupController in interface PInfranetAppController

Parameters:

comp - a remote component stub

Returns:

The controller, if any, associated with the component.

Throws:

RemoteException - thrown for errors

postEventListener

public Object postEventListener(Object src,
 EventListener l)
                         throws RemoteException

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

Specified by:

postEventListener in interface PInfranetAppController

Parameters:

src - the source of the event

l - an EventListener

Returns:

A handle to pass to the client.

Throws:

RemoteException - thrown for errors

getEventListener

public EventListener getEventListener(Object handle)
                               throws RemoteException

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

Specified by:

getEventListener in interface PInfranetAppController

Parameters:

handle - a token generated by the postEventListener class

Returns:

The posted listener for the handle, or null.

Throws:

RemoteException - thrown for errors

removeEventListener

public void removeEventListener(Object handle)

Removes a posted event listener.

Specified by:

removeEventListener in interface PInfranetAppController

Parameters:

handle - the event listener's handle

setConnection

public void setConnection(PCachedContext conn)
                   throws RemoteException

Sets a connection object for application use.

Specified by:

setConnection in interface PInfranetAppController

Parameters:

conn - a new, cached context object

Throws:

RemoteException - thrown for errors

getConnection

public 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().

Specified by:

getConnection in interface PInfranetAppController

Returns:

A PCachedContext object, or null.

Throws:

RemoteException - thrown for errors

See Also:

• releaseConnection(com.portal.bas.PCachedContext)

releaseConnection

public 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(). This method doesn't do anything if there is no connection pool.

Specified by:

releaseConnection in interface PInfranetAppController

Parameters:

ctx - the connection to be released.

Throws:

RemoteException

See Also:

• getConnection()

getContext

public PortalContext getContext()

Get the internal PortalContext. This is a semi-private function and MUST only be used by classes that want to cache Portal data and intentionally bypass the BAS cache.

Specified by:

getContext in interface PInfranetConnection

Returns:

The portal context used internally.

See Also:

• PInfranetConnection.releaseContext(com.portal.pcm.PortalContext)

releaseContext

public void releaseContext(PortalContext ctx)

Release the PortalContext to the pool if one exists.

Specified by:

releaseContext in interface PInfranetConnection

Parameters:

ctx - the portal context to be released.

See Also:

• PInfranetConnection.getContext()

isBrandingEnabled

public boolean isBrandingEnabled()
                          throws RemoteException

Returns true if Portal is brand-enabled.

Specified by:

isBrandingEnabled in interface PInfranetAppController

Throws:

RemoteException

verifyAndSwitchToUser

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

Calls Portal to authenticate user, and sets the brand scope of this session to user's account if authentication succeeds.

Specified by:

verifyAndSwitchToUser in interface PInfranetAppController

Parameters:

user - the username

password -

service - the service type, e.g., "/service/email"

Throws:

RemoteException - if authentication fails.

getServiceHandle

public PModelHandle getServiceHandle()
                              throws RemoteException

Specified by:

getServiceHandle in interface PInfranetAppController

Throws:

RemoteException

getAccountHandle

public PModelHandle getAccountHandle()
                              throws RemoteException

Specified by:

getAccountHandle in interface PInfranetAppController

Throws:

RemoteException

setBrandContext

public void setBrandContext(Poid brandPoid)
                     throws RemoteException

Sets the brand scope of this user session to the account represented by brandPoid.

Specified by:

setBrandContext in interface PInfranetAppController

Parameters:

brandPoid - the Poid of a user account

Throws:

RemoteException

unsetBrandContext

public void unsetBrandContext()
                       throws RemoteException

Reverts the brand scope of this user session to the account of the user who logged in.

Throws:

RemoteException

getPermissions

public PPermission getPermissions()
                           throws RemoteException

Gets a PPermission object.

Specified by:

getPermissions in interface PInfranetAppController

Returns:

A PPermission object.

Throws:

RemoteException - thrown for remote errors

getAppName

public String getAppName()
                  throws RemoteException

Gets the application name.

Specified by:

getAppName in interface PInfranetAppController

Returns:

A String that contains the application name.

Throws:

RemoteException - thrown for errors

getClientLocale

public Locale getClientLocale()
                       throws RemoteException

Get the client application's locale.

Specified by:

getClientLocale in interface PInfranetAppController

Returns:

The client's locale.

Throws:

RemoteException - thrown for errors

getOtherData

public Object getOtherData()
                    throws RemoteException

Gets any other data sent by the client application.

Specified by:

getOtherData in interface PInfranetAppController

Returns:

An object that contains application-specific data.

Throws:

RemoteException - thrown for errors

throwInfranetException

public void throwInfranetException(EBufException e)
                            throws PInfranetException

A utility method that retrieves message information from an EBufException, and uses it to build a PInfranetException, which is then thrown.

Parameters:

e - an EBufException

Throws:

PInfranetException - thrown for Portal errors

unregisterControllers

public void unregisterControllers()

Unregisters the client portion of a component's controller with the server. This frees it for garbage collection.

Specified by:

unregisterControllers in interface PInfranetAppController