Catch up with the times on asetkey operation
[openafs-wiki.git] / JavaAdminAPI.mdwn
1 In large AFS environments, local tools are usually written to manage AFS more effectly. Today these tools are usually written in scripts. These scripts typically issue AFS commands and parse the command output. This is not a good practice as command output are not well defined. Their format or even contents can change. An AFS Admin API is needed. Today some internal C libraries exist and are used by the AFS command suite as well as the Windows Admin GUI. But they are not clearly defined for external use and not easy to use.
2
3 Here a set of Java API is proposed. The goal is to make the API suitable not only for administrators to write custom AFS automation tools but also for developers to write general and powerful tools for easy and efficient AFS management. -- [[LeoShyhWeiLuan]] - 13 Feb 2002
4
5 All of the base class API documents have been updated to the most recent revision (v1.4). Additionally, the newly introduced AFS ACL, Token, and File classes, as well as the associated file stream classes, have been posted as well.
6
7 In addition to enhancing the overall documentation, this latest revision incorporates a number of modifications and new features, several of which were either suggested or inspired by the valued feedback we have received from some of you. -- [[ManuelPereira]] - 02 Jul 2002
8
9 Note: below is only the documentation for the API. The actual API source is included with the [[OpenAFS]] source distribution and is viewable on the web at <http://www.openafs.org/cgi-bin/cvsweb.cgi/openafs/src/JAVA/> -- Daniel Clark - 08 Jan 2003
10
11 The Java AFS API (JAFS) has been updated, employing several fixes and improvements, with patches for [[OpenAFS]] 1.2.9 source and the current source (CVS/daily snapshots). The most recent API documents (v2) are posted below along with the recent source patches. -- [[ManuelPereira]] - 09 Jun 2003
12
13 The Java AFS API (JAFS) has been updated, including additional testing programs, with patches for [[OpenAFS]] 1.2.10a source. The most recent API documents (v2) are posted below along with the recent source patches.
14
15 **Quick Steps**
16
17 1. Download <http://www.openafs.org/dl/openafs/1.2.10a/openafs-1.2.10a-src.tar.gz>
18 2. Download <https://grand.central.org/twiki/pub/AFSLore/JavaAPI/jafs-1.2.10a-diff.tar.gz>
19 3. `tar �xzf openafs-1.2.10a.tar.gz`
20 4. `tar �xzf jafs-1.2.10a-diff.tar.gz`
21 5. `cd openafs-1.2.10a`
22 6. `patch �p1 < ../jafs-1.2.10a.diff`
23 7. `./configure --with-afs-sysname=i386_linux24 --enable-transarc-paths �-java-home=/usr/java/jdk`
24 8. `make`
25 9. `make jafs`
26
27 -- [[ManuelPereira]] - 11 Nov 2003
28
29 ----
30
31 - [[README]]: JAFS v2 README file (read for patch instructions)
32
33 - [[openafs-jafs-API-v2.2.tar.gz]]: API docs for Java AFS v2.2 (userspace and admin)
34
35 - [[jafs-1.2.9-diff.tar.gz]]: Patch for [[OpenAFS]] 1.2.9 release source (updated 2003-11-11)
36
37 - [[jafs-1.2.10a-diff.tar.gz]]: Patch for [[OpenAFS]] 1.2.10a release source
38
39 - [[jafs-diff.tar.gz]]: Patch for current source (CVS/daily snapshots)