net.bluemind.externaluser.service.internal

Class ExternalUserService

java.lang.Object

net.bluemind.externaluser.service.internal.ExternalUserService

All Implemented Interfaces:

IRestoreCrudSupport<ExternalUser>, IRestoreSupport<ExternalUser>, IExternalUser, IInCoreExternalUser, IGroupMember, IInCoreGroupMember

public class ExternalUserService
extends java.lang.Object
implements IInCoreExternalUser

Constructor Summary

Constructors

Constructor and Description
ExternalUserService(BmContext context, ItemValue<Domain> domain, Container externalUserContainer)

Method Summary

Modifier and Type	Method and Description
ItemValue<ExternalUser>	byExtId(java.lang.String extId) Fetch a ExternalUser by its external id.
void	create(java.lang.String uid, ExternalUser eu) Creates a new ExternalUser.
void	createWithExtId(java.lang.String uid, java.lang.String extId, ExternalUser externalUser) Creates a new ExternalUser with the given uid.
void	delete(java.lang.String externalUserUid) Delete an external user.
ExternalUser	get(java.lang.String uid)
ItemValue<ExternalUser>	getComplete(java.lang.String uid) Fetch a ExternalUser by its uid.
java.util.List<ItemValue<Group>>	memberOf(java.lang.String uid) Retrieves a list of all Groups this uid is member of.
java.util.List<java.lang.String>	memberOfGroups(java.lang.String uid) Retrieves a list of all Group uids this uid is member of.
void	restore(ItemValue<ExternalUser> item, boolean isCreate)
void	update(java.lang.String uid, ExternalUser externalUser) Modify an existing external user.
ValidationResult	validate(java.lang.String[] externalUserUids) Check that every uid corresponds to an existing group member

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalUserService

public ExternalUserService(BmContext context,
                           ItemValue<Domain> domain,
                           Container externalUserContainer)

Method Detail

create

public void create(java.lang.String uid,
                   ExternalUser eu)
            throws ServerFault

Description copied from interface: IExternalUser

Creates a new ExternalUser.

Specified by:

create in interface IExternalUser

Parameters:

uid - ExternalUser's unique id

eu - ExternalUser

Throws:

ServerFault - standard error object

createWithExtId

public void createWithExtId(java.lang.String uid,
                            java.lang.String extId,
                            ExternalUser externalUser)
                     throws ServerFault

Description copied from interface: IExternalUser

Creates a new ExternalUser with the given uid. Associates an external id to the ExternalUser.

Specified by:

createWithExtId in interface IExternalUser

Parameters:

uid - the ExternalUser's unique id

extId - an external id. Usually used to link the ExternalUser to an external system

externalUser - ExternalUser

Throws:

ServerFault - standard error object

update

public void update(java.lang.String uid,
                   ExternalUser externalUser)
            throws ServerFault

Description copied from interface: IExternalUser

Modify an existing external user.

Specified by:

update in interface IExternalUser

Parameters:

uid - ExternalUser's unique id

externalUser - updated ExternalUser

Throws:

ServerFault - standard error object

delete

public void delete(java.lang.String externalUserUid)
            throws ServerFault

Description copied from interface: IExternalUser

Delete an external user.

Specified by:

delete in interface IRestoreCrudSupport<ExternalUser>

Specified by:

delete in interface IExternalUser

Parameters:

externalUserUid - ExternalUser's unique id

Throws:

ServerFault

getComplete

public ItemValue<ExternalUser> getComplete(java.lang.String uid)
                                    throws ServerFault

Description copied from interface: IExternalUser

Fetch a ExternalUser by its uid.

Specified by:

getComplete in interface IExternalUser

Parameters:

uid - ExternalUser's unique id

Returns:

ExternalUser net.bluemind.core.container.api.ItemValue, or null if the ExternalUser does not exist

Throws:

ServerFault - standard error object

validate

public ValidationResult validate(java.lang.String[] externalUserUids)
                          throws ServerFault

Description copied from interface: IInCoreGroupMember

Check that every uid corresponds to an existing group member

Specified by:

validate in interface IInCoreGroupMember

Returns:

Throws:

ServerFault

memberOf

public java.util.List<ItemValue<Group>> memberOf(java.lang.String uid)
                                          throws ServerFault

Description copied from interface: IGroupMember

Retrieves a list of all Groups this uid is member of.

Specified by:

memberOf in interface IGroupMember

Parameters:

uid - the member's unique id

Returns:

a list of groups

Throws:

ServerFault - standard error object (unchecked exception)

memberOfGroups

public java.util.List<java.lang.String> memberOfGroups(java.lang.String uid)
                                                throws ServerFault

Description copied from interface: IGroupMember

Retrieves a list of all Group uids this uid is member of.

Specified by:

memberOfGroups in interface IGroupMember

Parameters:

uid - the member's unique id

Returns:

a list of Group uids

Throws:

ServerFault - standard error object (unchecked exception)

byExtId

public ItemValue<ExternalUser> byExtId(java.lang.String extId)
                                throws ServerFault

Description copied from interface: IExternalUser

Fetch a ExternalUser by its external id.

Specified by:

byExtId in interface IExternalUser

Parameters:

extId - the external user's external id. Usually used to link the ExternalUser to an external system

Returns:

ExternalUser net.bluemind.core.container.api.ItemValue, or null if the ExternalUser does not exist

Throws:

ServerFault - standard error object (unchecked exception)

get

public ExternalUser get(java.lang.String uid)

Specified by:

get in interface IRestoreSupport<ExternalUser>

restore

public void restore(ItemValue<ExternalUser> item,
                    boolean isCreate)

Specified by:

restore in interface IRestoreSupport<ExternalUser>