Home > References

EBX.Manager Component Request Specification

For a general introduction, read document EBX.Manager Component.

Note: JavaDoc In Java language, this specification is not necessary, since the most simple and reliable way for building the HTTP request that will call Manager component is to use class com.orchestranetworks.ui.UIHttpManagerComponent.

 

Examples

 

Minimal URI:

http://localhost:8080/ebx/

Admin user is logged in and Reference branch is selected:

http://localhost:8080/ebx/?login=admin&password=admin&branch=Reference

Reference branch is selected and built-in validation service is accessed:

http://localhost:8080/ebx/?login=admin&password=admin&branch=Reference&service=@validation

The roles table in default directory is selected:

http://localhost:8080/ebx/?login=admin&password=admin&branch=Reference&instance=ebx-directory&xpath=/directory/roles

Interface for creating a new user in default directory:

http://localhost:8080/ebx/?login=admin&password=admin&branch=Reference&instance=ebx-directory&xpath=/directory/user&service=@creation

 

Specification

 

URI base

The default deployment requires a URL base that has the following form:

http://<host>[:<port>]/ebx/

Note: More formally, the URI base must refer to the servlet named com.onwbp.front.FrontServlet defined in the Web application ebx.war (see file /WEB-INF/web.xml in ebx.war).

User authentication and session information

 

Parameter Description Required
login and password, or user directory specific

Specifies user authentication properties.

The authentication process is the following:

  1. If both parameters login and password are specified, the method Directory.authenticateUserFromLoginPassword() is called. If user is not authenticated, an access denied page is returned.
  2. Else the method Directory.authenticateUserFromHttpRequest() is called (it is up to the specific directory to implement this method). If the method throws an exception, an access denied page is returned. If the method returns null (default implementation), the request is considered as not specifying authentication, so the next step is performed.
  3. The login/password page is returned to the user. When this page is submitted, the method Directory.authenticateUserFromLoginPassword() will be called.
 No (see description).

trackingInfo

Specifies tracking information of the new session.

Tracking information is logged in the audit trail. Additionnally it can be used for restricting access permissions programmatically (see class AccessRule)

No.

redirect

URL towards which the user will be redirected at the end of the component session, when he clicks on the "close" button.

 No.

configuration

Specifies the reference of the adaptation that is used for configuring EBX.Manager look and feel.

If it is not specified, the default adaptation is used (ebxmanager-1.0).

 No.

locale

 

Specifies the locale to use.

Value is either en-US or fr-FR.

 No, default is the locale registered for the user.

 

Entity and service selection

 

Parameter Description Required
branch

Selects the branch specified.

 No.
version

Selects the version specified.

 No.
instance

Selects the adaptation instance specified.

Value must be the reference of an adaptation that exists in the home selected.

No, unless xpath is specified.
xpath

Specifies a node selection in the instance.

Value must be a valid absolute location path in the adaptation instance selected. The notation must conform to a simplified XPath, in its abbreviated syntax.

For XPath syntax, see EBX.Manager XPath supported syntax

No.
service

Specifies the service to access.

A service is either specific, that is defined in the current schema, or built-in, that is provided by EBX.platform.

Available built-in services are:

  • @creation (table selected)
    The user is directed to a page for creating a new occurrence of the table specified by xpath parameter.
  • @validation (home or instance selected)
    The user is directed to the validation report of the home selected.
  • @merge (home selected)
    The user is directed to the merge user interface.
 No.

 

 

Home > References