Alfresco 3 Web Services

Table of Contents

• Preface

• Chapter 1: Introducing the SOAP Web Services API
  • Web Services
    • Web Services in Alfresco
    • Introducing SOAP
      • SOAP vs. REST
      • The format of SOAP messages
      • The Web Services Description Language
  • Using Alfresco Web Services
    • Using the Alfresco Web Services client SDK
    • Setting up the Alfresco SDK
    • Testing the Web Services client
  • Summary

• Chapter 2: Creating and Modifying Content
  • The Content Manipulation Language (CML)
    • Setting up the Java classpath
      • Using the precompiled client
      • Using third-party frameworks
  • Authentication
    • Setting the endpoint address with a properties file
    • Setting the endpoint address programmatically
  • Performing operations on nodes
    • Creating nodes
    • Creating content
      • Creating content using the content service
    • Removing nodes
    • Moving nodes
    • Copying nodes
  • Associations
    • Adding child nodes
    • Removing child nodes
  • Versioning
    • Updating nodes without versioning
    • Getting the version history
  • Aspects
    • Adding aspects
    • Removing aspects
  • Searching the repository
    • Performing Lucene queries
    • Querying associated nodes
      • Association
    • Querying child nodes
    • Querying parent nodes
  • Summary

• Chapter 3: Collaboration and Administration
  • Creating collaborative content
    • Performing a check-out
    • Check-in
      • Check-in with versioning
      • Check-in—importing external content
    • Cancelling a check-out
  • Managing versioning explicitly
    • Creating a new version
    • Deleting all the versions
    • Getting the version history
    • Reverting a version
  • Managing locking explicitly
    • Locking
    • Unlocking
    • Getting the lock status
  • Classification and categories
    • Getting classifications
    • Describing a classification
    • Getting categories
    • Adding categories
    • Getting child categories
  • Authorization
    • Setting owners
    • Adding permissions
    • Creating authorities
    • Managing actions
      • Getting action definitions
    • Default actions
      • Getting an action definition
      • Executing actions
      • Saving actions
      • Getting actions
      • Removing actions
  • Managing rules
    • Default Conditions
    • Adding rules
  • Managing users
    • Adding users
    • Deleting users
    • Updating users
    • Changing passwords
    • Getting user information
    • Searching users
  • Summary

• Chapter 4: A Complete Example
  • Setting up the project
  • The Bookshop model
    • Sign in page
    • Home page
    • Configure the bookshop repository
    • Book details page
    • Getting book properties
    • Checking the cart space
    • Getting all the associated reviews
  • Adding a book to the cart
    • Checking if the cart space exists
    • Creating the cart space
    • Adding a book in the cart
  • Cart page
    • Removing a book from the cart
    • Adding a review
  • Managing reviews page
    • Accepting reviews
    • Rejecting reviews
  • Changing user details
  • Summary

• Chapter 5: Using the Alfresco Web Services from .NET
  • Setting up the project
    • Testing the .NET sample client
  • Searching the repository
  • Performing operations
    • Authentication
    • CRUD operations
      • Creating nodes
      • Creating content
      • Updating nodes
      • Copying nodes
      • Moving nodes
      • Removing nodes
  • Managing child associations
    • Adding child nodes
    • Removing child nodes
  • Summary

• Chapter 6: Introducing the Web Scripts Framework
  • A lightweight alternative to SOAP Web Services
  • REST concepts
    • Constraints
    • Resources
    • Representations
    • REST in practice
      • Use URLs to identify resources
      • Use HTTP methods properly
    • Avoiding tight coupling
    • Use hyperlinks to drive the application state
  • Your first Web Script
    • Components of a Web Script
    • Creating your first Web Script
    • Invoking your first Web Script
    • Adding a controller
  • The Model-View-Controller pattern
  • URL matching
  • Authentication
    • Run as
    • The Login service
  • Transactions
  • Requesting a specific format
    • Status
  • Configuring Web Scripts
  • Cache control
  • Deployment
  • Summary

• Chapter 7: Templating with FreeMarker
  • FreeMarker concepts
  • Variable interpolation
    • FreeMarker expressions
      • Scalars
      • Containers
      • Operators
      • Missing values
      • Built-ins
  • Directives
    • Assign
    • If
    • List
    • Include
    • Macro
      • Nested content
      • Macros with parameters
  • Comments
  • Using FreeMarker in Web Scripts
    • The TemplateNode API
      • Searching
  • A simple example
  • Generating an Atom Categories Document
    • Atom
    • The Alfresco Bookshop
    • Categories in Atom
    • Categories in Alfresco
    • Creating the Web Script
      • The descriptor
      • The controller
      • The template
      • Using the Web Script
    • Categories as JSON
  • Summary

• Chapter 8: Writing a Web Script Controller in JavaScript and Java
  • Providing a Web Script with a JavaScript controller
  • Root objects
  • General scripting techniques
    • Importing scripts
    • Logging
    • Debugging
  • Searching the repository
    • Performing a simple Lucene search
      • A primer on Lucene query syntax
      • Sorting results
  • The ScriptNode API
    • Properties of nodes
      • Writing properties
    • Navigating the repository
    • Performing operations on nodes
      • Creating new nodes
      • Deleting nodes
      • Copying and moving nodes
    • Manipulating content
  • A step-by-step example—posting reviews
    • Requirements
    • The protocol
    • Representations
    • Implementing the first version
      • Extending the content model
      • Configuring the Alfresco Explorer
      • Creating the Web Script descriptor
      • Creating the controller
      • Creating the template
      • Testing the Web Script
    • Using Atom
      • Anatomy of an Atom entry
      • A controller that accepts Atom entries
    • Checking for duplicate reviews
      • Finding duplicates
      • The revised controller
  • Writing Web Scripts in Java
    • Types of Java-backed Web Scripts
      • Declarative Web Scripts
    • Posting reviews: The Java version
  • Summary

• Chapter 9: Putting it All Together
  • The Atom Publishing Protocol
    • A bit of history
      • Enter AtomPub
    • AtomPub concepts
      • Resources and entries
      • Collections and feeds
    • The Service Document
    • Creating resources
      • Entry and media resources
    • Updating resources
    • Deleting resources
  • Listing books by category
    • Service URI
    • Response format
    • Implementing the service
      • The descriptor
      • The controller
      • The template
    • Testing the service
      • Using curl
      • A simple Java client
  • Creating a new book
    • Service URI
    • Request format
    • Implementing the service
      • The descriptor
      • The controller
      • The template
    • Uploading content
      • The descriptor
      • The controller
      • The template
    • Testing the service
      • Using curl
      • A simple Java client
  • Updating an existing book
    • The implementation
    • Testing with curl
    • Dealing with concurrent edits
      • Implementation
    • The Java client
  • Deleting a book
    • Testing deletion
  • Summary

• Chapter 10: Overview of CMIS
  • A bit of history
    • A word of warning
  • Objectives of CMIS
    • What CMIS does not include
  • CMIS vs. JCR
  • The CMIS domain model
    • Objects
      • Documents
      • Folders
      • Relationships
      • Policies
      • Custom object types
    • Properties
  • Services
    • Repository Services
    • Navigation Services
    • Object Services
    • Multi-filing Services
    • Discovery Services
    • Versioning Services
    • Relationship Services
    • Policy Services
    • ACL Services
  • Capabilities
    • Navigation capabilities
    • Object capabilities
    • Filing capabilities
    • Versioning capabilities
    • Query capabilities
    • ACL capabilities
    • Capabilities supported by Alfresco
  • Protocol bindings
    • The AtomPub binding
    • The Web Services binding
  • CMIS in action
    • CMIS-enabled servers
      • Alfresco
      • Nuxeo
      • eXo
      • KnowledgeTree
      • Sense/Net
      • The closed-source world
    • Client toolkits
      • Apache Chemistry and OpenCMIS
      • Drupal
  • Summary

• Chapter 11: The CMIS AtomPub Binding
  • The CMIS AtomPub binding
    • Authenticating
    • Getting the Service Document
      • Collections
      • Repository info and URI templates
    • Navigating the repository
    • Reading entries
    • Reading type information
    • Creating new objects
      • Creating a new folder
      • Creating a new document
    • Updating a document's metadata
    • Deleting a document
    • Performing a search
      • Paging search results
      • Queries
  • Summary

• Chapter 12: Developing a CMIS Client using Apache Chemistry
  • Introducing Apache Chemistry
    • Chemistry, OpenCMIS, and the Alfresco TCK
  • Downloading and installing Chemistry
    • Building Chemistry
    • Importing Chemistry into Eclipse
  • The modules of the Chemistry client API
    • The main client classes
  • Setting up a connection
    • Setting up a connection with AtomPub
    • Setting up a connection with Web Services
  • Code samples
    • Listing the server's capabilities
    • Listing repository types
    • Getting a type definition
    • Listing the root folder
    • Creating a new folder
    • Creating a new text document
    • Uploading a binary document
    • Reading a document's content
    • Updating properties
    • Deleting a document
    • Searching
    • Listing relationships
  • Summary

• Chapter 13: The Web Services Binding
  • Getting at the WSDLs
    • Setting up the client project
    • Declaring the CMIS client bean
  • Some necessary pieces: WS-Security and WS-I Basic Profile
  • Browsing the repository
  • Inspecting objects
  • Acting upon objects
    • Creating a new text document
    • Creating a new folder
    • Updating a text document
    • Updating properties
    • Deleting a document
    • Searching a document
  • Summary

• Chapter 14: A Complete CMIS Client Application
  • CMISWiki—a CMIS-based wiki
    • Requirements
    • Software building blocks
      • The Google Web Toolkit
      • The Mylyn WikiText parser
  • Building and running CMISWiki
  • The user interface
  • Implementation
    • Client-side code
      • The GWT UiBinder
      • Links and the browser history
    • Server-side code
    • Implementation of use cases
      • Creating a new page
      • Loading an existing page
      • Uploading an image
      • Displaying an image
      • Searching
  • Summary

• Appendix: The CMIS Query Language
  • The relational view projection
    • Hierarchy of types and the relational view
  • Results of queries
  • Grammar of queries
    • The SELECT clause
    • The FROM clause
      • Joins
    • The WHERE clause
    • Comparison operators
    • Testing multi-valued properties
    • Full-text search using CONTAINS
      • The IN_FOLDER predicate
      • The IN_TREE predicate
    • The ORDER BY clause
  • Escaping special characters

• Index

Ugo Cei

Piergiorgio Lucidi

Code Downloads

Download the code and support files for this book.

Submit Errata

Please let us know if you have found any errors not listed on this list by completing our errata submission form. Our editors will check them and add them to this list. Thank you.

Sample chapters

You can view our sample chapters and prefaces of this title on PacktLib or download sample chapters in PDF format.