| org.apache.jetspeed.administration.PortalAdministration
All known Subclasses: org.apache.jetspeed.administration.PortalAdministrationImpl,
| PortalAdministration | | public interface PortalAdministration (Code) | | PortalAdministration
Aggregate portal administration functions:
- Emails
- Registration
- Password Generation
author:
David Sean Taylor
version:
$Id: $ |
| Method Summary | |
| String | generatePassword()
| | public Map | getNewLoginInfo(String guid)
| | String | getPortalURL(PortletRequest request, PortletResponse response, String path)
Provide a common way to get portal URLs
Necessary for generating return URLs for features such as
forgotten password. | | public User | lookupUserFromEmail(String email)
| | public void | putNewLoginInfo(String guid, Map info)
Parameters:
guid - the ID which is passed through the URL to the user.. | | void | registerUser(String userName, String password, List roles, List groups, Map userInfo, Map rules, String template, String subsiteFolder)
Registers and creates a new user, assigning userInfo, roles, groups,
profiling rules and a folder template. | | void | registerUser(String userName, String password, List roles, List groups, Map userInfo, Map rules, String template)
| | void | registerUser(String userName, String password)
| | public void | removeNewLoginInfo(String guid)
| | public void | sendEmail(PortletConfig portletConfig, String emailAddress, String localizedSubject, String templatePath, Map userAttributes)
| | public void | sendEmail(String from, String subject, String to, String text)
|
| generatePassword | | String generatePassword()(Code) | | Generate a unique password
unique password |
| getNewLoginInfo | | public Map getNewLoginInfo(String guid)(Code) | |
Parameters:
guid - The ID which is passed throughte URL to the user |
| getPortalURL | | String getPortalURL(PortletRequest request, PortletResponse response, String path)(Code) | | Provide a common way to get portal URLs
Necessary for generating return URLs for features such as
forgotten password. The URL generated will be a combination
of the Jetspeed base URL plus the path parameter appended
Example:
base URL = http://www.apache.org/jetspeed/portal
path = /system/forgotten-password.psml
Returns:
http://www.apache.org/jetspeed/portal/system/forgotten-password.psml
Parameters:
request - The portlet request.
Parameters:
response - The portlet response, used to encode the path
Parameters:
path - The relative path to a portal resource the base Jetspeed portal URL plus the appended path parameter |
| putNewLoginInfo | | public void putNewLoginInfo(String guid, Map info)(Code) | |
Parameters:
guid - the ID which is passed through the URL to the user..
Parameters:
info - a Map, info from which will be used to reset the passwordthe password in this case is NOT encrypted, but this should probablychange if this information is stored on disk... ie a database |
| registerUser | | void registerUser(String userName, String password, List roles, List groups, Map userInfo, Map rules, String template, String subsiteFolder) throws RegistrationException(Code) | | 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.
Parameters:
userName - Unique user principal identifier
Parameters:
password - Password for this user
Parameters:
roles - A list of roles to assign to this user
Parameters:
groups - A list of groups to assign to this user
Parameters:
userInfo - Portlet API User Information Attributes name value pairs (PLT.D)
Parameters:
rules - A map of name value pairs of profiling rules. Well known rules names are 'page' and 'menu'
Parameters:
folderTemplate - The full PSML path name of a folder to be deepcopied as the new user's set of folders, pages, links
Parameters:
subsite - The subsite folder to place the new user in
since:
2.1.2 |
| removeNewLoginInfo | | public void removeNewLoginInfo(String guid)(Code) | |
Parameters:
guid - the ID which will be removed from the storage when the info is no longer valid |
| sendEmail | | public void sendEmail(PortletConfig portletConfig, String emailAddress, String localizedSubject, String templatePath, Map userAttributes) throws AdministrationEmailException(Code) | | Helper to send an email to a recipient
Parameters:
recipient - the email address of the recipient
Parameters:
localizedSubject - the subject of the email as a localized string
Parameters:
message - the email message content
throws:
AdministrationEmailException - |
| sendEmail | | public void sendEmail(String from, String subject, String to, String text) throws AdministrationEmailException(Code) | | Helper to send an email to a recipient without the portal default sender, and without mail merge
Parameters:
from - the email address of the sender
Parameters:
subject - the subject of the email
Parameters:
to - the recipient email address
Parameters:
text - the message text
throws:
AdministrationEmailException - |
|
|