Fork me on GitHub

n. Slang a rough lawless young Kuali developer.
[perhaps variant of Houlihan, Irish surname]
kualiganism n

Blog of an rSmart Java Developer. Full of code examples, solutions, best practices, et al.

Monday, February 20, 2012

Explanation of kfs-maven Artifacts

Overview

This is for people that have been following the Mavenized KFS Distribution Available on GitHub post. I want to explain a bit about the artifacts how how to use your maven kfs distribution. Once you have it cloned and building, you will probably wonder what to do with the artifacts.

Artifacts

Here is a table of all the available artifacts and what they're there for:
kfs-config-4.1.1-maven-SNAPSHOT-external.zip External configuration packaging
kfs-config-4.1.1-maven-SNAPSHOT-src.tar.bz2 Sources used for the external config. It is used in overlays.
kfs-config-4.1.1-maven-SNAPSHOT-tests.jar For developing tests.
kfs-core-4.1.1-maven-SNAPSHOT-sources.jar Typical maven source jar. Does not include filters.
kfs-core-4.1.1-maven-SNAPSHOT-tests.jar For developing tests.
kfs-core-4.1.1-maven-SNAPSHOT.jar Core classes. Things that could not be put into modules.
kfs-module-endow-4.1.1-maven-SNAPSHOT-sources.jar Typical maven source jar for the endowment module.
kfs-module-endow-4.1.1-maven-SNAPSHOT-tests.jar For developing tests for the endowment module.
kfs-module-endow-4.1.1-maven-SNAPSHOT.jar The endowment module.
kfs-module-external-4.1.1-maven-SNAPSHOT-sources.jar Typical maven source jar for the external module.
kfs-module-external-4.1.1-maven-SNAPSHOT-tests.jar For developing tests for the external module.
kfs-module-external-4.1.1-maven-SNAPSHOT.jar The external module (for stuff like communicating with KC).
kfs-module-4.1.1-maven-SNAPSHOT-tests.jar The module base tests jar.
kfs-rice-4.1.1-maven-SNAPSHOT-sources.jar KFS rice overrides source jar.
kfs-rice-4.1.1-maven-SNAPSHOT-tests.jar KFS rice overrides test jar.
kfs-rice-4.1.1-maven-SNAPSHOT.jar KFS rice overrides.
kfs-parent-4.1.1-maven-SNAPSHOT-tests.jar The parent pom tests jar.
kfs-dev.war The application war.
kfs-dev-sources.jar Sources for the application.
kfs-dev-tests.jar Tests for the application.

kfs-dev.war

This is the main application artifact. This is what gets deployed to your tomcat/jetty/JBoss appserver.

kfs-config-4.1.1-maven-SNAPSHOT-external.zip

KFS has this concept of external configurations. This is a space where the application has read/write access for batch input/output files, logs, and of course security credentials. You wouldn't normally build these things into your application space because it becomes a security and auditing issue. Normally, you would deploy this to the same system as your application and unzip it there. If you look inside, it should be something like this:

Archive: /Users/leo/kfs-config-external-4.1.1-maven-SNAPSHOT-external.zip
Length Date Time Name
-------- ---- ---- ----
0 02-18-12 12:13 kuali/
0 02-18-12 12:13 kuali/main/
0 02-18-12 12:13 kuali/main/dev/
0 02-18-12 12:13 kuali/main/dev/security/
0 02-18-12 12:13 kuali/main/dev/security/kfs/
0 02-18-12 12:13 kuali/main/dev/settings/
0 02-18-12 12:13 kuali/main/dev/settings/kfs/
0 02-18-12 12:13 kuali/main/dev/work/
0 02-18-12 12:13 kuali/main/dev/work/kfs/
0 02-18-12 12:13 kuali/main/dev/work/kfs/attachments/
0 02-18-12 12:13 kuali/main/dev/work/kfs/attachments/pending/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/ar/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/bc/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/cab/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/cam/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/cg/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/coa/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/ec/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/fp/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/gl/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/ld/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/pdp/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/purap/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/sys/
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/vnd/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ar/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ar/customer/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ar/invoiceWriteoff/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/cm/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/cm/barcode/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/fp/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/fp/procurementCard/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/collectorXml/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/correctionProcess/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/originEntry/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ld/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ld/correctionProcess/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ld/enterpriseFeed/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ld/originEntry/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/pdp/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/pdp/bankFederalReserve/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/pdp/paymentExtract/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/pdp/paymentImport/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/pdp/paymentLoadSummary/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/purap/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/purap/electronicInvoice/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/workflow/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/workflow/loaded/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/workflow/pending/
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/workflow/problems/
0 02-18-12 12:13 kuali/main/dev/work/kfs/temp/
2006 02-18-12 12:13 kuali/main/dev/security/kfs/security.properties
5528 02-18-12 12:13 kuali/main/dev/settings/kfs/log4j.properties
0 02-18-12 12:13 kuali/main/dev/work/kfs/attachments/pending/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/ar/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/bc/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/cab/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/cam/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/cg/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/coa/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/ec/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/fp/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/gl/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/ld/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/pdp/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/purap/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/sys/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/reports/vnd/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ar/customer/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ar/invoiceWriteoff/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/cm/barcode/placeholder.txt
3610 02-18-12 12:13 kuali/main/dev/work/kfs/staging/fp/procurementCard/allTransDifferentCC.xml
3580 02-18-12 12:13 kuali/main/dev/work/kfs/staging/fp/procurementCard/allTransSameCC.xml
1830 02-18-12 12:13 kuali/main/dev/work/kfs/staging/fp/procurementCard/badChartData.xml
679 02-18-12 12:13 kuali/main/dev/work/kfs/staging/fp/procurementCard/badXmlFile.xml
2720 02-18-12 12:13 kuali/main/dev/work/kfs/staging/fp/procurementCard/fieldsInWrongOrder.xml
18775 02-18-12 12:13 kuali/main/dev/work/kfs/staging/fp/procurementCard/transactions1.xml
3965 02-18-12 12:13 kuali/main/dev/work/kfs/staging/fp/procurementCard/transactionWithExtraFields.xml
3472 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/collectorXml/gl_collector1.xml
3434 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/collectorXml/gl_collector2.xml
10242 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/collectorXml/gl_collector3.xml
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/correctionProcess/placeholder.txt
187 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_001.data
45 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_001.recon
137632 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_002.data
56 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_002.recon
137632 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_003.data
25 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_003.recon
297143 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_004.data
56 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_004.recon
1927409 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_005.data
60 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_005.recon
1927409 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_006.data
49 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_006.recon
60 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_007.recon
187 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_008.data
839 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/enterpriseFeed/entp_test_file_readme.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/gl/originEntry/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ld/correctionProcess/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ld/enterpriseFeed/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/ld/originEntry/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/pdp/bankFederalReserve/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/pdp/paymentExtract/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/pdp/paymentImport/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/pdp/paymentLoadSummary/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/purap/electronicInvoice/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/workflow/loaded/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/workflow/pending/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/staging/workflow/problems/placeholder.txt
0 02-18-12 12:13 kuali/main/dev/work/kfs/temp/placeholder.txt
-------- -------
4488630 114 files

The reason for the kuali/main/dev is that this is where the application was configured to put the external config at build time. Notice, I did not give an exact path. The reason is because this is intended to go into the home directory of the user running the appserver (tomcat). If I used the ${user.home} path, the paths in the zip would show the build user's home instead which is not what I want; therefore, I made it relative, so it may be deployed within the user's directory. You don't have to do this though. It is just a matter of changing the external config directory's path like I did above to put it wherever.


No comments:

Post a Comment