{"id":1754,"date":"2014-11-18T17:43:47","date_gmt":"2014-11-18T15:43:47","guid":{"rendered":"http:\/\/hasselba.ch\/blog\/?p=1754"},"modified":"2014-11-19T13:55:06","modified_gmt":"2014-11-19T11:55:06","slug":"xpages-webcontent-files-1-create-a-file-using-the-java-napi","status":"publish","type":"post","link":"https:\/\/hasselba.ch\/blog\/?p=1754","title":{"rendered":"XPages: WebContent Files (1) – Create a file using the Java NAPI"},"content":{"rendered":"

The great Marky Roden has written an interesting article about using the WebContent folder instead of standard domino design elements<\/a>. To create or manipulate these files programmatically, you can use the Java NAPI.<\/p>\n

The first example demonstrates the creation of a file using a Java Agent. Before you can compile the code, you have to import the required jars as described here<\/a>.<\/p>\n

import lotus.domino.AgentBase;\r\n\r\nimport com.ibm.designer.domino.napi.NotesConstants;\r\nimport com.ibm.designer.domino.napi.NotesDatabase;\r\nimport com.ibm.designer.domino.napi.NotesNote;\r\nimport com.ibm.designer.domino.napi.NotesSession;\r\nimport com.ibm.designer.domino.napi.design.FileAccess;\r\nimport com.ibm.jvm.util.ByteArrayOutputStream;\r\n\r\npublic class JavaAgent extends AgentBase {\r\n\r\n\u00a0\u00a0 \u00a0public void NotesMain() {\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0try {\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0final String serverName = \"Dev01\/Hasselba\/CH\";\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0final String dbPath = \"NAPI.nsf\";\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0final String fileName = \"dummy.txt\";\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0NotesSession nSession = new NotesSession();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0NotesDatabase nDatabase = nSession.getDatabaseByPath(serverName\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0+ \"!!\" + dbPath);\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0nDatabase.open();\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/ create a new note\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0NotesNote nNote = nDatabase.createNote();\r\n\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\/\/ define $Flags item\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0StringBuffer flags = new StringBuffer();\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0flags.append(NotesConstants.DESIGN_FLAG_HIDEFROMDESIGNLIST);\r\n\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0flags.append(NotesConstants.DESIGN_FLAG_NO_COMPOSE);\r\n            flags.append(NotesConstants.DESIGN_FLAG_HIDE_FROM_V4);\r\n            flags.append(NotesConstants.DESIGN_FLAG_FILE);\r\n \u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0 \u00a0\r\n            \/\/ define $FlagsExt item\r\n            StringBuffer extFlags = new StringBuffer();\r\n            extFlags.append(NotesConstants.DESIGN_FLAGEXT_WEBCONTENTFILE);\r\n\r\n            \/\/ init the file with the flags\r\n            nNote.initAsFile(flags.toString(), extFlags.toString());\r\n\r\n            \/\/ add required fields\r\n            nNote.setItemText(\"$TITLE\", fileName);\r\n            nNote.setItemText(\"$MimeType\", \"text\/plain\");\r\n\r\n           \/\/ generate some random data\r\n           ByteArrayOutputStream bos = new ByteArrayOutputStream();\r\n           for (int i = 0; i < 128000; i++) {\r\n             int hlp = (i % 24) + 60;\r\n             bos.write(hlp);\r\n           }\r\n\r\n           \/\/ store the data to the Note\r\n           FileAccess.saveData(nNote, fileName, bos.toByteArray());\r\n\r\n           \/\/ recycle the NAPI objects\r\n           nNote.recycle();\r\n           nDatabase.recycle();\r\n           nSession.recycle();\r\n\r\n       } catch (Exception e) {\r\n           e.printStackTrace();\r\n       }\r\n    }\r\n}<\/code><\/pre>\n
As you can see, when using the NAPI you don’t have to save a note. It is directly written to the NSF.<\/p>\n
After running the agent and refreshing the project explorer view (hit F9) the newly created file appears in the WebContent<\/em> folder…<\/p>\n
\"\"<\/p>\n
… and is accessible in the browser:<\/p>\n
\"\"<\/p>\n
If you want to allow public access to your element, you have to add a single line in the code above:<\/p>\n
nNote.setItemText(\"$PublicAccess\", \"1\");<\/code><\/pre>\n
This allows unauthenticated users to access the file while the rest of the application is protected:<\/p>\n
\"\"<\/p>\n
On the other hand, you can use reader fields enhance the security of the file. But this can not be done with the note object directly, you have to use the standard Domino document classes for this. To access the document, you have to convert the note’s note id (an integer value) into his hexadecimal representation:<\/p>\n
int noteId = nNote.getNoteId();\r\nDocument doc = db.getDocumentByID(Integer.toHexString(noteId));<\/code><\/pre>\n
Then, you can add the reader field to the document and save the result.<\/p>\n
Session session = getAgentSession();\r\nDatabase db = session.getCurrentDatabase();\r\nDocument doc = db.getDocumentByID(Integer.toHexString(noteId));\r\n\r\n\/\/ create the field \r\nItem item = doc.replaceItemValue(\"DocReaders\", \"[ReadAll]\");\r\nitem.setReaders(true);\r\n\r\n\/\/ save the document\r\ndoc.save();\r\n\r\n\/\/ recycle the instances\r\nitem.recycle();\r\ndoc.recycle();\r\ndb.recycle();\r\nsession.recycle();<\/code><\/pre>\n
Now, the file is protected when opening in the browser:<\/p>\n
\"\"<\/p>\n
Keep in mind: As the developer it is required to have the access rights for the file too.<\/p>\n","protected":false},"excerpt":{"rendered":"
The great Marky Roden has written an interesting article about using the WebContent folder instead of standard domino design elements. To create or manipulate these files programmatically, you can use the Java NAPI. The first example demonstrates the creation of … 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":[21,89,74],"tags":[47,79,14,7,31,3],"class_list":["post-1754","post","type-post","status-publish","format-standard","hentry","category-agenten","category-java","category-xpages","tag-9-0","tag-agenten","tag-designer","tag-domino","tag-java","tag-xpages"],"_links":{"self":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1754","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=1754"}],"version-history":[{"count":7,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1754\/revisions"}],"predecessor-version":[{"id":1761,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=\/wp\/v2\/posts\/1754\/revisions\/1761"}],"wp:attachment":[{"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1754"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1754"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/hasselba.ch\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1754"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}