Package org.exoplatform.portal.mop.user

Class UserPortalImpl

java.lang.Object
org.exoplatform.portal.mop.user.UserPortalImpl
All Implemented Interfaces:
UserPortal
public class UserPortalImpl extends Object implements UserPortal
Version:
$Revision$
Author:
Julien Viet

  • Constructor Details

  • Method Details

    • getLocale

      public Locale getLocale()
      Description copied from interface: UserPortal
      Returns the portal locale.
      Specified by:
      getLocale in interface UserPortal
      Returns:
      the portal locale

    • getNavigations

      public List<UserNavigation> getNavigations()
      Returns an immutable sorted list of the valid navigations related to the user.
      Specified by:
      getNavigations in interface UserPortal
      Returns:
      the navigations

    • getNodes

      public Collection<UserNode> getNodes(org.exoplatform.portal.mop.SiteType siteType, org.exoplatform.portal.mop.navigation.Scope scope, UserNodeFilterConfig filterConfig)
      Description copied from interface: UserPortal
      Load the list of user nodes computed from the list of UserNavigation of type siteType (PORTAL, GROUP or USER)
      Specified by:
      getNodes in interface UserPortal
      Parameters:
      siteType - site type: PORTAL, GROUP or USER
      scope - an optional scope
      filterConfig - an optional filter
      Returns:
      a Collection of UserNode

    • getNodes

      public Collection<UserNode> getNodes(org.exoplatform.portal.mop.SiteType siteType, org.exoplatform.portal.mop.navigation.Scope scope, UserNodeFilterConfig filterConfig, boolean includeGlobal)
      Description copied from interface: UserPortal
      Load the list of user nodes computed from the list of UserNavigation of type siteType (PORTAL, GROUP or USER)
      Specified by:
      getNodes in interface UserPortal
      Parameters:
      siteType - site type: PORTAL, GROUP or USER
      scope - an optional scope
      filterConfig - an optional filter
      includeGlobal - to include global nodes
      Returns:
      a Collection of UserNode

    • getNavigation

      public UserNavigation getNavigation(org.exoplatform.portal.mop.SiteKey key)
      Description copied from interface: UserPortal
      Returns a user navigation for a specified site key, null is returned when such navigation does not exist.
      Specified by:
      getNavigation in interface UserPortal
      Parameters:
      key - the site key
      Returns:
      the corresponding user navigation

    • refresh

      public void refresh()
      Description copied from interface: UserPortal
      Refresh the current user portal.
      Specified by:
      refresh in interface UserPortal

    • getNode

      public UserNode getNode(UserNavigation userNavigation, org.exoplatform.portal.mop.navigation.Scope scope, UserNodeFilterConfig filterConfig, org.exoplatform.portal.mop.navigation.NodeChangeListener<UserNode> listener) throws NullPointerException, UserPortalException, org.exoplatform.portal.mop.navigation.NavigationServiceException
      Description copied from interface: UserPortal
      Load a user node from a specified user navigation with a custom scope. The returned node is the root node of the navigation.
      Specified by:
      getNode in interface UserPortal
      Parameters:
      userNavigation - the user navigation
      scope - an optional scope
      filterConfig - an optional filter
      listener - an optional listener @return the user node
      Returns:
      the user node
      Throws:
      NullPointerException - if the navigation argument is null
      UserPortalException - any user portal exception
      org.exoplatform.portal.mop.navigation.NavigationServiceException - any navigation service exception

    • getNodeById

      public UserNode getNodeById(String userNodeId, org.exoplatform.portal.mop.SiteKey siteKey, org.exoplatform.portal.mop.navigation.Scope scope, UserNodeFilterConfig filterConfig, org.exoplatform.portal.mop.navigation.NodeChangeListener<UserNode> listener)
      Description copied from interface: UserPortal
      Load specific navigation node children
      Specified by:
      getNodeById in interface UserPortal
      Parameters:
      userNodeId - target userNode id
      siteKey - Site key
      scope - the scope
      filterConfig - an optional filter
      listener - an optional listener
      Returns:
      UserNode

    • updateNode

      public void updateNode(UserNode node, org.exoplatform.portal.mop.navigation.Scope scope, org.exoplatform.portal.mop.navigation.NodeChangeListener<UserNode> listener)
      Description copied from interface: UserPortal
      Update the specified content with the most recent state.
      Specified by:
      updateNode in interface UserPortal
      Parameters:
      node - the node to update
      scope - the optional scope
      listener - an optional listener

    • rebaseNode

      public void rebaseNode(UserNode node, org.exoplatform.portal.mop.navigation.Scope scope, org.exoplatform.portal.mop.navigation.NodeChangeListener<UserNode> listener)
      Description copied from interface: UserPortal
      Rebase the specified context with the most recent state.
      Specified by:
      rebaseNode in interface UserPortal
      Parameters:
      node - the user node that will be rebased
      scope - the optional scope
      listener - the optional node change listener

    • saveNode

      public void saveNode(UserNode node, org.exoplatform.portal.mop.navigation.NodeChangeListener<UserNode> listener) throws NullPointerException, UserPortalException, org.exoplatform.portal.mop.navigation.NavigationServiceException
      Description copied from interface: UserPortal
      Save the specified context to the persistent storage.
      Specified by:
      saveNode in interface UserPortal
      Parameters:
      node - the user node that will be rebased
      listener - the optional node change listener
      Throws:
      NullPointerException - if the node argument is null
      UserPortalException - any user portal exception
      org.exoplatform.portal.mop.navigation.NavigationServiceException - anything that would prevent the operation to succeed

    • getDefaultPath

      public UserNode getDefaultPath(UserNodeFilterConfig filterConfig) throws UserPortalException, org.exoplatform.portal.mop.navigation.NavigationServiceException
      Description copied from interface: UserPortal
      Returns the user node for the default path.
      Specified by:
      getDefaultPath in interface UserPortal
      Parameters:
      filterConfig - an optional filter
      Returns:
      the default navigation path
      Throws:
      UserPortalException - any user portal exception
      org.exoplatform.portal.mop.navigation.NavigationServiceException - any navigation service exception

    • getDefaultPath

      public UserNode getDefaultPath(UserNavigation userNavigation, UserNodeFilterConfig filterConfig) throws UserPortalException, org.exoplatform.portal.mop.navigation.NavigationServiceException
      Description copied from interface: UserPortal
      Returns the user node for the default path in specified navigation
      Specified by:
      getDefaultPath in interface UserPortal
      Parameters:
      userNavigation - the navigation
      filterConfig - an optional filter
      Returns:
      the default navigation path
      Throws:
      UserPortalException - any user portal exception
      org.exoplatform.portal.mop.navigation.NavigationServiceException - any navigation service exception

    • resolvePath

      public UserNode resolvePath(UserNodeFilterConfig filterConfig, String path)
      Description copied from interface: UserPortal
      Resolves and returns a node among all user navigations for a specified path.
      Specified by:
      resolvePath in interface UserPortal
      Parameters:
      filterConfig - an optional filter
      path - the path
      Returns:
      the navigation path

    • resolvePath

      public UserNode resolvePath(UserNavigation navigation, UserNodeFilterConfig filterConfig, String path) throws NullPointerException, UserPortalException, org.exoplatform.portal.mop.navigation.NavigationServiceException
      Description copied from interface: UserPortal
      Resolves and returns a node for the specified navigation and for a specified path.
      Specified by:
      resolvePath in interface UserPortal
      Parameters:
      navigation - the navigation
      filterConfig - an optional filter
      path - the path @return the navigation path
      Returns:
      the navigation path
      Throws:
      NullPointerException - if the navigation or path argument is null
      UserPortalException - any user portal exception
      org.exoplatform.portal.mop.navigation.NavigationServiceException - any navigation service exception

    • getPortalConfig

      public org.exoplatform.portal.config.model.PortalConfig getPortalConfig()

    • filterUserNavigation

      protected UserNavigation filterUserNavigation(org.exoplatform.portal.mop.SiteKey key)

    • loadUserNavigation

      protected UserNavigation loadUserNavigation(org.exoplatform.portal.mop.SiteKey siteKey)

    • getUserGroupIds

      protected List<String> getUserGroupIds(org.exoplatform.services.security.ConversationState conversationState)

    • getUserGroupIds

      protected List<String> getUserGroupIds(Collection<?> groups)

    • getGlobalUserNode

      protected UserNode getGlobalUserNode(UserNodeFilterConfig filterConfig, org.exoplatform.portal.mop.SiteKey siteKey, String[] segments)