org.hawkular.accounts.api

Interface UserService

All Known Implementing Classes:

UserServiceImpl

public interface UserService

Provides an interface for querying and managing Hawkular users. Can be injected via CDI into managed beans as follows:

         @Inject UserService userService;
     

Concrete implementations do not hold any state, but it's advised to get an instance through CDI or as an EJB.

Author:

Juraci Paixão Kröhling

Method Summary

Modifier and Type	Method and Description
HawkularUser	getById(String id) Deprecated. Use getById(UUID) instead
HawkularUser	getById(UUID id) Retrieves an HawkularUser based in its ID.
HawkularUser	getCurrent() Retrieves the current user for the request.
HawkularUser	getOrCreateById(String id) Retrieves an HawkularUser based on its ID.
HawkularUser	getOrCreateByIdAndName(String id, String name) Retrieves an HawkularUser based on its ID.

Method Detail

getCurrent

HawkularUser getCurrent()

Retrieves the current user for the request. Before using this, make sure you don't mean to get the current Persona, which will be the correct choice most of the times.

Returns:

the current user

See Also:

PersonaService.getCurrent()

getById

@Deprecated
HawkularUser getById(String id)

Deprecated. Use getById(UUID) instead

Retrieves an HawkularUser based in its ID.

Parameters:

id - the user ID

Returns:

the existing user with the given ID or null if the user is not found.

getById

HawkularUser getById(UUID id)

Retrieves an HawkularUser based in its ID.

Parameters:

id - the user ID

Returns:

the existing user with the given ID or null if the user is not found.

getOrCreateById

HawkularUser getOrCreateById(String id)

Retrieves an HawkularUser based on its ID. If no user is found, a new one is created and returned.

Parameters:

id - the user ID

Returns:

an HawkularUser instance representing the user with the given ID. It's never null.

getOrCreateByIdAndName

HawkularUser getOrCreateByIdAndName(String id,
                                    String name)

Retrieves an HawkularUser based on its ID. If no user is found, a new one is created and returned. The name parameter is used only in case the user doesn't exist.

Parameters:

id - the user ID

name - the full name for the user. Used only if the user doesn't exist, when creating the new user.

Returns:

an HawkularUser instance representing the user with the given ID. It's never null.