PrincipalViewHelper (Jahia Server Implementation 8.0.0.0 API)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`INHERITANCE`
`static String`	`NAME`
`static String`	`PERMISSIONS`
`static String`	`PRINCIPAL`
`static String`	`PROPERTIES`
`static String`	`PROVIDER`
`static String`	`SITEKEY`
`static String`	`SITETITLE`

Constructor Summary

Constructors
Constructor and Description
`PrincipalViewHelper(String[] textFormat)` Create the view helper with a given string format given by the following syntax : textFormat ::= (principal)? (permissions)? (provider)? (name)? (properties)? principal ::= "Principal" permissions ::= "Permissions" provider ::= "Provider," size name ::= "Name," size properties ::= "Properties," size size ::= number{2..n}

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getDisplayName(Object p)` Return a displayable name, using resource bundles for the guest user and group.
`static String`	`getDisplayName(Object p, Locale locale)` Return a displayable name, using resource bundles for the guest user and group.
`static String`	`getFullName(Object p)` Builds the full user name, which is build the following way : - for a Group, simply calls getDisplayName(p) - for a JahiaUser, if the firstName and lastName properties are defined, they are concatenated and this method returns that result.
`static String`	`getGroupDisplayName(String groupName)` Returns the displayable name for a group based on the group name.
`static String`	`getGroupDisplayName(String groupName, Locale locale)` Returns the displayable name for a group based on the group name.
`static Set<JCRGroupNode>`	`getGroupSearchResult(javax.servlet.ServletRequest request, String siteKey)` Get the group search result from the parameter form given by the request.
`static Set<JCRGroupNode>`	`getGroupSearchResult(String searchIn, String siteKey, String searchString, String[] searchInProps, String storedOn, String[] providers)`
`static Set<JCRGroupNode>`	`getGroupSearchResult(String searchIn, String siteKey, String searchString, String[] searchInProps, String storedOn, String[] providers, boolean includeGlobalUsers)`
`static String`	`getName(JCRNodeWrapper p, Integer size)` Construct a displayable principal name string
`static String`	`getPrincipal(JCRNodeWrapper p, Integer size)` Get the kind of principal given by one char u = user, g = group
`String`	`getPrincipalTextOption(JCRNodeWrapper p)` Prepare the princiapl string output for display according to the "textFormat".
`static char`	`getPrincipalType(Principal p)` Get the kind of principal given by one char u = user, g = group
`String`	`getPrincipalValueOption(Object p)` Prepare the "value" string output.
`static String`	`getProperties(JCRNodeWrapper p, Integer size)` Get a principal displayable properties.
`static String`	`getProvider(JCRNodeWrapper p, Integer size)` Construct a displayable provider name string
`static Set<JCRUserNode>`	`getSearchResult(javax.servlet.ServletRequest request)` Get the user search result from the parameter form given by the request.
`static Set<JCRUserNode>`	`getSearchResult(String searchIn, String searchString, String[] searchInProps, String storedOn, String[] providers)`
`static Set<JCRUserNode>`	`getSearchResult(String searchIn, String siteKey, String searchString, String[] searchInProps, String storedOn, String[] providers)`
`static Set<JCRUserNode>`	`getSearchResult(String searchIn, String siteKey, String searchString, String[] searchInProps, String storedOn, String[] providers, boolean includeGlobalUsers)`
`static String`	`getSiteKey(JCRNodeWrapper p, Integer size)` Construct a displayable site key string
`static String`	`getSiteTitle(JCRNodeWrapper p, Integer size)` Construct a displayable site title string
`static String`	`getUserDisplayName(String userName)` Returns the displayable name for a user based on the user name.
`static String`	`getUserDisplayName(String userName, Locale locale)` Returns the displayable name for a user based on the user name.
`static Set<JCRUserNode>`	`removeJahiaAdministrators(Set<JCRUserNode> users)` Utility method to remove from a set of users all the members of the Jahia Administrators group.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PRINCIPAL
```
public static final String PRINCIPAL
```
    See Also:
    
    Constant Field Values
  - PERMISSIONS
```
public static final String PERMISSIONS
```
    See Also:
    
    Constant Field Values
  - PROVIDER
```
public static final String PROVIDER
```
    See Also:
    
    Constant Field Values
  - SITEKEY
```
public static final String SITEKEY
```
    See Also:
    
    Constant Field Values
  - SITETITLE
```
public static final String SITETITLE
```
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
  - PROPERTIES
```
public static final String PROPERTIES
```
    See Also:
    
    Constant Field Values
  - INHERITANCE
```
public static final String INHERITANCE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PrincipalViewHelper
```
public PrincipalViewHelper(String[] textFormat)
```
    Create the view helper with a given string format given by the following syntax : textFormat ::= (principal)? (permissions)? (provider)? (name)? (properties)? principal ::= "Principal" permissions ::= "Permissions" provider ::= "Provider," size name ::= "Name," size properties ::= "Properties," size size ::= number{2..n}
    
    Parameters:
    
    textFormat - The string format given by the above syntax.
- Method Detail
  - getPrincipalTextOption
```
public String getPrincipalTextOption(JCRNodeWrapper p)
```
    Prepare the princiapl string output for display according to the "textFormat". N.B. Usually used in Jahia for the HTML "select" tag.
    
    Parameters:
    
    p - The principal (user or group) to format
    
    Returns:
    
    The principal formated
  - getPrincipalValueOption
```
public String getPrincipalValueOption(Object p)
```
    Prepare the "value" string output. N.B. Usually used in Jahia for the HTML "select" tag.
    
    Parameters:
    
    p - The principal (user or group) to format
    
    Returns:
    
    The user/group key depending from principal type.
  - getFullName
```
public static String getFullName(Object p)
```
    Builds the full user name, which is build the following way : - for a Group, simply calls getDisplayName(p) - for a JahiaUser, if the firstName and lastName properties are defined, they are concatenated and this method returns that result. If the properties don't exist, this is equivalent to getDisplayName(p)
    
    Parameters:
    
    p -
    
    Returns:
    
    See Also:
    
    getDisplayName(java.lang.Object)
  - getDisplayName
```
public static String getDisplayName(Object p)
```
    Return a displayable name, using resource bundles for the guest user and group.
    
    Parameters:
    
    p - the principal for which to build the displayable name
    
    Returns:
    
    a String containing the displayable name for the user, ready for display in the user interface
  - getDisplayName
```
public static String getDisplayName(Object p,
                                    Locale locale)
```
    Return a displayable name, using resource bundles for the guest user and group.
    
    Parameters:
    
    p - the principal for which to build the displayable name
    
    locale - the locale to use for looking up resource bundle values
    
    Returns:
    
    a String containing the displayable name for the user, ready for display in the user interface
  - getGroupDisplayName
```
public static String getGroupDisplayName(String groupName)
```
    Returns the displayable name for a group based on the group name. This method will for the moment only use resource bundle to localized the guest group name.
    
    Parameters:
    
    groupName - the group name to localize
    
    Returns:
    
    the localized name for the group
  - getGroupDisplayName
```
public static String getGroupDisplayName(String groupName,
                                         Locale locale)
```
    Returns the displayable name for a group based on the group name. This method will for the moment only use resource bundle to localized the guest group name.
    
    Parameters:
    
    groupName - the group name to localize
    
    locale - the locale to use for looking up resource bundle values
    
    Returns:
    
    the localized name for the group
  - getUserDisplayName
```
public static String getUserDisplayName(String userName)
```
    Returns the displayable name for a user based on the user name. This method will for the moment only use a resource bundle lookup to localize the guest user name.
    
    Parameters:
    
    userName - the user name to localize
    
    Returns:
    
    the localized user name
  - getUserDisplayName
```
public static String getUserDisplayName(String userName,
                                        Locale locale)
```
    Returns the displayable name for a user based on the user name. This method will for the moment only use a resource bundle lookup to localize the guest user name.
    
    Parameters:
    
    userName - the user name to localize
    
    locale - the locale to use for looking up resource bundle values
    
    Returns:
    
    the localized user name
  - getName
```
public static String getName(JCRNodeWrapper p,
                             Integer size)
```
    Construct a displayable principal name string
    
    Parameters:
    
    p - The user object
    
    size - The principal string size that should be displayed.
    
    Returns:
    
    The displayable principal string.
  - getProvider
```
public static String getProvider(JCRNodeWrapper p,
                                 Integer size)
```
    Construct a displayable provider name string
    
    Parameters:
    
    p - The principal object
    
    size - The provider string size that should be displayed.
    
    Returns:
    
    The displayable provider string.
  - getSiteKey
```
public static String getSiteKey(JCRNodeWrapper p,
                                Integer size)
                         throws javax.jcr.RepositoryException
```
    Construct a displayable site key string
    
    Parameters:
    
    p - The principal object
    
    size - The provider string size that should be displayed.
    
    Returns:
    
    The displayable site key string
    
    Throws:
    
    javax.jcr.RepositoryException
  - getSiteTitle
```
public static String getSiteTitle(JCRNodeWrapper p,
                                  Integer size)
                           throws javax.jcr.RepositoryException
```
    Construct a displayable site title string
    
    Parameters:
    
    p - The principal object
    
    size - The provider string size that should be displayed.
    
    Returns:
    
    The displayable site title string
    
    Throws:
    
    javax.jcr.RepositoryException
  - getPrincipal
```
public static String getPrincipal(JCRNodeWrapper p,
                                  Integer size)
```
    Get the kind of principal given by one char u = user, g = group
    
    Parameters:
    
    p - The principal object
    
    size - For method call compatibility
    
    Returns:
    
    The principal type
  - getPrincipalType
```
public static char getPrincipalType(Principal p)
```
    Get the kind of principal given by one char u = user, g = group
    
    Parameters:
    
    p - The principal object
    
    Returns:
    
    The principal type
    
    Since:
    
    7.0
  - getProperties
```
public static String getProperties(JCRNodeWrapper p,
                                   Integer size)
```
    Get a principal displayable properties. A user displays its first name and a last name or e-mail to display. A group should displays its users or groups.
    
    Parameters:
    
    p - The principal object
    
    size - The size the properties should be displayed
    
    Returns:
    
    The displayable properties.
  - getSearchResult
```
public static Set<JCRUserNode> getSearchResult(javax.servlet.ServletRequest request)
```
    Get the user search result from the parameter form given by the request. If the form is not in the request then all the Jahia users will be search.
    
    Parameters:
    
    request - the request that should contain the HTML formular with the following fields : - searchString - searchIn - properties - storedOn - providers
    
    Returns:
    
    a Properties object that contain the search criterium
  - getSearchResult
```
public static Set<JCRUserNode> getSearchResult(String searchIn,
                                               String searchString,
                                               String[] searchInProps,
                                               String storedOn,
                                               String[] providers)
```
  - getSearchResult
```
public static Set<JCRUserNode> getSearchResult(String searchIn,
                                               String siteKey,
                                               String searchString,
                                               String[] searchInProps,
                                               String storedOn,
                                               String[] providers)
```
  - getSearchResult
```
public static Set<JCRUserNode> getSearchResult(String searchIn,
                                               String siteKey,
                                               String searchString,
                                               String[] searchInProps,
                                               String storedOn,
                                               String[] providers,
                                               boolean includeGlobalUsers)
```
  - getGroupSearchResult
```
public static Set<JCRGroupNode> getGroupSearchResult(javax.servlet.ServletRequest request,
                                                     String siteKey)
```
    Get the group search result from the parameter form given by the request. If the form is not in the request then all the Jahia groups will be search.
    
    Parameters:
    
    request - the request that should contain the HTML formular with the following fields : - searchString - searchIn - properties - storedOn - providers
    
    siteKey - The site ID containing the principal to search
    
    Returns:
    
    a Properties object that contain the search criterium
  - getGroupSearchResult
```
public static Set<JCRGroupNode> getGroupSearchResult(String searchIn,
                                                     String siteKey,
                                                     String searchString,
                                                     String[] searchInProps,
                                                     String storedOn,
                                                     String[] providers)
```
  - getGroupSearchResult
```
public static Set<JCRGroupNode> getGroupSearchResult(String searchIn,
                                                     String siteKey,
                                                     String searchString,
                                                     String[] searchInProps,
                                                     String storedOn,
                                                     String[] providers,
                                                     boolean includeGlobalUsers)
```
  - removeJahiaAdministrators
```
public static Set<JCRUserNode> removeJahiaAdministrators(Set<JCRUserNode> users)
```
    Utility method to remove from a set of users all the members of the Jahia Administrators group. This is used when we don't want to display this set of users.
    
    Parameters:
    
    users - a set of users that we will remove the Jahia administrators from
    
    Returns:
    
    a set of users without the Jahia Administrators

Class PrincipalViewHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRINCIPAL

PERMISSIONS

PROVIDER

SITEKEY

SITETITLE

NAME

PROPERTIES

INHERITANCE

Constructor Detail

PrincipalViewHelper

Method Detail

getPrincipalTextOption

getPrincipalValueOption

getFullName

getDisplayName

getDisplayName

getGroupDisplayName

getGroupDisplayName

getUserDisplayName

getUserDisplayName

getName

getProvider

getSiteKey

getSiteTitle

getPrincipal

getPrincipalType

getProperties

getSearchResult

getSearchResult

getSearchResult

getSearchResult

getGroupSearchResult

getGroupSearchResult

getGroupSearchResult

removeJahiaAdministrators