|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.administration.PortalAdministrationImpl
public class PortalAdministrationImpl
PortalAdministrationImpl Implements aggregate portal administration functions: - Emails - Registration - Password Generation -
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 |
---|
protected org.apache.commons.configuration.Configuration config
protected UserManager userManager
protected RoleManager roleManager
protected GroupManager groupManager
protected PageManager pageManager
protected Profiler profiler
protected org.springframework.mail.javamail.JavaMailSender mailSender
protected org.apache.velocity.app.VelocityEngine velocityEngine
protected AdminUtil adminUtil
protected java.util.List defaultRoles
protected java.util.List defaultGroups
protected java.util.Map defaultRules
protected java.lang.String folderTemplate
protected java.lang.String adminUser
Constructor Detail |
---|
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 |
---|
public void start()
public void registerUser(java.lang.String userName, java.lang.String password) throws RegistrationException
PortalAdministration
registerUser
in interface PortalAdministration
RegistrationException
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
registerUser
in interface PortalAdministration
RegistrationException
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
PortalAdministration
registerUser
in interface PortalAdministration
userName
- Unique user principal identifierpassword
- Password for this userroles
- A list of roles to assign to this usergroups
- A list of groups to assign to this useruserInfo
- 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'
RegistrationException
public java.lang.String generatePassword()
PortalAdministration
generatePassword
in interface PortalAdministration
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
PortalAdministration
sendEmail
in interface PortalAdministration
localizedSubject
- the subject of the email as a localized string
AdministrationEmailException
public void sendEmail(java.lang.String from, java.lang.String subject, java.lang.String to, java.lang.String text) throws AdministrationEmailException
PortalAdministration
sendEmail
in interface PortalAdministration
from
- subject
- to
- text
-
AdministrationEmailException
public java.lang.String mergeEmailTemplate(javax.portlet.PortletConfig portletConfig, java.util.Map attributes, java.lang.String attributesName, java.lang.String template) throws AdministrationEmailException
AdministrationEmailException
public User lookupUserFromEmail(java.lang.String email) throws AdministrationEmailException
PortalAdministration
lookupUserFromEmail
in interface PortalAdministration
email
- Given email address
User
, or throw exception if not found
AdministrationEmailException
public java.lang.String getPortalURL(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, java.lang.String path)
getPortalURL
in interface PortalAdministration
request
- The portlet request.response
- The portlet response, used to encode the pathpath
- The relative path to a portal resource
public java.util.Map getNewLoginInfo(java.lang.String guid)
getNewLoginInfo
in interface PortalAdministration
guid
- The ID which is passed throughte URL to the user
public void putNewLoginInfo(java.lang.String guid, java.util.Map info)
putNewLoginInfo
in interface PortalAdministration
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 databasepublic void removeNewLoginInfo(java.lang.String guid)
removeNewLoginInfo
in interface PortalAdministration
guid
- the ID which will be removed from the storage when the info is no longer valid
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |