com.atlassian.servicedesk.api.user

Interface UserFactory

@ParametersAreNullableByDefault
public interface UserFactory

Factory to handle conversions between SDUser and JIRA ApplicationUser classes.

For most APIs in Service Desk we only allow the usage for logged in users. As ApplicationUser is null for anonymous users the usage of SDUser and its subclasses is mandatory for these APIs. This allows APIs to be more specific that they need a logged in user.

This factory provides an easy way to convert ApplicationUser to subclasses

Method Summary

Modifier and Type	Method and Description
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CheckedUser>	getCheckedUser() Helper method to wrap getCurrentUserByType[CheckedUser].
UncheckedUser	getUncheckedUser() Helper method to wrap getCurrentUserByType[UncheckedUser].
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<com.atlassian.jira.user.ApplicationUser>>	unwrap(Collection<CheckedUser> checkedUsers) Map a list of CheckedUser to a list of ApplicationUser.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CheckedUser>	wrap(com.atlassian.jira.user.ApplicationUser appUser) Returns a CheckedUser from the application user or an error if an internal error occurred, or the ApplicationUser was null.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<CheckedUser>>	wrap(Collection<com.atlassian.jira.user.ApplicationUser> appUsers) Map a list of ApplicationUser to a list of CheckedUser.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,UncheckedUser>	wrapUnchecked(com.atlassian.jira.user.ApplicationUser appUser) Returns a UncheckedUser from the application user.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CheckedUser>	wrapUserKey(String userkey) This turns a user key into a JIRA Application User and then wraps it up.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CheckedUser>	wrapUsername(String username) This turns a username into a JIRA Application User and then wraps it up.
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<CheckedUser>>	wrapUsernames(Collection<String> usernames) This turns usernames into a JIRA Application User and then wraps them to CheckedUser.

Method Detail

wrap

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CheckedUser> wrap(com.atlassian.jira.user.ApplicationUser appUser)

Returns a CheckedUser from the application user or an error if an internal error occurred, or the ApplicationUser was null.

Parameters:

appUser - the application user

Returns:

a checked user or an error

wrapUnchecked

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,UncheckedUser> wrapUnchecked(com.atlassian.jira.user.ApplicationUser appUser)

Returns a UncheckedUser from the application user.

Parameters:

appUser - the application user

Returns:

should never occur

wrap

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<CheckedUser>> wrap(@Nonnull
                                                                                                                Collection<com.atlassian.jira.user.ApplicationUser> appUsers)

Map a list of ApplicationUser to a list of CheckedUser. Return an error if any ApplicationUser can't be mapped. Reverse of unwrap(Collection).

Parameters:

appUsers - collection of ApplicationUser to map

Returns:

a list of CheckedUser or an error if any ApplicationUser can't be mapped

wrapUsername

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CheckedUser> wrapUsername(String username)

This turns a username into a JIRA Application User and then wraps it up.

Parameters:

username - the username to be pimped up

Returns:

a CheckedUser with useful stuff attached

wrapUsernames

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<CheckedUser>> wrapUsernames(@Nonnull
                                                                                                                         Collection<String> usernames)

This turns usernames into a JIRA Application User and then wraps them to CheckedUser.

Parameters:

usernames - the username to be wrap

Returns:

list of CheckedUser

wrapUserKey

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CheckedUser> wrapUserKey(String userkey)

This turns a user key into a JIRA Application User and then wraps it up.

Parameters:

userkey - find the user by their key, to be pimped up

Returns:

an SDUser with useful stuff attached

getCheckedUser

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,CheckedUser> getCheckedUser()

Helper method to wrap getCurrentUserByType[CheckedUser].

Returns:

CheckedUser

getUncheckedUser

@Nonnull
UncheckedUser getUncheckedUser()

Helper method to wrap getCurrentUserByType[UncheckedUser].

Returns:

UncheckedUser

unwrap

@Nonnull
com.atlassian.fugue.Either<com.atlassian.pocketknife.api.commons.error.AnError,List<com.atlassian.jira.user.ApplicationUser>> unwrap(@Nonnull
                                                                                                                                              Collection<CheckedUser> checkedUsers)

Map a list of CheckedUser to a list of ApplicationUser. Return an error if any CheckedUser can't be mapped. Reverse of wrap(Collection).

Parameters:

checkedUsers - collection of CheckedUser to map

Returns:

a list of ApplicationUser or an error if any CheckedUser can't be mapped