Package com.orchestranetworks.service
Provides classes and interfaces for implementing specific services and access rules on EBX®.
Services
In EBX®, there are two type of services:
- A UI service is integrated into Manager sessions – see
ServiceContext. - A programmatic service is called externally, for example from a batch or from a web service implementation – see
ProgrammaticService.
If a service has to perform any update on data in EBX®, it has to implement a Procedure.
Access Rules
In EBX®, access to data may be restricted programmatically – see AccessRule.
Interface Summary Interface Description AccessRule Specifies a programmatic access rule.AccessRuleForCreate Specifies a programmatic access rule invoked only when a record is created.AccessRuleForCreateContext Provides the context of the record creation for which the access rule is being called.ImportResult Describes the result of an import.NodeDataTransformerContext Context used to transform data upon export.Procedure This interface must be implemented in order to update data in a dataspace.ProcedureContext Context to execute EBX® transactions.ProcedureResult Represents the result of a procedure execution.ReadOnlyProcedure Interface to be implemented for read-only transactions.ServicePermission Attached to a legacy user service definition, this interface specifies the conditions under which this service can be executed.ServicePermissionForHierarchy Attached to a legacy user service definition, this interface specifies the conditions under which this service may be executed in the context of a hierarchy.Session Represents an authenticated user session, either an HTTP session or a "programmatic" session.SessionPermissions Defines a facade for checking the user's session permissions (access rights or actions) on dataspaces, snapshots, datasets, records, and nodes (tables, ...).ValidationReport A validation report is composed of validation items, each one characterized by a severity and a user message.ValidationReportItem Represents an element of a validation report.ValidationReportItemIterator Iterator over items contained in a validation report.ValidationReportItemSubject Represents the subject of a validation report item.ValidationReportItemSubjectForAdaptation Represents the subject of a validation report item in the context of a dataset or record.ValidationReportItemSubjectForTable Represents the subject of a validation report item in the context of a table.ValueContextForUpdate This container interface provides the possibility of setting values on persisted or transient content whose structure and types conform to an underlying data model.Class Summary クラス Description AccessPermission Defines the permission to see and modify a resource.AccessRule.NoWriteRule Wraps another rule to return a maximum access level of read-only.ActionPermission Defines the permissions for whether or not a user can execute an action.Archive An instance of this class references an archive used to export data from / import data to EBX® repositories.ArchiveExportSpec Defines the settings of an archive export.ArchiveImportSpec Defines the settings of an archive import.ArchiveImportSpecMode Defines the strategy used for importing an archive.ExportImportCSVSpec Defines the settings for executing an import or export to "Comma-separated values" format (CSV).ExportImportCSVSpec.Header Specifies the header type of the CSV document.ExportSpec Defines the settings of an export.ImportSpec Defines the settings of an import.ImportSpecMode Defines the possible modes for an XML import.InstanceContentSpec Specifies the content to export from a dataset.LoggingCategory This class provides methods for logging messages according to their severities.MergeSpecForHome Specifies the contents of a dataspace to be merged.MergeSpecForInstanceContents Specifies the contents to be merged for a dataset.NodeDataTransformer This class allows the transformation of data.Profile Identifies a user profile for permission management.ProgrammaticService This class provides the ability to programmatically log a user session.Role A role is a profile that is not a reference to a specific user; several users can have the same role.ServiceContext Deprecated. From release 6.0, this API is no longer supported.ServiceGroupKey Identifies a group of user services.ServiceKey Identifies a user service.URLQuery Represents a list of URL query parameters.UserReference Identifies a specific user.ValidationSpec Defines the properties for validating a dataset, a table or a record.Enum Summary Enum Description ValidationSpec.RefreshPolicy Defines the refresh policy for validating a dataset, a table or a record.ValueContextForUpdate.ValidationPolicy Defines the policy for validating this content.Exception Summary Exception Description OperationException Thrown to indicate that an operation cannot complete normally.