Package org.silverpeas.core.webapi.wbe

Class WbeFileEdition

java.lang.Object

org.silverpeas.core.webapi.wbe.WbeFileEdition

@Bean
public class WbeFileEdition
extends Object

In charge of the management of WBE contexts.

The exposed signatures permits to caller to initialize a WBE edition.

WBE services can use directly the implementation of this interface in order to get more functionality.

Author:

silveryocha

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WbeFileEdition.ClientRequestDispatcher

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACCESS_TOKEN_PARAM

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WbeFileEdition()

Method Summary

Modifier and Type	Method	Description
static WbeFileEdition	get()
Optional<String>	initializeWith(javax.servlet.http.HttpServletRequest request, WbeFile file)	Initializing a WBE edition from given data.
Optional<String>	initializeWith(javax.servlet.http.HttpServletRequest request, WbeFile file, Consumer<WbeEdition.Configuration> configSetter)	Initializing a WBE edition from given data.

Methods inherited from class java.lang.Object

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

Field Detail

ACCESS_TOKEN_PARAM

public static final String ACCESS_TOKEN_PARAM

See Also:

Constant Field Values

Constructor Detail

WbeFileEdition

protected WbeFileEdition()

Method Detail

get

public static WbeFileEdition get()

initializeWith

public Optional<String> initializeWith(javax.servlet.http.HttpServletRequest request,
                                       WbeFile file)

Initializing a WBE edition from given data.

Parameters:

request - the current request from which the edition is started.

file - a Silverpeas's WBE file.

Returns:

an optional URL of the Silverpeas's editor page.

initializeWith

public Optional<String> initializeWith(javax.servlet.http.HttpServletRequest request,
                                       WbeFile file,
                                       Consumer<WbeEdition.Configuration> configSetter)

Initializing a WBE edition from given data.

Parameters:

request - the current request from which the edition is started.

file - a Silverpeas's WBE file.

configSetter - permits to configure some details of the edition.

Returns:

an optional URL of the Silverpeas's editor page.