org.apache.jetspeed.administration
Class PortalAdministrationImpl

java.lang.Object
  extended by org.apache.jetspeed.administration.PortalAdministrationImpl
All Implemented Interfaces:
PortalAdministration

public class PortalAdministrationImpl
extends java.lang.Object
implements PortalAdministration

PortalAdministrationImpl Implements aggregate portal administration functions: - Emails - Registration - Password Generation -

Version:
$Id: $
Author:
David Sean Taylor, Chris Schaefer

Field Summary
protected  java.lang.String adminUser
          default administrative user
protected  AdminUtil adminUtil
           
protected  org.apache.commons.configuration.Configuration config
          administration services
protected  java.util.List defaultGroups
          list of default groups for a registered user
protected  java.util.List defaultRoles
          list of default roles for a registered user
protected  java.util.Map defaultRules
          map of default profiling rules for a registered user
protected  java.lang.String folderTemplate
          name of PSML Folder Template to clone from when registering new user
protected  GroupManager groupManager
           
protected  org.springframework.mail.javamail.JavaMailSender mailSender
           
protected  PageManager pageManager
           
protected  Profiler profiler
           
protected  RoleManager roleManager
           
protected  UserManager userManager
           
protected  org.apache.velocity.app.VelocityEngine velocityEngine
           
 
Constructor Summary
PortalAdministrationImpl(UserManager userManager, RoleManager roleManager, GroupManager groupManager, PageManager pageManager, PreferencesProvider preferences, Profiler profiler, org.springframework.mail.javamail.JavaMailSender mailSender, org.apache.velocity.app.VelocityEngine velocityEngine)
           
 
Method Summary
 java.lang.String generatePassword()
          Generate a unique password
 java.util.Map getNewLoginInfo(java.lang.String guid)
           
 java.lang.String getPortalURL(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String path)
          Helper for admin portlets to generate portal urls
 User lookupUserFromEmail(java.lang.String email)
          Lookup a user given an email address
 java.lang.String mergeEmailTemplate(javax.portlet.PortletConfig portletConfig, java.util.Map attributes, java.lang.String attributesName, java.lang.String template)
           
 void putNewLoginInfo(java.lang.String guid, java.util.Map info)
           
 void registerUser(java.lang.String userName, java.lang.String password)
          Register a new user using all default values
 void registerUser(java.lang.String userName, java.lang.String password, java.util.List roles, java.util.List groups, java.util.Map userInfo, java.util.Map rules, java.lang.String folderTemplate)
           
 void registerUser(java.lang.String userName, java.lang.String password, java.util.List roles, java.util.List groups, java.util.Map userInfo, java.util.Map rules, java.lang.String folderTemplate, java.lang.String subsite)
          Registers and creates a new user, assigning userInfo, roles, groups, profiling rules and a folder template.
 void removeNewLoginInfo(java.lang.String guid)
           
 void sendEmail(javax.portlet.PortletConfig portletConfig, java.lang.String emailAddress, java.lang.String localizedSubject, java.lang.String localizedTemplatePath, java.util.Map userAttributes)
          Helper to send an email to a recipient
 void sendEmail(java.lang.String from, java.lang.String subject, java.lang.String to, java.lang.String text)
          Helper to send an email to a recipient without the portal default sender, and without mail merge
 void start()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

config

protected org.apache.commons.configuration.Configuration config
administration services


userManager

protected UserManager userManager

roleManager

protected RoleManager roleManager

groupManager

protected GroupManager groupManager

pageManager

protected PageManager pageManager

profiler

protected Profiler profiler

mailSender

protected org.springframework.mail.javamail.JavaMailSender mailSender

velocityEngine

protected org.apache.velocity.app.VelocityEngine velocityEngine

adminUtil

protected AdminUtil adminUtil

defaultRoles

protected java.util.List defaultRoles
list of default roles for a registered user


defaultGroups

protected java.util.List defaultGroups
list of default groups for a registered user


defaultRules

protected java.util.Map defaultRules
map of default profiling rules for a registered user


folderTemplate

protected java.lang.String folderTemplate
name of PSML Folder Template to clone from when registering new user


adminUser

protected java.lang.String adminUser
default administrative user

Constructor Detail

PortalAdministrationImpl

public PortalAdministrationImpl(UserManager userManager,
                                RoleManager roleManager,
                                GroupManager groupManager,
                                PageManager pageManager,
                                PreferencesProvider preferences,
                                Profiler profiler,
                                org.springframework.mail.javamail.JavaMailSender mailSender,
                                org.apache.velocity.app.VelocityEngine velocityEngine)
Method Detail

start

public void start()

registerUser

public void registerUser(java.lang.String userName,
                         java.lang.String password)
                  throws RegistrationException
Description copied from interface: PortalAdministration
Register a new user using all default values

Specified by:
registerUser in interface PortalAdministration
Throws:
RegistrationException

registerUser

public void registerUser(java.lang.String userName,
                         java.lang.String password,
                         java.util.List roles,
                         java.util.List groups,
                         java.util.Map userInfo,
                         java.util.Map rules,
                         java.lang.String folderTemplate)
                  throws RegistrationException
Specified by:
registerUser in interface PortalAdministration
Throws:
RegistrationException

registerUser

public void registerUser(java.lang.String userName,
                         java.lang.String password,
                         java.util.List roles,
                         java.util.List groups,
                         java.util.Map userInfo,
                         java.util.Map rules,
                         java.lang.String folderTemplate,
                         java.lang.String subsite)
                  throws RegistrationException
Description copied from interface: PortalAdministration
Registers and creates a new user, assigning userInfo, roles, groups, profiling rules and a folder template. If any values are null, defaults are used from the system wide configuration.

Specified by:
registerUser in interface PortalAdministration
Parameters:
userName - Unique user principal identifier
password - Password for this user
roles - A list of roles to assign to this user
groups - A list of groups to assign to this user
userInfo - Portlet API User Information Attributes name value pairs (PLT.D)
rules - A map of name value pairs of profiling rules. Well known rules names are 'page' and 'menu'
Throws:
RegistrationException

generatePassword

public java.lang.String generatePassword()
Description copied from interface: PortalAdministration
Generate a unique password

Specified by:
generatePassword in interface PortalAdministration
Returns:
unique password

sendEmail

public void sendEmail(javax.portlet.PortletConfig portletConfig,
                      java.lang.String emailAddress,
                      java.lang.String localizedSubject,
                      java.lang.String localizedTemplatePath,
                      java.util.Map userAttributes)
               throws AdministrationEmailException
Description copied from interface: PortalAdministration
Helper to send an email to a recipient

Specified by:
sendEmail in interface PortalAdministration
localizedSubject - the subject of the email as a localized string
Throws:
AdministrationEmailException

sendEmail

public void sendEmail(java.lang.String from,
                      java.lang.String subject,
                      java.lang.String to,
                      java.lang.String text)
               throws AdministrationEmailException
Description copied from interface: PortalAdministration
Helper to send an email to a recipient without the portal default sender, and without mail merge

Specified by:
sendEmail in interface PortalAdministration
Parameters:
from -
subject -
to -
text -
Throws:
AdministrationEmailException

mergeEmailTemplate

public java.lang.String mergeEmailTemplate(javax.portlet.PortletConfig portletConfig,
                                           java.util.Map attributes,
                                           java.lang.String attributesName,
                                           java.lang.String template)
                                    throws AdministrationEmailException
Throws:
AdministrationEmailException

lookupUserFromEmail

public User lookupUserFromEmail(java.lang.String email)
                         throws AdministrationEmailException
Description copied from interface: PortalAdministration
Lookup a user given an email address

Specified by:
lookupUserFromEmail in interface PortalAdministration
Parameters:
email - Given email address
Returns:
a Jetspeed User, or throw exception if not found
Throws:
AdministrationEmailException

getPortalURL

public java.lang.String getPortalURL(javax.portlet.PortletRequest request,
                                     javax.portlet.PortletResponse response,
                                     java.lang.String path)
Helper for admin portlets to generate portal urls

Specified by:
getPortalURL in interface PortalAdministration
Parameters:
request - The portlet request.
response - The portlet response, used to encode the path
path - The relative path to a portal resource
Returns:
the base Jetspeed portal URL plus the appended path parameter

getNewLoginInfo

public java.util.Map getNewLoginInfo(java.lang.String guid)
Specified by:
getNewLoginInfo in interface PortalAdministration
Parameters:
guid - The ID which is passed throughte URL to the user
Returns:

putNewLoginInfo

public void putNewLoginInfo(java.lang.String guid,
                            java.util.Map info)
Specified by:
putNewLoginInfo in interface PortalAdministration
Parameters:
guid - the ID which is passed through the URL to the user..
info - a Map, info from which will be used to reset the password the password in this case is NOT encrypted, but this should probably change if this information is stored on disk... ie a database

removeNewLoginInfo

public void removeNewLoginInfo(java.lang.String guid)
Specified by:
removeNewLoginInfo in interface PortalAdministration
Parameters:
guid - the ID which will be removed from the storage when the info is no longer valid


Copyright © 1999-2010 Apache Software Foundation. All Rights Reserved.