{"id":1080,"date":"2013-01-10T23:57:07","date_gmt":"2013-01-10T21:57:07","guid":{"rendered":"http:\/\/hasselba.ch\/blog\/?p=1080"},"modified":"2013-01-11T00:05:09","modified_gmt":"2013-01-10T22:05:09","slug":"quick-n-dirty-import-ssjs-libraries-with-dxl","status":"publish","type":"post","link":"https:\/\/hasselba.ch\/blog\/?p=1080","title":{"rendered":"Quick-n-Dirty: Import SSJS libraries with DXL"},"content":{"rendered":"

In the last time I have developed different techniques for manipulating the design elements of XPages applications. While I am still working on a way for manipulating the localization files, I was playing a little bit with DXL imports.<\/p>\n

Here comes a Java class to import a SSJS library with DXL to a database. It allows to create a new library directly from the browser:<\/p>\n

\"\"<\/p>\n

By clicking the Import<\/em> button the new Library will be added to your database (perhaps you have to refresh the DDE):<\/p>\n

\"\"<\/p>\n

\"\"<\/p>\n

To use the new imported code you have to sign the library first (or the complete database), otherwise you will receive a security error (This can be done in the XPage too, just alter the code of the button).<\/p>\n

Here is the code of the example XPage:<\/p>\n

<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n <xp:view xmlns:xp=\"http:\/\/www.ibm.com\/xsp\/core\">\r\n\r\n    <xp:inputTextarea id=\"inputTextareaSSJSCode\"\r\n       value=\"#{sessionScope.SSJSCode}\">\r\n    <\/xp:inputTextarea>\r\n\r\n    <xp:br \/>\r\n\r\n    <xp:inputText id=\"inputTextSSJSLib\" value=\"#{sessionScope.SSJSLib}\" \/>\r\n\r\n    <xp:br \/>\r\n\r\n    <xp:button value=\"Import\" id=\"buttonImport\">\r\n       <xp:eventHandler event=\"onclick\" submit=\"true\" refreshMode=\"complete\">\r\n       <xp:this.action>\r\n          <![CDATA[#{javascript:\r\n             importPackage( ch.hasselba.xpages.util );\r\n\r\n             var dxl = SSJSLibImporter.convertToDXL(\r\n             sessionScope.SSJSCode, sessionScope.SSJSLib,\r\n                database.getReplicaID()\r\n             );\r\n\r\n             var dxlImp = sessionAsSignerWithFullAccess.createDxlImporter();\r\n             dxlImp.setDesignImportOption( 6 );\r\n             dxlImp.importDxl( dxl,\r\n                sessionAsSignerWithFullAccess.getCurrentDatabase() );\r\n          }]]>\r\n       <\/xp:this.action>\r\n     <\/xp:eventHandler>\r\n   <\/xp:button>\r\n\r\n<\/xp:view><\/pre>\n
And here is the Java class:<\/p>\n
package ch.hasselba.xpages.util;\r\n\r\nimport java.nio.ByteBuffer;\r\nimport java.nio.ByteOrder;\r\nimport com.ibm.misc.BASE64Encoder;\r\n\r\n\/**\r\n\u00a0* Helper Class for DXL Import\r\n\u00a0* of a SSJS library\r\n\u00a0*\r\n\u00a0* @author Sven Hasselbach\r\n\u00a0* @version 0.2\r\n\u00a0* @category DXL\r\n\u00a0* @category Util\r\n\u00a0*\/\r\npublic class SSJSLibImporter {\r\n\r\n\u00a0\u00a0\u00a0 \/**\r\n\u00a0\u00a0\u00a0\u00a0 * converts a integer to a byte array\r\n\u00a0\u00a0\u00a0\u00a0 * in little endian order\r\n\u00a0\u00a0\u00a0\u00a0 *\r\n\u00a0\u00a0\u00a0\u00a0 * @param i integer to convert\r\n\u00a0\u00a0\u00a0\u00a0 * @return byte array\r\n\u00a0\u00a0\u00a0\u00a0 *\/\r\n\u00a0\u00a0\u00a0 static byte[] toBytes(final int i)\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ByteBuffer b = ByteBuffer.allocate(4);\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 b.order( ByteOrder.LITTLE_ENDIAN );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 b.putInt(i);\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return b.array();\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\u00a0\u00a0\u00a0 \/**\r\n\u00a0\u00a0\u00a0\u00a0 * encapsulates raw SSJS lib data to RT records\r\n\u00a0\u00a0\u00a0\u00a0 * \u00a0\r\n\u00a0\u00a0\u00a0\u00a0 * @param data array to encapsulate\r\n\u00a0\u00a0\u00a0\u00a0 * @return byte array with RT records\r\n\u00a0\u00a0\u00a0\u00a0 *\/\r\n\u00a0\u00a0\u00a0 public static byte[] generateSSJSBlock( byte[] data ){\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 final int RECORDLENGTH_OVERALL = 50;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 final int RECORDLENGTH_BLOB = 18;\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 int size = data.length;\u00a0 \/\/ size of the data\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 int roundedSize = (size % 2 == 0)?size:size+1; \/\/ rounded size\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 byte[] record = new byte[ roundedSize + RECORDLENGTH_OVERALL ];\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 byte[] hlp;\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ Record Type (Event)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[0] = -7;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[1] = -1;\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ Record Length\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[2] = 32;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[3] = 0;\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/ event type\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[8] = 22;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[9] = 0;\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ action type\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[10] = 4;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[11] = 0;\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ data size\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 hlp = toBytes( size );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[12] = hlp[0];\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[13] = hlp[1];\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ Record Type (Blob)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[32] = -36;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[33] = -1;\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ Rounded size + recordlength\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 hlp = toBytes( roundedSize + RECORDLENGTH_BLOB );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[34] = hlp[0];\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[35] = hlp[1];\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[36] = -7;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[37] = -1;\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ Rounded size\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 hlp = toBytes( roundedSize );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[38] = hlp[0];\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[39] = hlp[1];\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[40] = 32;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[41] = 78;\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ Add data to BLOB\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 for( int\u00a0 i=0; i<data.length; i++ ){\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 record[i+RECORDLENGTH_OVERALL] = data[i];\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return record;\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\u00a0\u00a0 \u00a0\/**\r\n\u00a0\u00a0 \u00a0 * generates the DXL to import a new SSJS library\r\n\u00a0\u00a0 \u00a0 *\r\n\u00a0\u00a0 \u00a0 * @param data array of bytes \r\n\u00a0\u00a0 \u00a0 * @param libName Name of the SSJS library\r\n\u00a0\u00a0 \u00a0 * @param dbReplicaId\r\n\u00a0\u00a0 \u00a0 * @return DXL to import\r\n\u00a0\u00a0 \u00a0 * \r\n\u00a0\u00a0 \u00a0 *\/\r\n\u00a0\u00a0\u00a0 public static String generateSSJSDXL( byte[] data, final String libName, final String dbReplicaId ){\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 StringBuffer dxl = new StringBuffer();\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 BASE64Encoder benc = new BASE64Encoder();\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 dxl.append( \"<?xml version='1.0'?><!DOCTYPE scriptlibrary SYSTEM 'xmlschemas\/domino_8_5_3.dtd'>\" );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 dxl.append( \"<scriptlibrary name='\" + libName + \"' xmlns='http:\/\/www.lotus.com\/dxl' version='8.5' \" );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 dxl.append( \"maintenanceversion='3.0' replicaid='\" + dbReplicaId + \"' hide='v3 v4strict' \" );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 dxl.append( \"designerversion='8.5.3'>\" );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 dxl.append( \"<item name='$Flags'><text>.5834Q<\/text><\/item>\" );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 dxl.append( \"<item name='$ServerJavaScriptLibrary' sign='true'>\" );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 dxl.append( \"<rawitemdata type='1'>\" );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 dxl.append( benc.encode( data ) );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 dxl.append( \"<\/rawitemdata><\/item><\/scriptlibrary>\" );\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return dxl.toString();\r\n\r\n\u00a0\u00a0\u00a0 }\r\n\r\n\u00a0\u00a0 \u00a0\/**\r\n\u00a0\u00a0 \u00a0 * converts a String to a DXL for a SSJS library to import\r\n\u00a0\u00a0 \u00a0 *\r\n\u00a0\u00a0 \u00a0 * @param String to convert\r\n\u00a0\u00a0 \u00a0 * @param Library name\r\n\u00a0\u00a0 \u00a0 * @param ReplicaId\r\n\u00a0\u00a0 \u00a0 * @return String with DXL\r\n\u00a0\u00a0 \u00a0 *\/\r\n\u00a0\u00a0\u00a0 public static String convertToDXL( String raw, String libName, String dbReplicaId ){\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 byte[] data = generateSSJSBlock( raw.getBytes() );\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 return generateSSJSDXL( data, libName, dbReplicaId );\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0\r\n\u00a0\u00a0\u00a0 }\r\n\r\n}<\/pre>\n
This class only imports a new SSJS library. If you want to update an existing library, you need to add a <note-info> tag to the DXL. And don’t forget to update the ACL of your database, otherwise the DXL import will fail!<\/p>\n
\"\"<\/p>\n
P.S.\u00a0Keep in mind that this article has been posted in the \u201cQuick-n-Dirty<\/strong>\u201d category.<\/p>\n","protected":false},"excerpt":{"rendered":"
In the last time I have developed different techniques for manipulating the design elements of XPages applications. While I am still working on a way for manipulating the localization files, I was playing a little bit with DXL imports. Here … Weiterlesen →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1,89,76,74],"tags":[33,14,7,31,5,32,3],"class_list":["post-1080","post","type-post","status-publish","format-standard","hentry","category-allgemein","category-java","category-ssjs","category-xpages","tag-8-5-3","tag-designer","tag-domino","tag-java","tag-ssjs","tag-tipp","tag-xpages"],"_links":{"self":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1080","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1080"}],"version-history":[{"count":14,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1080\/revisions"}],"predecessor-version":[{"id":1093,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1080\/revisions\/1093"}],"wp:attachment":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1080"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1080"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1080"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}