org.apache.jetspeed.administration

Interface PortalAdministration

public interface PortalAdministration

PortalAdministration Aggregate portal administration functions are controlled with this service. Administrative services include:

• - Emails delivery services
• - User Registration services and options
• - Password Generation services

Version:

$Id: $

Author:

David Sean Taylor

Method Summary

Methods

Modifier and Type	Method and Description
String	generatePassword() Generate a unique password following the credential policy of the Password Generator service
String	getBaseFolderPath(String userName, Locale locale, String serverName) Deprecated.
Map<String,String>	getNewLoginInfo(String guid) Administrative portlets, like the forgotten password admin, need to track login information such as temporary links to recovery temporary passwords.
String	getPortalURL(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, String path) Provides a common way to generating portal URLs.
String	getUserFolderPath(String userName, Locale locale, String serverName) Deprecated.
boolean	isAdminUser(javax.portlet.PortletRequest request) Returns true if the current request is made by the special portal admin user.
boolean	isUserInAdminRole(javax.portlet.PortletRequest request) Returns true if the current request user principal is made by a user in the portal admin role
User	lookupUserFromEmail(String email) Lookup a Jetspeed user, given an email address
void	putNewLoginInfo(String guid, Map<String,String> info) Administrative portlets, like the forgotten password admin, need to track login information such as temporary links to recovery temporary passwords.
void	registerUser(String userName, String password) Register a new user using all default values
void	registerUser(String userName, String password, List<String> roles, List<String> groups, Map<String,String> userInfo, Map<String,String> rules, String template) Registers and creates a new user, assigning userInfo, roles, groups, profiling rules and a folder template.
void	registerUser(String userName, String password, List<String> roles, List<String> groups, Map<String,String> userInfo, Map<String,String> 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<String> roles, List<String> groups, Map<String,String> userInfo, Map<String,String> rules, String folderTemplate, String subsite, Locale locale, String serverName) Registers and creates a new user, assigning userInfo, roles, groups, profiling rules and a folder template.
void	removeNewLoginInfo(String guid) Administrative portlets, like the forgotten password admin, need to track login information such as temporary links to recovery temporary passwords.
void	sendEmail(javax.portlet.PortletConfig portletConfig, String emailAddress, String localizedSubject, String template, Map<String,String> userAttributes) Using the portal's email configuration settings, sends an email to a mail recipient.
void	sendEmail(String from, String subject, String to, String text) Using the portal's email configuration, sends a simple email to a mail recipient.

Method Detail

registerUser

void registerUser(String userName,
                String password,
                List<String> roles,
                List<String> groups,
                Map<String,String> userInfo,
                Map<String,String> rules,
                String folderTemplate,
                String subsite,
                Locale locale,
                String serverName)
                  throws RegistrationException

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

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'

folderTemplate - The full PSML path name of a folder to be deep copied as the new user's set of folders, pages, links

subsite - The subsite folder to place the new user in

locale - Optional locale used to compute new user folder path if subsite not specified

serverName - Server name used to compute new user folder path if subsite not specified

Throws:

RegistrationException

Since:

2.1.2

registerUser

void registerUser(String userName,
                String password,
                List<String> roles,
                List<String> groups,
                Map<String,String> userInfo,
                Map<String,String> rules,
                String template,
                String subsiteFolder)
                  throws RegistrationException

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

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'

template - The full PSML path name of a folder to be deep copied as the new user's set of folders, pages, links

subsiteFolder - The subsite folder to place the new user in

Throws:

RegistrationException

registerUser

void registerUser(String userName,
                String password,
                List<String> roles,
                List<String> groups,
                Map<String,String> userInfo,
                Map<String,String> rules,
                String template)
                  throws RegistrationException

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

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'

template - The full PSML path name of a folder to be deep copied as the new user's set of folders, pages, links

Throws:

RegistrationException

registerUser

void registerUser(String userName,
                String password)
                  throws RegistrationException

Register a new user using all default values

Parameters:

userName - Unique user principal identifier

password - Password for this user

Throws:

RegistrationException

generatePassword

String generatePassword()

Generate a unique password following the credential policy of the Password Generator service

Returns:

the unique password

sendEmail

void sendEmail(javax.portlet.PortletConfig portletConfig,
             String emailAddress,
             String localizedSubject,
             String template,
             Map<String,String> userAttributes)
               throws AdministrationEmailException

Using the portal's email configuration settings, sends an email to a mail recipient. Does a mail merge using the userAttributes parameter for merged values, merging into the mail body from the configured email template

Parameters:

portletConfig - portlet configuration

emailAddress - the email address of the recipient

localizedSubject - the subject of the email as a localized string

template - portal relative path to the template used to do the mail merge

userAttributes - map of user attributes to substitute into template

Throws:

AdministrationEmailException

sendEmail

void sendEmail(String from,
             String subject,
             String to,
             String text)
               throws AdministrationEmailException

Using the portal's email configuration, sends a simple email to a mail recipient. Does not do a mail merge, simply sends the text parameter as the mail body.

Parameters:

from - the email address of the sender

subject - the subject of the email

to - the recipient email address

text - the message text

Throws:

AdministrationEmailException

lookupUserFromEmail

User lookupUserFromEmail(String email)
                         throws AdministrationEmailException

Lookup a Jetspeed user, given an email address

Parameters:

email - Given email address

Returns:

a Jetspeed User or throw exception if not found

Throws:

AdministrationEmailException

getPortalURL

String getPortalURL(javax.portlet.PortletRequest request,
                  javax.portlet.PortletResponse response,
                  String path)

Provides a common way to generating portal URLs. Generates 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. For example, the following idiom

 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.

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

Map<String,String> getNewLoginInfo(String guid)

Administrative portlets, like the forgotten password admin, need to track login information such as temporary links to recovery temporary passwords. This method takes a GUID and looks up the application specific login information associated with that GUID. This information is normally temporary and may have a short-lived lifespan.

Parameters:

guid - the temporary identifier to associate with the login information

Returns:

the new login information associated with the guid

putNewLoginInfo

void putNewLoginInfo(String guid,
                   Map<String,String> info)

Administrative portlets, like the forgotten password admin, need to track login information such as temporary links to recovery temporary passwords. This method takes a GUID and stores the the provided application specific login information associated with that GUID. This information is normally temporary and may have a short-lived lifespan.

Parameters:

guid - the temporary identifier to associate with the login information

info - a Map of login information specific to application

removeNewLoginInfo

void removeNewLoginInfo(String guid)

Administrative portlets, like the forgotten password admin, need to track login information such as temporary links to recovery temporary passwords. This method takes a GUID and removes application specific login information associated with that GUID. This information is normally temporary and may have a short-lived lifespan.

Parameters:

guid - the temporary identifier to associate with the login information

isAdminUser

boolean isAdminUser(javax.portlet.PortletRequest request)

Returns true if the current request is made by the special portal admin user.

Parameters:

request - the PortletRequest to check the user principal on

Returns:

true if this request is made by the portal admin user

See Also:

PortalConfigurationConstants.USERS_DEFAULT_ADMIN

isUserInAdminRole

boolean isUserInAdminRole(javax.portlet.PortletRequest request)

Returns true if the current request user principal is made by a user in the portal admin role

Parameters:

request - the PortletRequest to check the user principal on

Returns:

true if this request is made by a user with the portal admin role

See Also:

PortalConfigurationConstants.ROLES_DEFAULT_ADMIN

getUserFolderPath

String getUserFolderPath(String userName,
                       Locale locale,
                       String serverName)

Deprecated.

Returns a PSML path to the root user folder for the specified user by running the full profiler and portal site rules.

Parameters:

userName - the portal user name

locale - optional locale, (defaults to system locale, for language profiling rules)

serverName - server name, (required for subsite profiling rules)

Returns:

a normalized PSML user folder path

getBaseFolderPath

String getBaseFolderPath(String userName,
                       Locale locale,
                       String serverName)

Deprecated.

Returns a PSML path to the base user folder for the specified user by running the full profiler and portal site rules.

Parameters:

userName - existing portal user name

locale - optional locale, (defaults to system locale, for language profiling rules)

serverName - server name, (required for subsite profiling rules)

Returns:

a normalized PSML user folder path