org.eclipse.stardust.engine.api.ws

Interface IUserService

public interface IUserService

The UserService provides functionality for operating on CARNOT users. This includes: creating, modifying and invalidating users, and accessing user data. This class was generated by Apache CXF 2.6.1 2016-02-25T15:28:24.611+01:00 Generated source version: 2.6.1

Method Summary

Methods

Modifier and Type	Method and Description
DeputyXto	addDeputy(UserInfoXto user, UserInfoXto deputyUser, DeputyOptionsXto options) Adds a new deputy user for a given user.
UserXto	createUser(UserXto user) Creates a new user with default realm ID.
UserGroupXto	createUserGroup(UserGroupXto userGroup) Creates a new user group.
UserRealmXto	createUserRealm(String id, String name, String description) Creates a new user realm.
void	dropUserRealm(String id) Drops the user realm associated with the given ID.
void	generatePasswordResetToken(String realm, String account) Generates a token which is required to perform resetPassword.
DeputiesXto	getDeputies(UserInfoXto user) Returns a list of all deputy users for the given user.
UserXto	getSessionUser() Retrieves information on the current user.
UserXto	getUser(long oid) Retrieves the specified user by userOid.
UserGroupXto	getUserGroup(long oid) Retrieves the specified user group.
org.eclipse.stardust.engine.api.ws.GetUserRealmsResponse.UserRealmsXto	getUserRealms() Retrieves all existing user realms.
DeputiesXto	getUsersBeingDeputyFor(UserInfoXto deputyUser) Returns a list of all users for which the given user is an deputy user.
UserXto	invalidateUser(String accountId, String realmId) Invalidates the user with the specified account.
UserGroupXto	invalidateUserGroup(Long userGroupOid, String userGroupId) Invalidates the specified user group.
boolean	isInternalAuthentication() Checks if internal authentication is used.
boolean	isInternalAuthorization() Checks if internal authorization is used.
DeputyXto	modifyDeputy(UserInfoXto user, UserInfoXto deputyUser, DeputyOptionsXto options) Modifies an existing deputy user for a given user.
UserXto	modifyLoginUser(String oldPassword, String firstName, String lastName, String newPassword, String eMail) Modifies the current user.
UserXto	modifyUser(UserXto user, Boolean generatePassword) Modifies the specified user.
UserGroupXto	modifyUserGroup(UserGroupXto userGroup) Modifies the specified user group.
void	removeDeputy(UserInfoXto user, UserInfoXto deputyUser) Removes an existing deputy user for a given user.
void	resetPassword(String account, MapXto properties, String token) Resets the password of specified user by generated password according to configured password rules.

Method Detail

generatePasswordResetToken

@RequestWrapper(localName="generatePasswordResetToken",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GeneratePasswordResetToken")
@ResponseWrapper(localName="generatePasswordResetTokenResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GeneratePasswordResetTokenResponse")
void generatePasswordResetToken(String realm,
                                                                                                                               String account)
                                throws BpmFault

Generates a token which is required to perform resetPassword.

Throws:

BpmFault

getSessionUser

@RequestWrapper(localName="getSessionUser",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetSessionUser")
@ResponseWrapper(localName="getSessionUserResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetSessionUserResponse")
UserXto getSessionUser()
                       throws BpmFault

Retrieves information on the current user.

Throws:

BpmFault

getDeputies

@RequestWrapper(localName="getDeputies",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetDeputies")
@ResponseWrapper(localName="getDeputiesResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetDeputiesResponse")
DeputiesXto getDeputies(UserInfoXto user)
                        throws BpmFault

Returns a list of all deputy users for the given user.

Throws:

BpmFault

getUserRealms

@RequestWrapper(localName="getUserRealms",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetUserRealms")
@ResponseWrapper(localName="getUserRealmsResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetUserRealmsResponse")
org.eclipse.stardust.engine.api.ws.GetUserRealmsResponse.UserRealmsXto getUserRealms()
                                                                                     throws BpmFault

Retrieves all existing user realms.

Throws:

BpmFault

isInternalAuthentication

@RequestWrapper(localName="isInternalAuthentication",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.IsInternalAuthentication")
@ResponseWrapper(localName="isInternalAuthenticationResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.IsInternalAuthenticationResponse")
boolean isInternalAuthentication()
                                 throws BpmFault

Checks if internal authentication is used.

Throws:

BpmFault

createUser

@RequestWrapper(localName="createUser",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CreateUser")
@ResponseWrapper(localName="createUserResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CreateUserResponse")
UserXto createUser(UserXto user)
                   throws BpmFault

Creates a new user with default realm ID.

Throws:

BpmFault

getUserGroup

@RequestWrapper(localName="getUserGroup",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetUserGroup")
@ResponseWrapper(localName="getUserGroupResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetUserGroupResponse")
UserGroupXto getUserGroup(long oid)
                          throws BpmFault

Retrieves the specified user group.

Throws:

BpmFault

modifyLoginUser

@RequestWrapper(localName="modifyLoginUser",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ModifyLoginUser")
@ResponseWrapper(localName="modifyLoginUserResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ModifyLoginUserResponse")
UserXto modifyLoginUser(String oldPassword,
                                                                                                                       String firstName,
                                                                                                                       String lastName,
                                                                                                                       String newPassword,
                                                                                                                       String eMail)
                        throws BpmFault

Modifies the current user.

Throws:

BpmFault

getUser

@RequestWrapper(localName="getUser",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetUser")
@ResponseWrapper(localName="getUserResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetUserResponse")
UserXto getUser(long oid)
                throws BpmFault

Retrieves the specified user by userOid.

Throws:

BpmFault

dropUserRealm

@RequestWrapper(localName="dropUserRealm",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.DropUserRealm")
@ResponseWrapper(localName="dropUserRealmResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.DropUserRealmResponse")
void dropUserRealm(String id)
                   throws BpmFault

Drops the user realm associated with the given ID.

Throws:

BpmFault

createUserGroup

@RequestWrapper(localName="createUserGroup",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CreateUserGroup")
@ResponseWrapper(localName="createUserGroupResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CreateUserGroupResponse")
UserGroupXto createUserGroup(UserGroupXto userGroup)
                             throws BpmFault

Creates a new user group.

Throws:

BpmFault

invalidateUserGroup

@RequestWrapper(localName="invalidateUserGroup",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.InvalidateUserGroup")
@ResponseWrapper(localName="invalidateUserGroupResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.InvalidateUserGroupResponse")
UserGroupXto invalidateUserGroup(Long userGroupOid,
                                                                                                                                String userGroupId)
                                 throws BpmFault

Invalidates the specified user group.

Throws:

BpmFault

resetPassword

@RequestWrapper(localName="resetPassword",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ResetPassword")
@ResponseWrapper(localName="resetPasswordResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ResetPasswordResponse")
void resetPassword(String account,
                                                                                                                  MapXto properties,
                                                                                                                  String token)
                   throws BpmFault

Resets the password of specified user by generated password according to configured password rules.

Throws:

BpmFault

modifyDeputy

@RequestWrapper(localName="modifyDeputy",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ModifyDeputy")
@ResponseWrapper(localName="modifyDeputyResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ModifyDeputyResponse")
DeputyXto modifyDeputy(UserInfoXto user,
                                                                                                                      UserInfoXto deputyUser,
                                                                                                                      DeputyOptionsXto options)
                       throws BpmFault

Modifies an existing deputy user for a given user. This deputy user inherits for the defined time frame all grants from given user. The deputy user has to login again before changes become active.

Throws:

BpmFault

invalidateUser

@RequestWrapper(localName="invalidateUser",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.InvalidateUser")
@ResponseWrapper(localName="invalidateUserResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.InvalidateUserResponse")
UserXto invalidateUser(String accountId,
                                                                                                                      String realmId)
                       throws BpmFault

Invalidates the user with the specified account.

Throws:

BpmFault

addDeputy

@RequestWrapper(localName="addDeputy",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.AddDeputy")
@ResponseWrapper(localName="addDeputyResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.AddDeputyResponse")
DeputyXto addDeputy(UserInfoXto user,
                                                                                                                   UserInfoXto deputyUser,
                                                                                                                   DeputyOptionsXto options)
                    throws BpmFault

Adds a new deputy user for a given user. This deputy user inherits for the defined time frame all grants from given user. The deputy user has to login again before the inherited grants become active.

Throws:

BpmFault

isInternalAuthorization

@RequestWrapper(localName="isInternalAuthorization",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.IsInternalAuthorization")
@ResponseWrapper(localName="isInternalAuthorizationResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.IsInternalAuthorizationResponse")
boolean isInternalAuthorization()
                                throws BpmFault

Checks if internal authorization is used.

Throws:

BpmFault

modifyUserGroup

@RequestWrapper(localName="modifyUserGroup",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ModifyUserGroup")
@ResponseWrapper(localName="modifyUserGroupResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ModifyUserGroupResponse")
UserGroupXto modifyUserGroup(UserGroupXto userGroup)
                             throws BpmFault

Modifies the specified user group.

Throws:

BpmFault

removeDeputy

@RequestWrapper(localName="removeDeputy",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.RemoveDeputy")
@ResponseWrapper(localName="removeDeputyResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.RemoveDeputyResponse")
void removeDeputy(UserInfoXto user,
                                                                                                                 UserInfoXto deputyUser)
                  throws BpmFault

Removes an existing deputy user for a given user. All inherited grants from user are revoked from deputy user. The deputy user has to login again before changes become active.

Throws:

BpmFault

modifyUser

@RequestWrapper(localName="modifyUser",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.ModifyUser")
@ResponseWrapper(localName="modifyUserResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.ModifyUserResponse")
UserXto modifyUser(UserXto user,
                                                                                                                  Boolean generatePassword)
                   throws BpmFault

Modifies the specified user.

Throws:

BpmFault

createUserRealm

@RequestWrapper(localName="createUserRealm",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.CreateUserRealm")
@ResponseWrapper(localName="createUserRealmResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.CreateUserRealmResponse")
UserRealmXto createUserRealm(String id,
                                                                                                                            String name,
                                                                                                                            String description)
                             throws BpmFault

Creates a new user realm.

Throws:

BpmFault

getUsersBeingDeputyFor

@RequestWrapper(localName="getUsersBeingDeputyFor",
                targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                className="org.eclipse.stardust.engine.api.ws.GetUsersBeingDeputyFor")
@ResponseWrapper(localName="getUsersBeingDeputyForResponse",
                 targetNamespace="http://eclipse.org/stardust/ws/v2012a/api",
                 className="org.eclipse.stardust.engine.api.ws.GetUsersBeingDeputyForResponse")
DeputiesXto getUsersBeingDeputyFor(UserInfoXto deputyUser)
                                   throws BpmFault

Returns a list of all users for which the given user is an deputy user.

Throws:

BpmFault