com.bea.netuix.application.manager.persistence.jdbc
Class PortalDefinitionManagerImpl

java.lang.Object
  |
  +--com.bea.netuix.application.manager.persistence.jdbc.PortalDefinitionManagerImpl

All Implemented Interfaces:

EnterpriseBean, IPortalDefinitionManager, Serializable, SessionBean

public class PortalDefinitionManagerImpl

extends Object

implements SessionBean, IPortalDefinitionManager

PortalDefinitionManagerImpl

See Also:

Serialized Form

Field Summary

protected static Debug

debug

Constructor Summary

PortalDefinitionManagerImpl()

Method Summary

PortalDefinition	createPortalDefinition(CustomizationContext customizationContext, PortalDefinition pd) Creates a persistant version of a PortalDefinition from the provided PortalDefinition.
int	deletePortalDefinition(CustomizationContext customizationContext, PortalPath portalPath, String webapp) Deletes all (including localized) versions of a PortalDefinition.
void	ejbActivate()
void	ejbCreate()
void	ejbPassivate()
void	ejbRemove()
DefinitionCount	getDefinitionCount(CustomizationContext customizationContext, boolean _public) Return a count of all the definitions in the system.
int	getDesktopDefinitionCount(CustomizationContext customizationContext, PortalPath portalPath, String webapp) Returns the number of DesktopDefinitions under portal portalPath.
PortalPath[]	getDesktopDefinitionPortals(CustomizationContext customizationContext, DesktopPath desktopPath, String webapp) Returns all the PortalPaths that a DesktopDefinition is a part of.
DesktopDefinition[]	getDesktopDefinitions(CustomizationContext customizationContext, PortalPath portalPath, int begin, int end, String webapp) Returns DesktopDefinitions in the begin and end range under the portal portalPath.
DesktopView[]	getDesktopViews(CustomizationContext customizationContext, PortalPath portalPath, int begin, int end, String webapp) Returns DesktopViews in the begin and end range under the portal portalPath.
PortalDefinition	getPortalDefinition(CustomizationContext customizationContext, PortalPath portalPath, String webapp) Returns a PortalDefinition corresponding to a PortalPath.
int	getPortalDefinitionCount(CustomizationContext customizationContext, String webapp) Returns the number of portals.
PortalDefinition[]	getPortalDefinitions(CustomizationContext customizationContext, PortalPath[] portalPaths, String webapp) Returns an array of PortalDefinitions corresponding to an array of PortalPaths.
PortalView	getPortalDefinitionView(CustomizationContext customizationContext, PortalPath portalPath, String webapp) Returns a PortalView corresponding to a PortalPath.
PortalView[]	getPortalDefinitionViews(CustomizationContext customizationContext, PortalPath[] portalPaths, String webapp) Returns an array of PortalViews corresponding to an array of PortalPaths.
PortalPath[]	getPortalPaths(CustomizationContext customizationContext, int begin, int end, String webapp) Returns an array of PortalPaths in the begin and end range.
String[]	getPortalWebApps(CustomizationContext customizationContext) Return a set of portal webapps that are customizable.
void	setSessionContext(SessionContext sessionContext)
void	updatePortalDefinition(CustomizationContext customizationContext, PortalPath portalPath, PortalDefinition newPd) Updates a locale specific version of a PortalDefinition based on a new PortalDefinition.

Methods inherited from class java.lang.Object

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

Field Detail

debug

protected static Debug debug

Constructor Detail

PortalDefinitionManagerImpl

public PortalDefinitionManagerImpl()

Method Detail

setSessionContext

public void setSessionContext(SessionContext sessionContext)
                       throws EJBException

Specified by:

setSessionContext in interface SessionBean

EJBException

ejbCreate

public void ejbCreate()
               throws CreateException,
                      RemoteException

CreateException

RemoteException

ejbRemove

public void ejbRemove()
               throws EJBException

Specified by:

ejbRemove in interface SessionBean

EJBException

ejbActivate

public void ejbActivate()
                 throws EJBException

Specified by:

ejbActivate in interface SessionBean

EJBException

ejbPassivate

public void ejbPassivate()
                  throws EJBException

Specified by:

ejbPassivate in interface SessionBean

EJBException

getPortalWebApps

public String[] getPortalWebApps(CustomizationContext customizationContext)
                          throws RemoteException

Description copied from interface: IPortalDefinitionManager

Return a set of portal webapps that are customizable. Customizable webapps are webapps with customization element set to true in the netuix-config.xml file, and have at least on of the following: .shell files.

Specified by:

getPortalWebApps in interface IPortalDefinitionManager

Parameters:

customizationContext -

Returns:

an array of webapp names.

Throws:

RemoteException

getDefinitionCount

public DefinitionCount getDefinitionCount(CustomizationContext customizationContext,
                                          boolean _public)
                                   throws RemoteException

Description copied from interface: IPortalDefinitionManager

Return a count of all the definitions in the system.

Specified by:

getDefinitionCount in interface IPortalDefinitionManager

Parameters:

customizationContext -

_public - if true only return public definitions

Returns:

a class containing all the definitions counts

Throws:

RemoteException

getPortalDefinitionCount

public int getPortalDefinitionCount(CustomizationContext customizationContext,
                                    String webapp)
                             throws RemoteException

Returns the number of portals.

Specified by:

getPortalDefinitionCount in interface IPortalDefinitionManager

Parameters:

webapp - web application these desktop definitions are scoped to.

Returns:

number of portals

RemoteException

getPortalDefinition

public PortalDefinition getPortalDefinition(CustomizationContext customizationContext,
                                            PortalPath portalPath,
                                            String webapp)
                                     throws RemoteException,
                                            ObjectNotFoundException

Returns a PortalDefinition corresponding to a PortalPath.

Specified by:

getPortalDefinition in interface IPortalDefinitionManager

Parameters:

customizationContext - customization information such as prefered locales

portalPath - PortalPath

webapp - web application these desktop definitions are scoped to.

Returns:

PortalDefinition

Throws:

ObjectNotFoundException - if no portal is found

RemoteException

getPortalDefinitionView

public PortalView getPortalDefinitionView(CustomizationContext customizationContext,
                                          PortalPath portalPath,
                                          String webapp)
                                   throws RemoteException,
                                          ObjectNotFoundException

Returns a PortalView corresponding to a PortalPath.
NOTE: This method returns a deep copy of a portal definition.

Specified by:

getPortalDefinitionView in interface IPortalDefinitionManager

Parameters:

customizationContext - customization information such as prefered locales

portalPath - PortalPath

webapp - web application these desktop definitions are scoped to.

Returns:

PortalView

Throws:

ObjectNotFoundException - if no category definition is found

RemoteException

getPortalPaths

public PortalPath[] getPortalPaths(CustomizationContext customizationContext,
                                   int begin,
                                   int end,
                                   String webapp)
                            throws RemoteException

Returns an array of PortalPaths in the begin and end range. If fewer portals than (begin-end) exist then the former number of portals is returned. If no definitions are found an empty array is returned.
Implementation has to ensure that repeated calls to this method return PortalPaths in a consistent order.

Specified by:

getPortalPaths in interface IPortalDefinitionManager

Parameters:

customizationContext - customization information

begin - begin index

end - end index

webapp - web application these desktop definitions are scoped to.

Returns:

an array of PortalPaths

RemoteException

getPortalDefinitions

public PortalDefinition[] getPortalDefinitions(CustomizationContext customizationContext,
                                               PortalPath[] portalPaths,
                                               String webapp)
                                        throws RemoteException,
                                               ObjectNotFoundException

Returns an array of PortalDefinitions corresponding to an array of PortalPaths.

Specified by:

getPortalDefinitions in interface IPortalDefinitionManager

Parameters:

customizationContext - customization information such as prefered locales

portalPaths - array of PortalPaths

webapp - web application these desktop definitions are scoped to.

Returns:

array of PortalDefinitions

Throws:

ObjectNotFoundException - if portal for any key does not exist

RemoteException

getPortalDefinitionViews

public PortalView[] getPortalDefinitionViews(CustomizationContext customizationContext,
                                             PortalPath[] portalPaths,
                                             String webapp)
                                      throws RemoteException,
                                             ObjectNotFoundException

Returns an array of PortalViews corresponding to an array of PortalPaths.

Specified by:

getPortalDefinitionViews in interface IPortalDefinitionManager

Parameters:

customizationContext - customization information such as prefered locales

portalPaths - array of PortalPaths

webapp - web application these desktop definitions are scoped to.

Returns:

array of PortalViews

Throws:

ObjectNotFoundException - if portal for any key does not exist

RemoteException

getDesktopDefinitionCount

public int getDesktopDefinitionCount(CustomizationContext customizationContext,
                                     PortalPath portalPath,
                                     String webapp)
                              throws RemoteException

Returns the number of DesktopDefinitions under portal portalPath.

Specified by:

getDesktopDefinitionCount in interface IPortalDefinitionManager

Parameters:

portalPath - PortalPath

webapp - web application these desktop definitions are scoped to.

Returns:

number of PortletDefinitions under portal represented by portalPath

RemoteException

getDesktopDefinitions

public DesktopDefinition[] getDesktopDefinitions(CustomizationContext customizationContext,
                                                 PortalPath portalPath,
                                                 int begin,
                                                 int end,
                                                 String webapp)
                                          throws RemoteException

Returns DesktopDefinitions in the begin and end range under the portal portalPath. If fewer DesktopDefinitions than (begin-end) exist then the former number is returned. If no definitions are found an empty array is returned.
Use this method after getting the number of DesktopDefinitions.
Implementation has to ensure that repeated calls to this method return DesktopDefinitions in a consistent order.

Specified by:

getDesktopDefinitions in interface IPortalDefinitionManager

Parameters:

customizationContext - customization information such as prefered locales

portalPath - PortalPath

begin - begin index

end - end index

webapp - web application these desktop definitions are scoped to.

Returns:

array of DesktopDefinitions

RemoteException

getDesktopViews

public DesktopView[] getDesktopViews(CustomizationContext customizationContext,
                                     PortalPath portalPath,
                                     int begin,
                                     int end,
                                     String webapp)
                              throws RemoteException,
                                     ObjectNotFoundException

Returns DesktopViews in the begin and end range under the portal portalPath. If fewer views than (begin-end) exist then the former number of views is returned. If no views are found an empty array is returned.
Use this method after getting the number of DesktopDefinitions.
Implementation has to ensure that repeated calls to this method return DesktopViews in a consistent order.

Specified by:

getDesktopViews in interface IPortalDefinitionManager

Parameters:

customizationContext - customization information such as prefered locales

portalPath - PortalPath

begin - begin index

end - end index

webapp - web application these desktop definitions are scoped to.

Returns:

array of DesktopViews

RemoteException

ObjectNotFoundException

getDesktopDefinitionPortals

public PortalPath[] getDesktopDefinitionPortals(CustomizationContext customizationContext,
                                                DesktopPath desktopPath,
                                                String webapp)
                                         throws RemoteException

Returns all the PortalPaths that a DesktopDefinition is a part of. Returns an empty array if the latter is noncategorized.

Specified by:

getDesktopDefinitionPortals in interface IPortalDefinitionManager

Parameters:

desktopPath - DesktopPath

webapp - web application these desktop definitions are scoped to.

Returns:

an array of PortalPaths

RemoteException

createPortalDefinition

public PortalDefinition createPortalDefinition(CustomizationContext customizationContext,
                                               PortalDefinition pd)
                                        throws RemoteException,
                                               NotEntitledException,
                                               MissingDataException,
                                               DuplicateObjectException

Creates a persistant version of a PortalDefinition from the provided PortalDefinition.

Specified by:

createPortalDefinition in interface IPortalDefinitionManager

Parameters:

customizationContext - customization information such as prefered locales

pd - PortalDefinition

Returns:

handle to persisted PortalDefinition

Throws:

NotEntitledException - if caller does not have permission for this operation

MissingDataException - if data required to create a portal is missing

DuplicateObjectException - if this or another webapp already has a portal with the same partial path

RemoteException

deletePortalDefinition

public int deletePortalDefinition(CustomizationContext customizationContext,
                                  PortalPath portalPath,
                                  String webapp)
                           throws RemoteException,
                                  NotEntitledException

Deletes all (including localized) versions of a PortalDefinition.

Specified by:

deletePortalDefinition in interface IPortalDefinitionManager

Parameters:

customizationContext - customization information such as prefered locales

portalPath - PortalPath for PortalDefinition to be removed

webapp - web application these desktop definitions are scoped to.

Returns:

number of portals deleted

Throws:

NotEntitledException - if caller does not have permission for this operation

RemoteException

updatePortalDefinition

public void updatePortalDefinition(CustomizationContext customizationContext,
                                   PortalPath portalPath,
                                   PortalDefinition newPd)
                            throws RemoteException,
                                   ObjectNotFoundException,
                                   ObjectInUseException,
                                   NotEntitledException,
                                   MissingDataException

Updates a locale specific version of a PortalDefinition based on a new PortalDefinition.

Specified by:

updatePortalDefinition in interface IPortalDefinitionManager

Parameters:

customizationContext - customization information such as prefered locales

portalPath - PortalPath to PortalDefinition to be updated

newPd - new PortalDefinition

Throws:

ObjectNotFoundException - if portal does not exist

NotEntitledException - if caller does not have permission for this operation

MissingDataException - if data required to update a portal is missing

RemoteException

ObjectInUseException