Cloud Software Group, Inc. EBX®
TIBCO EBX® Documentation
Navigation mode Release Notes

# 5.9 Java API changes

- This document lists the Java API changes made in this release. The comparison is performed between the current version and 5.8.1 [v1067].

## Added elements

### com.onwbp.adaptation

- Adaptation.getDatasetReference()

  Returns the reference that uniquely identifies this dataset in its dataspace.

- Adaptation.getValidationReport(ValidationSpec)

  Returns the validation report of this dataset or record according to the specified properties.

- Adaptation.getValidationReportForNode(SchemaNode, ValidationSpec)

  Returns a validation report of the specified node according to the specified properties.

- Adaptation.resetValidationReport(boolean)

  Resets the validation report of this dataset.

- AdaptationHome.resetValidationReports()

  Resets the validation reports of the datasets contained in this dataspace.

- AdaptationTable.getValidationReport(ValidationSpec)

  Returns the validation report associated with this table according to the specified properties.

- AdaptationTable.resetValidationReport()

  Resets the validation report of this table.

### com.orchestranetworks.d3

- com.orchestranetworks.d3.D3NodeAsSlaveOnStartup

  Context having specific repository privileges to set up a D3 replica node, during EBX® module registration.

### com.orchestranetworks.dataservices.rest

- com.orchestranetworks.dataservices.rest.CategoryVersion

  This enumeration provides built-in EBX® category version services.

- com.orchestranetworks.dataservices.rest.Constants

  This interface provides constants for the built-in RESTful services.

- com.orchestranetworks.dataservices.rest.Constants.Admin

  Administration report keys, parameters and operation name.

- com.orchestranetworks.dataservices.rest.Constants.Auth

  Authentication report keys, parameters and operation name.

- com.orchestranetworks.dataservices.rest.Constants.Data

  Data keys and parameters.

- com.orchestranetworks.dataservices.rest.Constants.Error

  Error report keys.

- com.orchestranetworks.dataservices.rest.Constants.History

  History keys and parameters.

- com.orchestranetworks.dataservices.rest.Constants.Meta

  Meta keys and parameters.

- com.orchestranetworks.dataservices.rest.Constants.Pagination

  Pagination keys and parameters.

- com.orchestranetworks.dataservices.rest.Constants.ProcedureContext

  Procedure context keys.

- com.orchestranetworks.dataservices.rest.Constants.Selector

  Selector keys and parameters.

### com.orchestranetworks.instance

- Repository.getDatabaseMapping()

  Returns the delegate for interacting with the names of database tables and columns.

- Repository.getDefaultLocale()

  Returns the EBX® default locale.

- Repository.getLocales()

  Returns the EBX® declared locales.

- Repository.newAnonymizer()

  Returns a new delegate to be invoked for anonymization.

- com.orchestranetworks.instance.DatabaseMapping

  This interface allows interacting with the name of columns in the database.

- com.orchestranetworks.instance.NewRecordContext

  Context providing information on a record creation.

- com.orchestranetworks.instance.RepositoryAnonymizer

  Allows anonymization of records.

- com.orchestranetworks.instance.RepositoryAnonymizer.RecordContext

  Represents a record to be anonymized, granting the privilege to modify some field values.

### com.orchestranetworks.module

- ModuleContextOnRepositoryStartup.createSystemUserSession(String)

  Creates a session executing as the "system user".

- com.orchestranetworks.module.ModuleInitializedContext

  Context for the registration of dynamic resources and module-specific initializations.

- com.orchestranetworks.module.ModuleRegistration

  Ensures the EBX® module registration.

- com.orchestranetworks.module.ModuleRegistrationAdvancedD3

  Completes module registration so as to be able to properly set up the required environment of a D3 replica node.

- com.orchestranetworks.module.ModuleRegistrationListener

  Ensures the EBX® module registration from a servlet context listener.

### com.orchestranetworks.rest

- com.orchestranetworks.rest.ApplicationConfigurator

  Provides methods to register specific REST Toolkit JAX-RS application components and package scan boundaries.

- com.orchestranetworks.rest.ApplicationConstant

  This interface provides constants for JAX-RS applications configuration.

- com.orchestranetworks.rest.LocalizedException

  Class that can be extended by exceptions that return a localized error message.

- com.orchestranetworks.rest.RESTApplicationAbstract

  Defines the components for a REST Toolkit JAX-RS application.

- com.orchestranetworks.rest.UnprocessableEntityException

  A runtime exception indicating that the request was understood and the syntax was correct but that the server was unable to process the contained instructions.

### com.orchestranetworks.rest.annotation

- com.orchestranetworks.rest.annotation.AnonymousAccessEnabled

  Annotation used to allow anonymous access on a given REST resource Java method.

- com.orchestranetworks.rest.annotation.Authorization

  Annotation used to apply a specified {AuthorizationRule} on REST resource Java methods.

- com.orchestranetworks.rest.annotation.Documentation

  Annotation used to document the purpose of a JAX-RS matched resource.

### com.orchestranetworks.rest.inject

- com.orchestranetworks.rest.inject.SessionContext

  This interface provides EBX® information for the current REST request.

### com.orchestranetworks.rest.security

- com.orchestranetworks.rest.security.AuthorizationContext

  Context providing useful information for checking authorization on REST resources.

- com.orchestranetworks.rest.security.AuthorizationOutcome

  Defines the authorization for whether or not a user can access a REST resource.

- com.orchestranetworks.rest.security.AuthorizationRule

  A rule restricting access to the requested REST resource.

### com.orchestranetworks.rest.util

- com.orchestranetworks.rest.util.BuiltinQueryParam

  This interface specifies the HTTP builtin query parameters of the REST Toolkit.

- com.orchestranetworks.rest.util.ResourceType

  Identifies a type of packaged resource.

- com.orchestranetworks.rest.util.URIBuilderForBuiltin

  This class provides useful methods to generate URI to EBX® built-in REST services.

- com.orchestranetworks.rest.util.URIBuilderForResource

  This class provides useful methods to generate URI to EBX® packaged resources.

- com.orchestranetworks.rest.util.URIInfoUtility

  This class provides useful methods to generate URI specific to EBX®.

### com.orchestranetworks.schema

- SchemaExtensionsContext.setAccessRuleForCreateOnNode(Path, AccessRuleForCreate)

  Declares that the access to a record node may be restricted by the specified rule while in a record creation context.

- SchemaExtensionsContext.setAccessRuleForCreateOnNodeAndAllDescendants(Path, boolean, AccessRuleForCreate)

  Declares that the access to an element's subtree may be restricted in a record creation context by the specified {AccessRuleForCreate}.

- SchemaNode.isCheckNullInput()

  Returns the value of the propertyosd:checkNullInput.

- TableRefFilter.getValidationMessage(Adaptation, ValueContext)

  Returns a validation message according to the specified context.

- public ConstraintViolationException(com.onwbp.base.text.UserMessage)

### com.orchestranetworks.schema.info

- AssociationLink.getRecordFormFactoryClass()

  Returns the specific {UserServiceAssociationRecordFormFactory} class defined on this association node (property recordForm osd:class) or null if no {UserServiceAssociationRecordFormFactory} class has been defined.

### com.orchestranetworks.schema.trigger

- NewTransientOccurrenceContext.getValueContext()

  Returns the value context of the record being created.

### com.orchestranetworks.service

- ProcedureContext.disableDatasetValidation(Adaptation)

  Disables the constraints defined in the data model of the specified dataset during the execution of this procedure.

- SessionPermissions.getNodeAccessPermissionForCreate(SchemaNode, AdaptationTable)

  Returns the current user's access rights on the specified node in a creation context.

- ValidationReport.hasSkippedValidation()

  Returns true if this validation report is empty because the validation of the dataset, table or record didn't wait for the end of a concurrent validation.

- ValidationReportItem.isValidationMessageThresholdItem()

  Returns true if this item is related to the maximum number of validation messages to consider per constraint when performing a validation.

- ValueContextForUpdate.setValueEnablingPrivilegeForNode(Object, Path)

  Utility method to set a value for the specified node while disabling all permission checks for this node.

- com.orchestranetworks.service.AccessRuleForCreate

  Specifies a programmatic access rule invoked only when a record is created.

- com.orchestranetworks.service.AccessRuleForCreateContext

  Provides the context of the record creation for which the access rule is being called.

- com.orchestranetworks.service.ValidationSpec

  Defines the properties for validating a dataset, a table or a record.

- com.orchestranetworks.service.ValidationSpec.RefreshPolicy

  Defines the refresh policy for validating a dataset, a table or a record.

- public static final com.orchestranetworks.service.ArchiveImportSpecMode CHANGESET

  Change set mode for importing archives.

- public static final com.orchestranetworks.service.ArchiveImportSpecMode DEFAULT

  Default mode for importing archives.

- public static final com.orchestranetworks.service.ArchiveImportSpecMode REPLACE

  Replace mode for importing archives.

- public static final com.orchestranetworks.service.ServiceKey MY_PROFILE

  Built-in service to access current user's profile settings.

### com.orchestranetworks.ui

- JavaScriptCatalog.ebx_getContainerWindow(Object)

  Returns the web component window hosting a user service, UIForm, custom widget or UIBean.

- JavaScriptCatalog.ebx_getContentWindow(Object)

  Returns the window directly hosting the content displayed in the workspace.

- JavaScriptCatalog.ebx_getWorkspaceTitle()

  Gets the title of the current workspace in which the component is running.

- JavaScriptCatalog.ebx_setWorkspaceTitle(String)

  Sets the title of the current workspace in which the component is running.

- UIHttpManagerComponent.getAdditionalParameterValue(String)

  Returns the requested additional parameter or null if this parameter is not defined.

- UIHttpManagerComponent.getAdditionalParameters()

  Returns all additional parameters.

- UIHttpManagerComponent.selectPerspective(String)

  Selects the specified perspective.

- UIHttpManagerComponent.selectPerspectiveAction(String, String)

  Selects the specified perspective action.

- UIHttpManagerComponent.setAdditionalParameter(String, String)

  Adds an additional parameter.

- UIHttpManagerComponent.setAdditionalParameters(Map)

  Adds additional parameters.

- UIJavaScriptWriter.addJS_switchToPerspectiveAction(String, String)

  Changes the page of the highest EBX® frame to the specified perspective action.

- UILabelRendererContext.isHTMLForbidden()

  Returns {true} if the HTML tags in the label are escaped, {false} if they are interpreted.

- UIResourceLocator.getURLForPerspectiveSelection(String)

  Returns a URL that, when used, changes the current navigation context to the specified perspective.

- UIResourceLocator.getURLForPerspectiveSelection(String, String)

  Returns a URL that, when used, changes the current navigation context to the specified perspective action.

- public static final com.orchestranetworks.ui.UIButtonIcon FILTER

  @since 5.9.0

- public static final com.orchestranetworks.ui.UIButtonIcon MORE_VERT

  @since 5.9.0

- public static final com.orchestranetworks.ui.UIHttpManagerComponent.CloseButtonSpec CROSS

  Displays a cross button on the top right.

- public static final com.orchestranetworks.ui.UIHttpManagerComponent.CloseButtonSpec LOGOUT

  Displays the standard log out button on the top right.

- public static final java.lang.String ERROR_BORDER

  Border color for an error This CSS class only defines a border-color.

- public static final java.lang.String INFO_BORDER

  Border color for an info This CSS class only defines a border-color.

- public static final java.lang.String WARNING_BORDER

  Border color for a warning This CSS class only defines a border-color.

### com.orchestranetworks.ui.action

- WebComponentAction.getDisplayMode()

  @see #setDisplayMode(DisplayMode) @since 5.9.0

- WebComponentAction.setDisplayMode(DisplayMode)

  Specifies how the action should be displayed at launch.

- com.orchestranetworks.ui.action.DisplayMode

  Defines how a toolbar action has to be displayed on launch.

- com.orchestranetworks.ui.action.DisplayMode.ModalCustom

  Indicates that the modal should be of the specified custom size.

- com.orchestranetworks.ui.action.DisplayMode.ModalMedium

  Indicates that the modal should be of the built-in medium size.

- com.orchestranetworks.ui.action.DisplayMode.Workspace

  Indicates that the action should be displayed in the workspace.

### com.orchestranetworks.ui.form

- UIFormPane.isPaddingEnabled()

  This method allows this pane to declare that a padding must be applied on display.

### com.orchestranetworks.ui.toolbar

- ToolbarLocation.isSidebar()

- public static final com.orchestranetworks.ui.toolbar.ToolbarLocation PERSPECTIVE_MENU

  Menu displayed in perspectives.

- public static final com.orchestranetworks.ui.toolbar.ToolbarLocation SIDEBAR

  Menu displayed as a sidebar in the app.

- public static final com.orchestranetworks.ui.toolbar.ToolbarLocation WIDGET_SPECIFIC

  Toolbar displayed in specific widgets.

### com.orchestranetworks.userservice

- UserServicePane.isPaddingEnabled()

  This method allows this pane to declare that a padding must be applied on display.

- UserServiceRawPane.isPaddingEnabled()

  This method allows this pane to declare that a padding must be applied on display.

### com.orchestranetworks.userservice.declaration

- WebComponentDeclarationContext.setAvailableAsToolbarAction(boolean)

  Defines whether the service is proposed in the user interface used to define a toolbar web component action.

### com.orchestranetworks.userservice.permission

- ServicePermissionRuleContext.getEntitySelection()

  Returns the current selection.

### com.orchestranetworks.userservice.schema

- com.orchestranetworks.userservice.schema.UserServiceAssociationRecordFormContext

  This interface defines methods to get the contextual information when the user service must be created in replacement of the default record form, for an associated object to be created or accessed.

- com.orchestranetworks.userservice.schema.UserServiceAssociationRecordFormContext.ForCreate

  This interface defines methods to get information on the current selected association and current user session.

- com.orchestranetworks.userservice.schema.UserServiceAssociationRecordFormContext.ForDefault

  This interface defines methods to get information on the current selected association record and current user session.

- com.orchestranetworks.userservice.schema.UserServiceAssociationRecordFormContext.ForDuplicate

  This interface defines methods to get information on the current selected association record and current user session.

- com.orchestranetworks.userservice.schema.UserServiceAssociationRecordFormFactory

  This interface defines a factory to create a {UserService} replacing the default record form in the context of an associated object to be created or accessed.

- com.orchestranetworks.userservice.schema.UserServiceAssociationRecordFormFactoryContext

  Provides methods for setting up a {UserServiceAssociationRecordFormFactory} in the context of its data model.

- com.orchestranetworks.userservice.schema.UserServiceRecordFormContext

  This interface defines methods to get contextual information when the user service must be created in replacement of the default record form.

- com.orchestranetworks.userservice.schema.UserServiceRecordFormContext.ForCreate

  This interface defines methods to get information on the current selected table and current user session.

- com.orchestranetworks.userservice.schema.UserServiceRecordFormContext.ForDefault

  This interface defines methods to get information on the current selected record and current user session.

- com.orchestranetworks.userservice.schema.UserServiceRecordFormContext.ForDuplicate

  This interface defines methods to get information on the current selected record and current user session.

- com.orchestranetworks.userservice.schema.UserServiceRecordFormFactory

  This interface defines a factory to create a {UserService} replacing the default model-driven record form.

- com.orchestranetworks.userservice.schema.UserServiceRecordFormFactoryContext

  Provides methods that are useful when setting up a {UserServiceRecordFormFactory} in the context of a data model.

### com.orchestranetworks.workflow

- ProcessLauncher.isDefinedAsInputParameter(String)

  Returns whether a specified variable name is defined in the data context as an input parameter.

- PublishedProcess.getOriginalPublicationName()

  Returns the original publication name.

- WorkflowEngine.getProcessInstanceKeys(String)

  Returns a list containing all existing workflow keys for the specified launching publication name.

- WorkflowEngine.getProcessInstanceKeysFromHistory(String)

  Returns a list containing all existing workflow keys for the specified launching publication name, including deleted workflows.

- public static final java.util.Set IGNORE_REJECT_STRATEGIES

## Deprecated elements

### com.onwbp.base.repository

- ModulesRegister.registerWebApp(Servlet, ServletConfig)

  Registers a new module based on the specified servlet's web application.

- ModulesRegister.unregisterWebApp(Servlet, ServletConfig)

  Unregisters a module that has been registered by the registerWebApp().

### com.orchestranetworks.dataservices.rest

- com.orchestranetworks.dataservices.rest.RestConstants

  This interface provides constants for the built-in RESTful services.

### com.orchestranetworks.schema

- SchemaNode.getSchemaDefaultLocale()

  Returns the default locale of EBX®.

- SchemaNode.getSchemaLocales()

  Returns the locales that are supported by EBX®.

### com.orchestranetworks.service

- Session.getLocaleForSchemaNode(SchemaNode)

### com.orchestranetworks.ui

- UIHttpManagerComponent.createWithBaseURI(String, boolean)

  Creates an instance of this class in order to call the EBX® user interface from an external application.

- UIHttpManagerComponent.createWithBaseURI(String, boolean, AdaptationName)

  Creates an instance of this class in order to call the EBX® user interface from an external application.

## Removed elements

### com.orchestranetworks.dataservices.rest

- com.orchestranetworks.dataservices.rest.RestConstants.Admin

  Administration report keys, parameters and operation name.

- com.orchestranetworks.dataservices.rest.RestConstants.Auth

  Authentication report keys, parameters and operation name.

- com.orchestranetworks.dataservices.rest.RestConstants.Data

  Data keys and parameters.

- com.orchestranetworks.dataservices.rest.RestConstants.Error

  Error report keys.

- com.orchestranetworks.dataservices.rest.RestConstants.History

  History keys and parameters.

- com.orchestranetworks.dataservices.rest.RestConstants.Meta

  Meta keys and parameters.

- com.orchestranetworks.dataservices.rest.RestConstants.Pagination

  Pagination keys and parameters.

- com.orchestranetworks.dataservices.rest.RestConstants.ProcedureContext

  Procedure context keys.

- com.orchestranetworks.dataservices.rest.RestConstants.Selector

  Selector keys and parameters.

### com.orchestranetworks.module

- ModuleRegistrationServlet.destroyBeforeUnregisterModule()

  Called by the method {#destroy()}.

- ModuleRegistrationServlet.handleRepositoryShutdown()

  This method can be overridden, in order to release resources of the current module when the repository is shut down.

- ModuleRegistrationServlet.handleRepositoryStartup(ModuleContextOnRepositoryStartup)

  This method is invoked once the EBX® module has been registered, and when the repository has been started.

- ModuleRegistrationServlet.handleServiceRegistration(ModuleServiceRegistrationContext)

  This method can be overridden, in order to register new user services in EBX®.

### com.orchestranetworks.schema.trigger

- NewTransientOccurrenceContext.getDefinitionMode()

  Returns the definition mode of the record being currently created.

### com.orchestranetworks.service

- public static com.orchestranetworks.service.ArchiveImportSpecMode CHANGESET

  Change set mode for importing archives.

- public static com.orchestranetworks.service.ArchiveImportSpecMode DEFAULT

  Default mode for importing archives.

- public static com.orchestranetworks.service.ArchiveImportSpecMode REPLACE

  Replace mode for importing archives.

### com.orchestranetworks.ui

- UIHttpManagerComponent.getURIToMyProfileWithParameters()

- public static com.orchestranetworks.ui.UIHttpManagerComponent.CloseButtonSpec CROSS

  Displays a cross button on the top right.

- public static com.orchestranetworks.ui.UIHttpManagerComponent.CloseButtonSpec LOGOUT

  Displays the standard log out button on the top right.

### com.orchestranetworks.workflow

- public static final java.util.Set ignoreRejectStrategies

Release Notes