Package org.silverpeas.web.test.environment

Class SilverpeasTestEnvironment

java.lang.Object

org.silverpeas.web.test.environment.SilverpeasTestEnvironment

@Technical
@Bean
@Singleton
public class SilverpeasTestEnvironment
extends Object

This class allows to load easily a Silverpeas environment dedicated to the tests:

• Spaces
• Components
• Users
• etc.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_DOMAIN

Constructor Summary

Constructors

Constructor	Description
SilverpeasTestEnvironment()

Method Summary

Modifier and Type	Method	Description
void	addUser(UserDetail userDetail)	Adds a user.
User	createDefaultUser()	Creates a default user to use in the test case.
static SilverpeasTestEnvironment	get()	Gets the Silverpeas environment.
ComponentInst	getDummyPublicComponent()	Gets the dummy component created into database at start of the test.
String	getTokenOf(User userDetail)	Gets the token of a user that must be passed into the request header "Authorization" as a value of a bearer authorization scheme.
void	removeAllProfiles(ComponentInst componentInst)	Removes all the user profiles set for the specified component instance.
void	removeAllProfiles(SpaceInst spaceInst)	Removes all the user profiles set for the specified space instance.
void	updateComponent(ComponentInst componentInst)	Updates the database with the given component instance.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DOMAIN

public static final String DEFAULT_DOMAIN

See Also:

Constant Field Values

Constructor Detail

SilverpeasTestEnvironment

public SilverpeasTestEnvironment()

Method Detail

get

public static SilverpeasTestEnvironment get()

Gets the Silverpeas environment.

Returns:

the instance of the Silverpeas environment.

createDefaultUser

public User createDefaultUser()

Creates a default user to use in the test case.

Returns:

the detail about the user in use in the current test case.

addUser

public void addUser(UserDetail userDetail)

Adds a user.

getTokenOf

public String getTokenOf(User userDetail)

Gets the token of a user that must be passed into the request header "Authorization" as a value of a bearer authorization scheme.

Parameters:

userDetail - the user details for which the token is needed.

Returns:

the API token of the given user.

getDummyPublicComponent

public ComponentInst getDummyPublicComponent()

Gets the dummy component created into database at start of the test.

Returns:

a ComponentInst instance that represents the dummy component.

updateComponent

public void updateComponent(ComponentInst componentInst)

Updates the database with the given component instance.

Parameters:

componentInst - the ComponentInst instance

removeAllProfiles

public void removeAllProfiles(ComponentInst componentInst)

Removes all the user profiles set for the specified component instance. So, nobody will be authorized to access and to modify the contributions managed by the component instance.

Parameters:

componentInst - the component instance.

removeAllProfiles

public void removeAllProfiles(SpaceInst spaceInst)

Removes all the user profiles set for the specified space instance. So, nobody will be authorized to access the space and the component instances in it.

Parameters:

spaceInst - the space instance.