org.nuxeo.ecm.platform.usermanager

Class UserManagerResolver

java.lang.Object

org.nuxeo.ecm.platform.usermanager.UserManagerResolver

All Implemented Interfaces:

ObjectResolver

public class UserManagerResolver
extends Object
implements ObjectResolver

This ObjectResolver allows to manage integrity for fields containing group or user references.

References should have a prefix. NuxeoPrincipal.PREFIX for users, NuxeoGroup.PREFIX for groups.

If only user or group are configured, the prefix is not needed but still supported. If noth user and group are configured, reference without prefix are resolved as user first.

To use it, put the following code in your schema XSD :

 <!-- user or group resolver -->
 <xs:simpleType name="userOrGroupReference">
   <xs:restriction base="xs:string" ref:resolver="userManagerResolver" />
 </xs:simpleType>

 <!-- user resolver -->
 <xs:simpleType name="userReference">
   <xs:restriction base="xs:string" ref:resolver="userManagerResolver" ref:type="user" />
 </xs:simpleType>

 <!-- group resolver -->
 <xs:simpleType name="groupReference">
   <xs:restriction base="xs:string" ref:resolver="userManagerResolver" ref:type="group" />
 </xs:simpleType>
 
 

Since:

7.1

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.core.schema.types.resolver.ObjectResolver

ObjectResolver.Helper

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_GROUP
static String	FILTER_USER
static String	INPUT_PARAM_FILTER
static String	NAME
static String	PARAM_INCLUDE_GROUPS
static String	PARAM_INCLUDE_USERS

Constructor Summary

Constructors

Constructor and Description
UserManagerResolver()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(Map<String,String> parameters) Configure this resolver.
<T> T	fetch(Class<T> type, Object value) Provides the entity referenced by a value, return the entity as expected type.
Object	fetch(Object value) Provides the entity referenced by a value.
String	getConstraintErrorMessage(Object invalidValue, Locale locale) Provides an error message to display when some invalid value does not match existing entity.
List<Class<?>>	getManagedClasses() Returns the resolved object types.
String	getName() Provides this resolver name.
Map<String,Serializable>	getParameters() Provides this resolver parameters.
Serializable	getReference(Object entity) Generates a reference to an entity.
UserManager	getUserManager()
boolean	isIncludingGroups()
boolean	isIncludingUsers()
boolean	validate(Object value) Validates some value references an existing entity.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INPUT_PARAM_FILTER

public static final String INPUT_PARAM_FILTER

See Also:

Constant Field Values

FILTER_GROUP

public static final String FILTER_GROUP

See Also:

Constant Field Values

FILTER_USER

public static final String FILTER_USER

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

PARAM_INCLUDE_USERS

public static final String PARAM_INCLUDE_USERS

See Also:

Constant Field Values

PARAM_INCLUDE_GROUPS

public static final String PARAM_INCLUDE_GROUPS

See Also:

Constant Field Values

Constructor Detail

UserManagerResolver

public UserManagerResolver()

Method Detail

getUserManager

public UserManager getUserManager()

getManagedClasses

public List<Class<?>> getManagedClasses()

Description copied from interface: ObjectResolver

Returns the resolved object types.

Specified by:

getManagedClasses in interface ObjectResolver

configure

public void configure(Map<String,String> parameters)
               throws IllegalStateException

Description copied from interface: ObjectResolver

Configure this resolver.

Specified by:

configure in interface ObjectResolver

Parameters:

parameters - A map of parameter whose keys are parameter names and map value are corresponding values.

Throws:

IllegalStateException - If this resolver is already configured.

getName

public String getName()
               throws IllegalStateException

Description copied from interface: ObjectResolver

Provides this resolver name.

Specified by:

getName in interface ObjectResolver

Returns:

The resolver name.

Throws:

IllegalStateException

getParameters

public Map<String,Serializable> getParameters()
                                       throws IllegalStateException

Description copied from interface: ObjectResolver

Provides this resolver parameters.

Specified by:

getParameters in interface ObjectResolver

Returns:

A map containing

Throws:

IllegalStateException

validate

public boolean validate(Object value)
                 throws IllegalStateException

Description copied from interface: ObjectResolver

Validates some value references an existing entity.

Specified by:

validate in interface ObjectResolver

Parameters:

value - The reference.

Returns:

true if value could be resolved as an existing external reference, false otherwise.

Throws:

IllegalStateException - If this resolver has not been configured.

fetch

public Object fetch(Object value)
             throws IllegalStateException

Description copied from interface: ObjectResolver

Provides the entity referenced by a value.

Specified by:

fetch in interface ObjectResolver

Parameters:

value - The reference.

Returns:

The referenced entity, null if no entity matches the value.

Throws:

IllegalStateException - If this resolver has not been configured.

fetch

public <T> T fetch(Class<T> type,
          Object value)
        throws IllegalStateException

Description copied from interface: ObjectResolver

Provides the entity referenced by a value, return the entity as expected type.

Specified by:

fetch in interface ObjectResolver

value - The reference.

Returns:

The referenced entity, null if no entity matches the value or if this entity cannot be converted as type.

Throws:

IllegalStateException - If this resolver has not been configured.

getReference

public Serializable getReference(Object entity)
                          throws IllegalStateException

Description copied from interface: ObjectResolver

Generates a reference to an entity.

Specified by:

getReference in interface ObjectResolver

Parameters:

entity - The entity.

Returns:

A reference to the entity or null if its not a managed entity type.

Throws:

IllegalStateException - If this resolver has not been configured.

getConstraintErrorMessage

public String getConstraintErrorMessage(Object invalidValue,
                               Locale locale)
                                 throws IllegalStateException

Description copied from interface: ObjectResolver

Provides an error message to display when some invalid value does not match existing entity.

Specified by:

getConstraintErrorMessage in interface ObjectResolver

Parameters:

invalidValue - The invalid value that don't match any entity.

locale - The language in which the message should be generated.

Returns:

A message in the specified language or

Throws:

IllegalStateException

isIncludingUsers

public boolean isIncludingUsers()
                         throws IllegalStateException

Throws:

IllegalStateException

isIncludingGroups

public boolean isIncludingGroups()
                          throws IllegalStateException

Throws:

IllegalStateException