Loading...
Helix SwarmHelix Swarm
Loading...

overview.html

  • //
  • guest/
  • bingshiao/
  • p4java/
  • r14-1/
  • src/
  • main/
  • javadoc/
  • overview.html #1
  • View
  • Commits
  • Open Download .zip Download (2 KB) 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
  2. <html>
  3. <head>
  4. </head>
  5. <body bgcolor="white">
  6. <H1>P4J -- Java Access to Perforce SCM Services</H1>
  7. The Perforce P4J Java API provides access to Perforce software configuration management
  8. services through a Java-natural API.
  9. <p>
  10. P4J is intended for use in standalone and embedded products such as Perforce's P4WSAD
  11. Eclipse plug-in or third-party products.
  12. P4J does not support all possible Perforce server commands.
  13. In particular, P4J does not support some of the more obscure Perforce admin or
  14. job-related commands, but the set of services
  15. available through P4J is intended to be useful and sufficient for day-to-day
  16. developer work and for most scripted applications.
  17. <p>
  18. P4J allows the user to select a protocol for communicating with Perforce servers (see the
  19. P4JServerFactory class in the com.perforce.p4j.server package); the details of these
  20. protocols are typically fairly opaque, but currently the two major protocol implementations
  21. use the Perforce C++ API or the Perforce p4 command-line interpreter respectively.
  22. <p>
  23. P4J assumes JDK 5 or later (it makes extensive use of parameterized types, for example),
  24. and -- depending on the protocol chosen -- your environment must include a working
  25. p4 command line interpreter (which comes with every Perforce installation) or the C++
  26. API (optionally available from Perforce's website). In most client configurations,
  27. one or both of these will already be installed in any case -- ask your IT staff.
  28. <p>
  29. The main P4J usage model is described in detail elsewhere, but in summary, the vast majority
  30. of uses start with the server factory, P4JServerFactory; this factory is used to obtain
  31. a P4JServer object that can be used to issue commands to the associated Perforce server.
  32. Other important interfaces and objects include the P4JClient (usually obtained through
  33. a P4JServer method call), which is used to issue Perforce client-specific commands (such
  34. as Perforce client workspace file edit, add, delete, and sync operations); the P4JChangeList
  35. interface for Perforce changelists; and the various Perforce file interfaces for interrogating
  36. and managing Perforce-managed files.
  37. <p>
  38. Note that P4J is thread-safe when each thread uses its own P4JServer object and subsidiary
  39. objects; other usage models do not guarantee thread-safety.
  40. </body>
  41. </html>
# Change User Description Committed
#1 16766 bingshiao "Forking branch r14.1 of perforce-software-p4java to bingshiao-p4java." 9 years ago
//guest/perforce_software/p4java/r14.1/src/main/javadoc/overview.html
#1 12541 Matt Attaway Initial add of the 14.1 p4java source code 10 years ago