ASG-Rochade Java API Release Notes

Transcription

1 ASG-Rochade Java API Release Notes Version January 12, 2007 JPI This publication contains information about all modifications made to ASG-Rochade Java API (herein called Java API) since Version Note: ASG encourages you to visit and sign onto the Intelligent Support Portal (ISP) to verify whether any product or documentation revisions, new maintenance, or service packs apply to this release of the product or its accompanying documentation. Product Information Java API is an object-oriented application programming interface (API) with a metamodel view that is very similar to the one provided by the core classes of ASG-Rochade AutoPilot (herein called AutoPilot). It is a pure Java API for developing Rochade-based client/server and multitier applications. It provides these features and capabilities by means of a simple, straightforward, and easy-to-use design: Compatibility with AutoPilot metamodels and control data Handling of AutoPilot subject areas and projects, including versioning Support for all AutoPilot reports through easy-to-use, object-oriented query classes Access to metadata and querying of metadata controlled by the metamodels Access to metadata regulated through access rights defined in AutoPilot Support for multiuser- and multisession-capable programs that work with multiple subject areas and items Portability through pure Java code Copyright 2007 ASG GmbH & Co. KG, a wholly owned subsidiary of Allen Systems Group, Inc. All rights reserved. All names and products contained herein are the trademarks or registered trademarks of their respective holders. 1

2 While the metamodel view provided in Java API is similar to the view provided by AutoPilot s core classes, it does not support all of their functionality. For a description of the differences between the traditional API and Java API, see the file differences.html in the installation directory RochadePath/TechDoc/jpi/en. Enhancements and Changes Version These modifications and enhancements have been made to Java API in Version : Enhancements/Changes srap.application.compare reports link attributes as changed if links differ only by their link qualifier. srap.application handles hypertext attributes in select, update, and compare in their original representation as stored in Rochade (see Corrections and Fixes on page 8). You can control its behavior with the new method srap.application.setfeatures (see New methods on page 2). srap.application.update supports interapplication operations. New constants srap.application.reftype.unclassified srap.application.updatemode.copy_v srap.application.updatemode.move_v srap.application.updatemode.share_v New methods srap.application.setfeatures and srap.application.getfeatures srap.convenient.applicationsupport.packstring and srap.convenient.applicationsupport.unpackstring Deprecated methods (see your Java API class documentation for additional notes) srap.convenient.applicationsupport.packstringforupdate srap.convenient.applicationsupport.unpackstringfromselect 2

3 Version These modifications and enhancements have been made to Java API in Version : Enhancements/Changes QueryCmpVersions and QueryCmpIdents An attribute that is valid in the metamodels of both versions or identifiers to be compared and is empty in one of these is treated now as NOT_EQUAL instead of being assigned to DS1 or DS2. New maskable path queries. New classes QueryMPath MPath MPathIterator MPathFactory MPathMask MPathNode MPathXmlParser MPathXmlReader New constants ICNode.LinkDir.VIRTUAL Query.Type.M_PATH New methods QueryFactory.createMPathQuery 3

4 Version These modifications and enhancements were made to Java API in Version : Enhancements/Changes Identifier package support has been added, including a sample implementation for working with AutoPilot packages. Identifier.getAttributesContents and IdentifierCollection.getAttributesContents can now request the state of identifiers. Keepalive implementation has been improved. Performance improvements have been made in SRAP select, QuerySdcac, and attribute contents handling. New package: de.rochade.srap.wrapped New classes AccessController ApIdentPackageAccessController ApIdentPackageHandlerImpl ApIdentPackageImpl ApPackAttrs BaseAccessController Identifier.State IdentifierAccessController IdentifierCollection.Search IdentifierPackage IdentifierPackageAccessController IdentifierPackageHandler New constants: Identifier.State.STATE RoException.Code.IDENT_ALREADY_EXISTS 4

5 New methods Application.Info getbaseconfig gethierarchybase isinhierarchy AttrContentsContainer.isDisposed Attribute.isDisposed BaseAttrContentsContainer.isDisposed DataStore dispose getidentifierpackagehandler isdisposed setattrcontentscontainerfactory srap.connection.getstatistics Server.isDisposed User getfailedlogons getpasswordexpirydays srap.srapadaptor getsrapapplication getsrapdatabase getsrapconnection Improved/changed methods: iproved performance of AttrContentsContainer.dispose and QuerySdcac.run. 5

6 Version These modifications and enhancements were made to Java API in Version : Enhancements/Changes New attribute handling feature: Dynamic attribute contents information. New SRAP API support for execution of RPL scripts. Keepalive functionality added to communication, which sends a keepalive package during inactivity every 30 seconds to avoid closing of the connection by a firewall or proxy. New classes Attribute.ContentsInfo UserExit.Mode New constants Attribute.ContentsInfo RO_MIME_TYPE RO_MIME_TYPE_DEFAULT RO_FILE_NAME RO_FILE_EXT RO_FILE_PATH UserExit.AttributeType.CONTENTS_INFO UserExit.Key.ATTRIBUTE UserExit.Mode GET SET New methods Attribute getcontentsinfo setcontentsinfo MetaModelAttribute.getContentsInfoMapping Improved/changed method IdentifierCollection.getAttributesContents If an identifier in the collection does not exist, it is no longer contained in the returned Map.

7 Version Version Java API provides QuerySdcac.run with improved performance for Rochade servers 7 or later. These modifications and enhancements were made to Java API in Version : New classes IdentifierCollection.RemoveMode State StateModel New constants IdentifierCollection.RemoveMode New methods DROP_CHILDREN KEEP_CHILDREN NO_CHILDREN Database.getDataStore ICIterator.remove(RemoveMode mode) IdentifierCollection remove(object o, RemoveMode mode) removeall(collection c, RemoveMode mode) retainall(collection c, RemoveMode mode) MetaModelType.hasAttribute() Improved/changed classes IdentifierCollection Reduced memory usage. QueryPath Improved performance in the construction of path queries. Improved/changed methods DataStore.createIdentifier Performance improvements if the name parameter is of class IdentifierNameClassified. 7

8 ICIterator.remove This method now throws an IllegalStateException if you try to remove a node with children. IdentifierCollection remove(object o) removeall(collection c) retainall(collection c) All three methods now throw an IllegalStateException if you try to remove a node with children. MetaModelAttribute.getValidContents If a sequence of values is defined in the metamodel attribute and no attribute was passed as a parameter, this method now returns a StateModel containing the whole sequence definition instead of throwing a NullPointerException. MetaModelAttribute.checkContents If a link target does not exist and the user has no create right for the metamodel identifier type of the link target, then it was not possible to create this link target by saving a link attribute. This check is disabled now. Corrections and Fixes Version These errors in Java API have been corrected in Version : MPathFactory Now computes recursively all path variants that point either from other item types to this item type (i.e., usages) or from this type to other types (i.e., references). QueryMPath Now delivers all identifiers if the path definition contains alternate ways to reach an identifier but a mask filters out intermediate identifiers. srap.application.select For query kind NEXT_LINKS, the method no longer throws a RoException (parse error for sdcac expression) if a link attribute led to no target item types. 8

9 Version Version srap.application Handling of hypertext attribute content has been corrected. The original content stored in Rochade will be returned (select) or expected (update) by default instead of an (generated) XML representation (see also Enhancements and Changes on page 2). These errors in Java API have been corrected in Version : ApplicationAdmin.getView When an item type was removed from the metamodel and the application was reorganized, an assert/nullpointerexception was thrown. AttrContentsContainerFac.registerAttrContentsContainer This method threw a ClassCastException. It has been corrected by changing the return type from AttrContentsContainer to Class. IdentifierNameClassified.hashCode The hashcode method threw a NullPointerException when the qualifier was null. User.getDatabase When a database is requested, unbound locks are automatically released. If there were multiple unbound lock contexts in the database, an IllegalArgumentException was thrown. These errors in Java API were corrected in Version : ApplicationAdmin.setIdentNameCaseSensitive When used with extension types, an exception occurred. Identifier.modifyNames If an identifier that was not located in the work configuration was renamed, then the resulting identifier contained the old configuration number. QuerySdc.run The sorting order of the result was reversed so that it matches the order produced by RPL. 9

10 Version These errors in Java API were corrected in Version : If a link was written with an empty string for the link target name (i.e., ""), the server crashed. If the RPL integration of the API used DLLs of Rochade , a NoSuchElementException was thrown. AttributeContentsContainer.preserveChanges If this method was called and afterwards this container was changed again, this led to a memory leak. ICIterator.remove If the appropriate IdentifierCollection was organized as a tree, then calling this method sometimes led to unexpected results. See also the new method remove(removemode mode). Identifier.getNames If the identifier has alias names, the unique name now always appears as the first entry in the returned set. IdentifierCollection.PrintTree If this class was used to traverse an IdentifierCollection with a depth greater than 11, then an ArrayIndexOutOfBoundsException was thrown. QueryPath.run If you added two path segments, one without a filter and the other one with the Query.RefType.NAMESPACES filter, the result contained only the classified namespace relationships and no link relationships. QuerySli.run If a referenced identifier has alias names, the identifiers corresponding to the alias names also appeared in the query result. Versions and Methods ICIterator.remove, IdentifierCollection.remove, IdentifierCollection.removeAll, IdentifierCollection.retainAll These methods now throw an IllegalStateException if you try to remove a node with children. 10

11 Installation Information ASG provides detailed lists of hardware and software requirements for all Rochade components and relevant operating systems in its ISP under Hardware Requirements Minimum system requirements: 64 MB RAM (ASG recommends 128 MB) 5 MB hard disk space Intel Pentium / 200 MHz or comparable Software Requirements This software should be installed on your computer: Rochade Server 6.20 or later. Note: Java API works best with AutoPilot If you want to work with the Rochade procedure language (RPL) interpreter, you must install Rochade Client (ROCLIENT) or later. JDK1.4 / Java 2 While Java API probably will run on any platform for which this JDK version is available. ASG has actually tested it on these platforms: AIX BS2000 (POSIX shell) HP-UX Linux (Intel) Linux on IBM mainframe (zseries) Mac OS X Microsoft Windows Sinix Solaris UnixWare z/os UNIX System Services 11

12 12 Check the existence of Java Execute the command java -version within a command interpreter (i.e., cmd.exe on Windows; any shell in UNIX or POSIX environments). You should see something like this: java version "1.4.2" Java(TM) 2 Runtime Environment, Standard Edition (build b28) Java HotSpot(TM) Client VM (build b28, mixed mode) If this command cannot be executed, complete these steps: In Windows Environments (1) Use the search user interface to look for a file named java.exe: Windows 2000: Start Search For Files and Folders Windows XP: Start Search (2) Execute the command java -version again for the found paths. In UNIX or POSIX Environments Execute this command in your shell: find / -name java -exec {} -version \; -print If it finds a usable Java program, it prints out the version information and the path where it is found. Add the path to the path environment variable. Contact your administrator for assistance. Third-party Software and References For Sun s Java products, see Xerces - XML Parser These files are located in the bin directory of the Java API installation: xercesimpl.jar and xmlparserapis.jar (for Apache Xerces ). The package de.rochade.srap utilizes the Apache XML parser (see Xerces2, Java API (SRAP layer) has been tested with Xerces The class de.rochade.util.domwriter is a copy of the algorithm that is used in Licensing Information Java API includes software developed by the Apache Software Foundation (see For licensing conditions, see the file license-for-apache.txt, which is taken from

13 Installation Steps Rhino - JavaScript Implementation Use the file js.jar (for Rhino Version 1.6R1). The package de.rochade.srap utilizes the Mozilla Rhino JavaScript implementation (see Java API (the SRAP layer) requires Rhino 1.6. At the time of this writing, Rhino 1.6R1 is available at ftp://ftp.mozilla.org/pub/mozilla.org/js/rhino1_6r1.zip. Licensing Information Java API includes software developed by the Mozilla project (see For licensing conditions, see the file license-for-rhino.txt, which is taken from (see Axis - Web Service Middleware The package de.rochade.srap.ws utilizes Apache Axis 1.2 to provide a Web service facility (see Licensing Information Java API includes software developed by the Apache Software Foundation (see For licensing conditions, see the file license-for-apache.txt, which is taken from To install the Java API, follow the general directions given in the readme_en.pdf file for installing Rochade applications. Like all Rochade applications, the Java API is installed in two steps: First the ADM installation and then the actual application installation. Migration Considerations Before running your programs with Java API or , you must recompile them. If you plan to update from Java API to or later, and you have manipulated standard T-type link attributes (link indicator S in the metamodel) with Java API , you should run a data migration procedure to correct possible inconsistencies in link qualifier data. This data migration procedure is available via the ISP or from ASG Customer Support. After the migration, make sure that all Java API installations are updated to the same version (Version or later) to prevent further link qualifier inconsistencies from occurring. 13

14 When you are using Java API, this long-standing Rochade rule still applies: A closing parenthesis always terminates a link qualifier in T-type link attributes, unless the parenthesis is escaped. Version Incompatibilities These incompatibilities concern the transition from server version 6 to 7 and later: Methods Application.createIdentifierName Returned objects of class IdentifierName can be used as parameters in these areas: DataStore.createIdentifier Identifier.copy Identifier.modifyNames LinkAttrContentsContainer.save These methods show different behavior depending on the release number of the AutoPilot application (i.e., AutoPilot subject area or project). The AutoPilot application release number is 3.7 or later. The methods are used to create namespace members that must explicitly be assigned to a namespace attribute to classify the namespace relationship. The documentation of the method contains a more detailed description. The AutoPilot application release number is less than 3.7. The methods are also used to create namespace members, but the assignment to namespace attributes is done implicitly by the Java API by analyzing the target identifier types of the namespace attributes defined in the metamodel. These incompatibilities concern these versions of Java API: Versions and If you are using the SRAP API in conjunction with servers of Version 7 or later, its behavior has changed. The issue is described in detail earlier in this section. In Version , always classified namespace members are created. Versions 1.30 through together with RPL DLLs or later and Server 7.00 or later If you are using a Java API version in the range from 1.30 through together with RPL DLLs or later and Rochade Server 7.00 or later, then you cannot connect to the server. An exception is thrown and this message appears: 14

15 Major version of native lib 'roapi2jn' is: 7 - version: 6 required. Versions and Methods ICIterator.remove, IdentifierCollection.remove, IdentifierCollection.removeAll, IdentifierCollection.retainAll These methods now throw an IllegalStateException if you try to remove a node with children. Getting Started To start Java API 1 Install Java archives. The Rochade installation installs jar files rochade.jar and rochaderpl.jar in the directory RochadePath/bin. 2 Read Java API documentation, tutorial, and samples. The supplied Java API documentation is in HTML format and is located in the directory RochadePath/TechDoc/jpi/en. Part of the documentation was generated automatically by the javadoc tool. You can view the documentation with any Web browser. To start reading the Java API documentation, point your browser at the file: RochadePath/TechDoc/jpi/en/index.html. ASG also provides a tutorial that illustrates how to use the Java API. It contains various code samples and sample programs. You can find the Java API sample programs in the directory RochadePath/samples/jpi. 15

16 16