BOF 2.0 and Web Services

Transcription

1 BOF 2.0 and Web Services David Folk Product Manager Developer Conference 2004 San Ramon, CA 1 Agenda Quick Review BOF 2.0 Concepts & Benefits Q&A Web Services Framework Concepts & Benefits Roadmap Demo (optional) Q&A 2 Quick Review 3 1

2 DFC provides the client APIs for accessing the Documentum Repository Your Services Your TBOs Business Objects Operations Content Pkgs Workflow Validation Virtual Document Core DFC layer Object-oriented access to server API layer Intrinsic Business Objects High-level Middle-level Low-level APIs DocumentumRepository 4 Everyone should know: DFC Documentum Foundation Classes Primary client API for platform BOF Business Object Framework Business logic that runs as part of DFC 5 Background: DFC 5.1/BOF 1.0 Business Object Framework (BOF) Introduced Framework Version 1.0 Documentum 5.x applications Use BOF (out of the box) Can be customized through BOF BOF Object Types Introduced Type based Objects (TBO) Provide functionality that is specific to a repository object type (e.g. my_sop_document, ) and thus repository specific Service Based Objects (SBO) Provide functionality that is object and repository neutral (can be employed by any application AutoNumber Service) 6 2

3 BOF Benefits Faster development Abstracts business logic from presentation layer code Encourages reuse Portable across applications 7 Business Object Examples Type-based Change or add behavior for a specific object type Examples: request rendition on check-in, or create folder structure on save Service-based Provides a service, not tied to a specific type Examples: transform an XML document, inbox, workflow manager, autonumber 8 Extensibility and Componentization Type based Objects (TBO) Behavior specific to type (Example: my_sop_doc derived from dm_document) Repository object types TBO Java classes dm_document DfDocument IMySOP my_sop_doc MySOP 9 3

4 Extensibility and Componentization Best Practice To Promote Re-Use Declare Methods in an Interface class (e.g. IMySOP) Implementation class Extends super-type s implementation (e.g. DfDocument) Implements the Interface class (e.g. IMySOP) Implements the Interface IDfDynamicInheritance DfDocument IMySOP IDfDynamicInheritance MySOP 10 Extensibility and Componentization Service Based Objects (SBOs) Should only contain type-neutral business logic (e.g. AutoNumber, Inbox, Print) Should not have type awareness for maximum portability Framework for creating business logic components directly called from applications Can work on objects from multiple repositories IDfService ISubscription (custom service) 11 BOF

5 BOF 2.0 Next generation Business Object Framework Will ship with DFC 5.3 Focus: Administration Dynamic Deployment Requirement: Keep with BOF 1.0 programming model i.e. code fully compatible; slightly stricter packaging requirements (covered later in presentation) Repository-registered modules have precedence over DBORregistered objects 13 BOF 2.0 Administration (summary) Business Objects Registered in repository No longer in client machine Properties file (DBOR) TBOs in repository corresponding to type SBOs in master repository Repository module stores: Version information Description Type (SBO, TBO) Dependencies Javadoc Documentum Repository 14 BOF 2.0 Dynamic Deployment (summary) BOF objects dynamically deploy to client Requires separation of interface (shared classes) and implementation jars Supports 3 rd -party Java libraries Documentum Repository Dynamic Deployment 15 5

6 Packaging and Deployment Creating a Documentum business object will involve the following steps: 1) Implement the business object. This includes tasks such as: a) Defining the interface and implementation. b) Implementing the IDfBusinessObject methods and its business logic. 2) Package and deploy the business object. Either: a) Write the XML config file (an ANT build file) and execute the task as a command prompt program, or b) Use Documentum Application Builder (DAB) UI. 3) Distribute business object to multiple repositories through the Documentum Application Installer (DAI). 16 Modules Unit representing TBO or SBO in repository Reside in repository Administered, searched for, etc. Appropriate pieces downloaded to client (e.g. JAR) 17 Modules in Documentum Application Builder (DAB) Module = one stop shop in repository for BOF code, description, dependencies, Javadoc, etc. 18 6

7 Module: Implementation Module: Name, Type, Version Interface & Implementation JARs 19 Module: General Name, Version Interfaces Min DFC and JVM Versions (for reference) Path to Javadoc 20 Module: Runtime Environment Names when deployed File path when deployed Name/Value properties Message logged client-side post download 21 7

8 Module: Dependencies Third Party JARs Dependent Business Objects 22 Module: Description Provider, Contact, Description Supporting documents: README, license, etc. 23 Organization in Repository mysbo mysbo.jar mysboimpl.jar javadoc.zip runtime environment.xml JDOM JDOM.JAR External Interfaces mytbo.jar Miscellaneous license.txt Named for service or type name. Contains JARs for Bus. Object. 3rd party JARs can be stored in repository. Interfaces to any used business object. Place to put readme.txt, license, etc. 24 8

9 dm_module Type dm_folder subtype Stored in the repository in a folder structure under /System/Modules/[module name] or /System/Modules/[TBO, SBO, ASPECT]/[module name] TBOs name corresponds to type SBO convention is to use the fully qualified primary interface name (but not always applicable for example, where multiple SBOs implement the same interface) 25 dm_module Type Attributes (1 of 2) Attribute primary_class a_interfaces min_dfc_version contact_info Description The main implementation class. The fully qualified class name of the interfaces that the module implements. Indicates the minimum DFC version required for this component to operate properly. Minimum value is 5.3 Specifies the party you can contact about this component. It could be an address, for example. 26 dm_module Type Attributes (2 of 2) Attribute a_bof_version a_module_type req_module_name a_req_module_interfaces module_description Description The business object s programmatic version that the developer would consciously set. The out-of-the-box types are: TBO, SBO, Aspect. Lists the name of modules that this module is dependent on. The repeating values correspond with the ones in the req_module_name attribute. It lists the object Ids of the interface jars of the corresponding dependent module. Description of the functionality that is implemented in the module 27 9

10 dm_jar Type For storing JAR files Attribute minimum_vm_vers ion jar_type Description e.g or 1.4.2_02 [1:interface, 2:implementation, 3: both implementation and interfaces] 28 dm_java_library Type For storing third-party libraries on which business objects depend Attribute sandbox_library Description Indicates whether the files should be loaded in the business object class loader or in the shared class loader 29 Service Based Objects (SBO) Don t have repository affinity Properties of note in DFC.properties: Property dfc.registry.host dfc.registry.username dfc.registry.password Description Indicates name of repository containing SBOs User name for an account that the system administrator will set up. We recommend READ permission to SBOs only. Clear or encrypted password. (Encryption requires DMCL setup with encryption key.) 30 10

11 Downloading and Caching Business Objects Business Objects are dynamically downloaded and cached When a Business Object is requested, DFC: 1) Checks a change monitoring system to determine if cache consistent with repository. 2) If required, downloads the CURRENT version of the object, caches it, and uses it. If repository not accessible, tries to use cached object or throws exception From DFC.properties Description dfc.housekeeping.cleanup.interval Cache cleaned interval specified (default = every 7 days, remove if not used in past 24 hrs.) dfc.bof.cacheconsistency.interval Consistency check 31 Class Loading BOF 2.0 supports hot deploy Goals: Dynamically provisioned business objects Avoid the proliferation of interface byte code across many class loaders. Allow for reliable class identity for interfaces. Sandboxing of business objects and in some cases 3 rd -party libraries. 32 Questions and Answers 37 11

12 Take away points BOF 2.0 objects dynamically deploy to client Compatible with BOF 1.0 BOF 2.0 Requires Interfaces in separate JAR Supports 3 rd -party BOF objects Business objects registered in repository No longer in client machine Properties file (DBOR) TBOs in repository corresponding to type SBOs in master repository Repository stores: Version information Description Type (SBO, TBO) Dependencies Javadoc Etc Web Services 40 12

13 Background for Web Service support in the Platform Commonality in customer requirements around ECM and web services Plugging into Service Oriented Architecture (SOA) 41 Web Services Support Documentum Platform Release 5.3 DFC includes web services framework Leverages BOF SBOs Authoring Deployment Web SBO Programming Model Development Tools Web Service Runtime (Axis 1.2) Unified Content Framework (UCF).NET friendly WSDL 42 Web Services Roadmap Documentum Platform Release post 5.3 Standard Web Service Based Objects included with platform Great opportunity to provide feedback Library Operations WSBOs Administration WSBOs Query WSBO Search WSBO Many More Web SBO Programming Model Development Web Service Content Tools Web Services Runtime (Axis Framework 1.2) Transfer (UCF).NET friendly WSDL 44 13

14 Web Services Roadmap Examples: Plugging into SOA Timeframes vary Some underway already (and some don t actually require WS framework) WSRP (Portlets) Authoring Integrations BPS EAI.NET Applications Library Operations WSBOs Administration Query Search WSBOs Web Services WSBO Library WSBO Many More Web SBO Programming Model Development Web Service Content Tools Web Services Runtime (Axis Framework 1.2) Transfer (UCF).NET friendly WSDL 45 Assumptions Remote-function-call (RPC) style interactions Achieved through wrapped document literal WSDL syntax Point-to-point interactions Not involving complicated routing Intra-corporate bias Client-side web service framework neutrality At minimum, Java and.net Explicit non-goal: Dynamic provisioning of web services The publication of a BOF service as a web service requires deliberate design-time intervention and explicit manual publication. 46 Web Services Framework Overview Code generator Included with Documentum Application Builder Packager Included with Documentum Application Builder Manual Deployment Placing generated WAR on application server (e.g. in the WebApps directory on Tomcat) Runtime support classes Servlet that needs to be hosted in a web container 47 14

15 Deployment steps 1) Implement BOF service Development Machine 2) Code generate and package through DAB 3) Package compiled classes with DAI Production Machines 4) Distribute BOF Service service & to Web Service repository extension via DAI 5) Manually Run deploy deploy tool to WAR publish to application to runtime environment server 48 How does code generation work? (slide 1 of 2) 1) Take a service-based business object and reflect upon it. 2) Construct an aggregate interface comprising the methods from all implemented interfaces, explicitly excluding IDfService and its superclasses. Supported datatype mapped to JAX-RPC friendly types for input arguments and return values. 3) Generate a concrete wrapper class implementing the contrived interface. 49 How does code generation work? (slide 2 of 2) 4) Generated class is presented to the Axis infrastructure for skeleton/wsdl generation. Documentum type mappings and SOAP header manipulations influence the WSDL generation. Header definitions included in the WSDL. This facilitates automatic stub generation for clients

16 Interfaces Signatures: In general, only support services with interfaces compliant to JAX-RPC For example: Java primitive types and their wrappers String Calendar value types Concrete classes with a public, no-argument constructor, and data accessibility via getters and setters, so long as the data are also JAX-RPC friendly. May be nested. Non-sparse arrays are also acceptable No support for arbitrary interfaces other than BOF exceptions to this rule 51 Reliability Depends solely on the reliability of the underlying BOF service 52 Supported Environments The web services framework requires a servlet container environment as host (such as Tomcat). We should support most, if not all, web service client environments that can take WSDL as the service definition

17 Versioning Compatible interface extensions to the underlying BOF service require a new manual web service deployment. Supports BOF 2.0 dynamic deployment of JAR. WS client code continues to function as expected 54 Interoperability WS-I Basic Profile interoperability standard mandates document/literal style (schema-centric) SOAP messages Additional standards considered over time. Notably, any emerging as.net evolves. 55 Content Transfer The following types (in parameters or return values) suggest content transfer: javax.activation.datasource java.io.file java.io.reader java.io.inputstream (or the corresponding array types) Code generator produces web service definition using SOAP attachment technology MIME, not DIME (as the latter is being phased out) Support for UCF is also planned This would require some optional client-side code to establish inbound UCF connection 56 17

18 Runtime Support Repository credentials service Initial use Create a new session manager instance, attach the repository credentials, and save the session manager instance in a registry for later recovery. Generate a unique token to act as a key to the session manager instance. This key will be returned to the caller. Subsequent use Existing token is presented along with new or amended credentials. The existing session manager instance will be recovered and augmented/updated with the new credentials. Supports passing token to other Web Services Finds Session Manger based on token 57 Security Repository credentials not passed in clear (by default) SSL support Acceptable in a point-to-point environment WS-Security support Planned Cost: More complex client involvement would be required Benefits: Digital signature support, partial encryption, etc. 58 The simplest example Demo placeholder 59 18

19 Questions and Answers 60 Take away points Web Services extend BOF SBO logic Reuse/extend your SBOs RPC-Style Interactions WSDL compliant with popular frameworks, including Visual Studio.NET Wrapped document literal style WSDL Framework and tools in 5.3 Apache Axis based Standards WS-I Basic Profile Service library post-5.3 Great opportunity for feedback. Intra-corporate bias

20 Planned Service Buildout The following slides are for reference purposes only. The list of services is by no means final or comprehensive. 63 Web Services Library Services: Perform library-like operations Import Take a file for import, with a destination and metadata Export Return a file for export Checkout (Export file) and label object as checked out in repo Checkin Take a file for checkin (no destination required); Not supporting Check-In as New here Move Take an object and a destination for it s movement in the repo Copy - Take an object and a destination for copy in the repo Delete Take an object and a set of delete instructions (all, renditions, all copies, ) Search Perform a search by accepting a set of query/search parameters (uncertain if this will be DQL in the WS message) and return a handle to a resultset or the full result set (latter part not determined but will be determined by scalability of implementation testing) 64 Web Services Object Services: VDM Service Get/Set VDM elements and meta-data Discrete Checkout/Checkin/Import operations wrt/ VDMs Any additional work that is necessary to manage content-less objects already defined in VDMs Object Services Get Attributes for an object (1 call) Set Attributes for an object (1 call) Get Rendition Get Related Object (per dm_relation) Get References Attach/Detach Lifecycle Connection Services: Perform Connection Boker interaction operations Interrogate Connection Broker List Repositories, List Servers Set Connection Broker Set the custom Connection Broker 65 20

21 Web Services Repository Services Get list of known types defined in repository (repository) instance Get list of known formats defined in repository Get list of Apps defined in repository (XML, WP, ) Workflow Service Validation Service (for XML files, app files, etc.) Control Service (one that knows how to place a document under proper Doc Control Management) Transformation/Rendering Service Utility Services Repository Uptime Repository Users Current user/session count Errors (Could we have a service that allows errors to be retrieved from the server to improve remote monitoring/administration) 66 21