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 2013-03-05T11:35:31.460+01:00 Generated source version: 2.6.1

Method Summary

UserXto	createUser(UserXto user) Creates a new user with default realm ID.
UserGroupXto	createUserGroup(UserGroupXto userGroup) Creates a new user group.
UserRealmXto	createUserRealm(java.lang.String id, java.lang.String name, java.lang.String description) Creates a new user realm.
void	dropUserRealm(java.lang.String id) Drops the user realm associated with the given ID.
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.
UserXto	invalidateUser(java.lang.String accountId, java.lang.String realmId) Invalidates the user with the specified account.
UserGroupXto	invalidateUserGroup(java.lang.Long userGroupOid, java.lang.String userGroupId) Invalidates the specified user group.
boolean	isInternalAuthentication() Checks if internal authentication is used.
boolean	isInternalAuthorization() Checks if internal authorization is used.
UserXto	modifyUser(UserXto user, java.lang.Boolean generatePassword) Modifies the specified user.
UserGroupXto	modifyUserGroup(UserGroupXto userGroup) Modifies the specified user group.
void	resetPassword(java.lang.String account, MapXto properties) Resets the password of specified user by generated password according to configured password rules.

Method Detail

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

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

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

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

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(java.lang.String id)
                   throws BpmFault

Drops the user realm associated with the given ID.

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(java.lang.String id,
                                                            java.lang.String name,
                                                            java.lang.String description)
                             throws BpmFault

Creates a new user realm.

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(java.lang.Long userGroupOid,
                                                                java.lang.String userGroupId)
                                 throws BpmFault

Invalidates the specified user group.

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,
                                                  java.lang.Boolean generatePassword)
                   throws BpmFault

Modifies the specified user.

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(java.lang.String account,
                                                  MapXto properties)
                   throws BpmFault

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

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(java.lang.String accountId,
                                                      java.lang.String realmId)
                       throws BpmFault

Invalidates the user with the specified account.

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