UserProfileService (interface)

Provides the ability to return supplementary metadata about the current user.

API

UserProfileService.java
interface UserProfileService {
  String userProfileName()     (1)
}
1 userProfileName()

Returns an alternate name for the current user.

Members

userProfileName()

Returns an alternate name for the current user.

In the Wicket viewer, used as the menu name of the org.apache.isis.applib.annotation.DomainServiceLayout.MenuBar#TERTIARY tertiary "Me" menu bar.

If returns null , then the current user name is used instead.

Implementation

The framework provides a default implementation of this service, o.a.i.core.runtimeservices.UserProfileServiceDefault. This simply returns the user’s name as the user’s profile name.

Usage within the framework

This service provides the ability for the domain application to return supplementary metadata about the current user.

The Web UI (Wicket viewer) uses this to customize the appearance of the tertiary "Me" menu bar (top right). For example, rather than display the username, instead the user’s first and last name could be displayed.

This feature does not integrate with Apache Isis' authentication mechanisms; the information returned is used purely for presentation purposes.

In the future this API may be expanded; one obvious possibility is to return a profile photo or avatar URL.