Package ch.ivyteam.ivy.bpm.engine.client

Class SessionChooser

java.lang.Object

ch.ivyteam.ivy.bpm.engine.client.SessionChooser

public class SessionChooser
extends Object

Defines the session that is used to execute the request

Since:

9.1

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
RequestBuilder	anonymous()	Execute the request as anonymous user
RequestBuilder	anonymousWithRole(IRole role)	Execute the request as anonymous session but with the given role assigned
RequestBuilder	anonymousWithRole(String roleName)	Execute the request with as anonymous session but with the role assigned given by the role name.
RequestBuilder	everybody()	Execute the request as role Everybody
RequestBuilder	role(IRole role)	Execute the request as the given role
RequestBuilder	role(String roleName)	Execute the request as role with the given role name
RequestBuilder	systemUser()	Execute the request as system user
RequestBuilder	user(IUser user)	Execute the request as the given user
RequestBuilder	user(String userName)	Execute the request as user with the given user name

Method Detail

user

public RequestBuilder user(String userName)

Execute the request as user with the given user name

Parameters:

userName - name of the user

Returns:

request builder for further request construction

Throws:

IllegalArgumentException - if user is not found

API:

This public API is available in Java.

user

public RequestBuilder user(IUser user)

Execute the request as the given user

Parameters:

user -

Returns:

request builder for further request construction

API:

This public API is available in Java.

systemUser

public RequestBuilder systemUser()

Execute the request as system user

Returns:

request builder for further request construction

API:

This public API is available in Java.

role

public RequestBuilder role(String roleName)

Execute the request as role with the given role name

Parameters:

roleName -

Returns:

request builder for further request construction

API:

This public API is available in Java.

role

public RequestBuilder role(IRole role)

Execute the request as the given role

Parameters:

role -

Returns:

request builder for further request construction

API:

This public API is available in Java.

everybody

public RequestBuilder everybody()

Execute the request as role Everybody

Returns:

request builder for further request construction

API:

This public API is available in Java.

anonymous

public RequestBuilder anonymous()

Execute the request as anonymous user

Returns:

request builder for further request construction

API:

This public API is available in Java.

anonymousWithRole

public RequestBuilder anonymousWithRole(IRole role)

Execute the request as anonymous session but with the given role assigned

Returns:

request builder for further request construction

See Also:

ISession.assignRole(IRole)

API:

This public API is available in Java.

anonymousWithRole

public RequestBuilder anonymousWithRole(String roleName)

Execute the request with as anonymous session but with the role assigned given by the role name.

Parameters:

roleName - name of the role

Returns:

request builder for further request construction

Throws:

IllegalArgumentException - if role is not found

See Also:

ISession.assignRole(IRole)

API:

This public API is available in Java.