When working with the Alfresco Foundation API, you should use Alfresco's services interfaces as much as possible, rather than the implementation classes. The definitive resource for these classes is the Javadoc, the source code, and the test classes that often accompany each of the services. The goal of this section is to make you aware of the "public" services that are available and provide a cross-reference between the service's interface, the implementation class, the test class (if one's available), and the Spring Bean ID.
|
Description |
Used to post activities and retrieve feeds of activities scoped to a particular site or across all sites. See |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Gets and sets global, arbitrary attributes. Note: This is not what you would use to get the attributes (more correctly, "properties") of a node. Use the NodeService for that. Alfresco uses this service to store things such as a table of locked objects. But you could use it to store settings for your own needs as well. | |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
|
|
Description |
Public service used to write (and list) audit entries for a node. Unlike the lower-level auditing functionality, which is configured by adding annotations to service classes, this service is meant to be called by higher-level classes such as actions. |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Service used to authenticate with the repository. Includes methods for authenticating as guest, getting, validating and invalidating tickets, and getting the current username. | |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
|
|
Service used to find authorities, check for the presence of an authority, and find the authorities that contain a particular authority (where an authority might be a user or a group). This service is not used to create new users, however. That's done with the | |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Used for working with AVM stores. Its equivalent on the Document Management side of Alfresco is NodeService. The AVMService is used to manage nodes (including adding and removing aspects, and setting properties), stores, and branches. | |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Service used to add and remove locks to and from nodes in the AVM store. |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
|
|
Description |
Used to check out, check in, or cancel the check out of a particular node. |
|
Interface |
|
|
| |
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
The |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Service used for reading and writing content from and to a node. |
|
Interface |
|
|
| |
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Service used for copying nodes. It is up to you to rename the new node if duplicate child names are not allowed by the containing association. See also | |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Service used to copy nodes from one repository implementation to another (for example, copying from the DM store to the WCM or AVM store). |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
N/A |
|
|
|
Service used to retrieve (but not set) metadata about the Alfresco installation. The metadata is limited to the schema that was present when it was installed, and information about the currently installed license file (issuer, expiration date, and so on). | |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Used to query the deployed content model. The service can get the list of types, aspects, properties, and associations deployed in the repository. It can also be used to check whether a type is a subtype of another. | |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
N/A |
|
|
|
Description |
This service, not to be confused with the |
|
Interface |
|
|
| |
|
JUnit Test Class |
N/A |
|
Spring Bean ID |
|
|
Description |
Service for copying, creating, deleting, and searching files and folders. |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
|
|
Description |
Service used to import files and metadata into the repository. The service expects a ZIP file that follows the ACP format. See "ACP Files" in Appendix C. |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Used as part of Alfresco's WCM functionality, this service performs link checks on objects in the AVM store. It can also be used to retrieve a list of the objects that another object depends on. |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
N/A |
|
Spring Bean ID |
|
|
Service used to lock or unlock a node or collection of nodes. Can also be used to find out nodes that are locked across the entire store. | |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
|
|
Description |
Service used to work with mimetypes such as getting the mimetype for a particular extension (or vice-versa) and for guessing a mimetype based on a file name. The service also includes an |
|
Interface |
|
|
| |
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Service used to declare that a node is a translation of another. The service can also be used to find translations for a given node, and test whether or not a given node is a translation. |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Service for doing just about anything you could ever want to with a node, including creating and deleting nodes, checking a node for the presence of an aspect, getting and setting a node's properties, and getting a node's associations. |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
|
|
Service used to determine the owner of an object and take ownership of that object. | |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
Description |
Service used for getting and setting the permissions on a node. |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Service used to manage person objects in the repository. Everyone has a person object, even if their authentication credentials are managed by some other source. |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Service used to manage system-wide metadata. For example, after an AMP is installed, its configuration data is stored using the |
|
Interface |
|
|
| |
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Service used to do things such as reloading a message bundle or hot-deploying a content model without requiring a restart of the repository. |
|
Interface |
|
|
| |
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Service used to export the repository as an ACP file. | |
|
Interface |
|
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Service for creating tags, assigning tags to nodes, and finding nodes based on a given tag. |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Service for executing templates using a template rendering engine. FreeMarker is the default template rendering engine. |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
N/A |
|
Spring Bean ID |
|
|
Description |
Service for getting access to a user transaction. |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|
|
Description |
Service for working with workflows and workflow definitions. Includes methods for deploying definitions, starting workflows, and signaling nodes. |
|
| |
|
Implementation Class |
|
|
JUnit Test Class |
|
|
Spring Bean ID |
|