Java API Reference

This section provides information about the Javadoc documentation for APIs supported by CQ. CQ provides several Java APIs for use by applications. The following table summarizes the APIs and provides information on where the corresponding Javadoc API documentation can be found.

API Javadoc API Location Comments
JCR 2.0 (JSR-283) javax.jcr
The standard Java Content Repository API.
Jackrabbit 2.0 API org.apache.jackrabbit
The Jackrabbit extensions API; of the JCR reference implementation.
CRX API com.day.crx
The CRX extensions API.
See CRX Java Reference API for more details.
CQ API com.day.cq
The CQ extensions API.

API Changes as of CQ 5.3

CQ Security API

The changes to interfaces within the CQ Security API that were made between CQ 5.2 and CQ 5.3 are listed below:

Added

Removed

  • AuthorizableEvent.java
  • AuthorizableListener.java
  • AuthorizableEventType.java

Modified

  • Authorizable.java
    • The following has been deprecated.
      The new Jackrabbit user management implementation does not store the plain userID in a separate property. Instead the id is stored in jcr:uuid and its human readable representation forms the node name:
      • PROPERTY_ID
    • The following have been deprecated.
      By default these properties are now stored in the profile without duplication into user/group properties:
      • PROPERTY_NAME
      • PROPERTY_DESCRIPTION
      • PROPERTY_EMAIL
      • PROPERTY_FIRST_NAME
      • PROPERTY_LAST_NAME
  • Profile.java
    • As of CQ 5.3 extends are available from LabeledResource and PersistableValueMap, not only from ValueMap.
  • User.java
    • changePassword(String password) should now be used instead of the deprecated method setPassword(String password, String digest).
  • UserManager
    • removed the methods:
      • addModificationListener
      • removeModificationListener
    • added the methods:
      • createUser(String, String, String, String)
      • createGroup(String, String, String)
      • isAutoSave()
      • autosave(boolean)