Friday, July 6, 2012

How can you read Sign in User information in Portlets?

User attributes are defined in portlet.xml (using the <user-attribute> elements) and are made available as a request attribute by the portlet container to the portlets.

The name of the request attribute is the value of the PortletRequest interface’s USER_INFO constant. Portlets can obtain user attributes from the request and display them in the portlet or use it in processing the request

In Portlet.xml

<user-attribute>
        <description>user first name</description>
        <name>user.name.given</name>
    </user-attribute>
    <user-attribute>
        <description>user last name</description>
        <name>user.name.family</name>
   </user-attribute>


In The portlet  classm

Map<String, Object> userAttributeMap =
(Map<String, Object>)request.getAttribute(PortletRequest.USER_INFO)
String firstName = (String)userAttributeMap.get("user.name.given");


Possible User attribute names defined in PortletRequest's inner class


USER_BDATE_FRACTIONSECOND
           
USER_BDATE_HMS_HOUR
           
USER_BDATE_HMS_MINUTE
           
USER_BDATE_HMS_SECOND
           
USER_BDATE_TIMEZONE
           
USER_BDATE_YMD_DAY
           
USER_BDATE_YMD_MONTH
           
USER_BDATE_YMD_YEAR
           
USER_BUSINESSINFO_ONLINE_EMAIL
           
USER_BUSINESSINFO_ONLINE_URI
           
USER_BUSINESSINFO_POSTAL_CITY
           
USER_BUSINESSINFO_POSTAL_COUNTRY
           
USER_BUSINESSINFO_POSTAL_NAME
           
USER_BUSINESSINFO_POSTAL_ORGANIZATION
           
USER_BUSINESSINFO_POSTAL_POSTALCODE
           
USER_BUSINESSINFO_POSTAL_STATEPROV
           
USER_BUSINESSINFO_POSTAL_STREET
           
USER_BUSINESSINFO_TELECOM_FAX_COMMENT
           
USER_BUSINESSINFO_TELECOM_FAX_EXT
           
USER_BUSINESSINFO_TELECOM_FAX_INTCODE
           
USER_BUSINESSINFO_TELECOM_FAX_LOCCODE
           
USER_BUSINESSINFO_TELECOM_FAX_NUMBER
           
USER_BUSINESSINFO_TELECOM_MOBILE_COMMENT
           
USER_BUSINESSINFO_TELECOM_MOBILE_EXT
           
USER_BUSINESSINFO_TELECOM_MOBILE_INTCODE
           
USER_BUSINESSINFO_TELECOM_MOBILE_LOCCODE
           
USER_BUSINESSINFO_TELECOM_MOBILE_NUMBER
           
USER_BUSINESSINFO_TELECOM_PAGER_COMMENT
           
USER_BUSINESSINFO_TELECOM_PAGER_EXT
           
USER_BUSINESSINFO_TELECOM_PAGER_INTCODE
           
USER_BUSINESSINFO_TELECOM_PAGER_LOCCODE
           
USER_BUSINESSINFO_TELECOM_PAGER_NUMBER
           
USER_BUSINESSINFO_TELECOM_TELEPHONE_COMMENT
           
USER_BUSINESSINFO_TELECOM_TELEPHONE_EXT
           
USER_BUSINESSINFO_TELECOM_TELEPHONE_INTCODE
           
USER_BUSINESSINFO_TELECOM_TELEPHONE_LOCCODE
           
USER_BUSINESSINFO_TELECOM_TELEPHONE_NUMBER
           
USER_DEPARTMENT
           
USER_EMPLOYER
           
USER_GENDER
           
USER_HOMEINFO_ONLINE_EMAIL
           
USER_HOMEINFO_ONLINE_URI
           
USER_HOMEINFO_POSTAL_CITY
           
USER_HOMEINFO_POSTAL_COUNTRY
           
USER_HOMEINFO_POSTAL_NAME
           
USER_HOMEINFO_POSTAL_ORGANIZATION
           
USER_HOMEINFO_POSTAL_POSTALCODE
           
USER_HOMEINFO_POSTAL_STATEPROV
           
USER_HOMEINFO_POSTAL_STREET
           
USER_HOMEINFO_TELECOM_FAX_COMMENT
           
USER_HOMEINFO_TELECOM_FAX_EXT
           
USER_HOMEINFO_TELECOM_FAX_INTCODE
           
USER_HOMEINFO_TELECOM_FAX_LOCCODE
           
USER_HOMEINFO_TELECOM_FAX_NUMBER
           
USER_HOMEINFO_TELECOM_MOBILE_COMMENT
           
USER_HOMEINFO_TELECOM_MOBILE_EXT
           
USER_HOMEINFO_TELECOM_MOBILE_INTCODE
           
USER_HOMEINFO_TELECOM_MOBILE_LOCCODE
           
USER_HOMEINFO_TELECOM_MOBILE_NUMBER
           
USER_HOMEINFO_TELECOM_PAGER_COMMENT
           
USER_HOMEINFO_TELECOM_PAGER_EXT
           
USER_HOMEINFO_TELECOM_PAGER_INTCODE
           
USER_HOMEINFO_TELECOM_PAGER_LOCCODE
           
USER_HOMEINFO_TELECOM_PAGER_NUMBER
           
USER_HOMEINFO_TELECOM_TELEPHONE_COMMENT
           
USER_HOMEINFO_TELECOM_TELEPHONE_EXT
           
USER_HOMEINFO_TELECOM_TELEPHONE_INTCODE
           
USER_HOMEINFO_TELECOM_TELEPHONE_LOCCODE
           
USER_HOMEINFO_TELECOM_TELEPHONE_NUMBER
           
USER_JOBTITLE
           
USER_LOGIN_ID
           
USER_NAME_FAMILY
           
USER_NAME_GIVEN
           
USER_NAME_MIDDLE
           
USER_NAME_NICKNAME
           
USER_NAME_PREFIX
           
USER_NAME_SUFFIX

No comments:

Post a Comment