Nuxeo Developers Blog

[Monday Dev Heaven] Add a Forgotten Password Functionality to Nuxeo, Part 2/2

Laurent Doguin — Mon, 21 May 2012 12:20:43 +0000

Last week I wrote the first part of a two blog post series on how to add a Forgotten Password Functionality to Nuxeo. So make sure you read the first one and here comes the second part :-)

Reset the password

The link we send to the user (see first blog post) will be manage by the enterNewPassword method. The key is part of the URL so it’s easy to retrieve using JAX-RS annotations. Once I have the key, I use the SearchRegistrationByResetPassKeyUnrestricted runner to verify that it’s still a valid key. If it is, I can render the submitNewPassword template. If not, I render the wrongResetKey template.

    @GET
    @Path("enterNewPassword/{key}")
    @Produces("text/html")
    public Object enterNewPassword(@PathParam("key") String key)
            throws ClientException {
        SearchRegistrationByResetPassKeyUnrestricted runner = new SearchRegistrationByResetPassKeyUnrestricted(
                getDefaultRepositoryName(), key);
        runner.runUnrestricted();

        String errorMessage = runner.getErrorMessage();
        if (errorMessage != null) {
            return getView("wrongResetKey");
        } else {
            Map data = new HashMap();
            return getView("submitNewPassword").arg("key", key).arg("data",
                    data);
        }
    }

    @POST
    @Path("submitNewPassword")
    @Produces("text/html")
    public Object submitNewPassword() throws ClientException,
            URISyntaxException {
        FormData formData = getContext().getForm();
        String passwordKey = formData.getString("PasswordKey");
        String password = formData.getString("Password");
        String passwordConfirmation = formData.getString("PasswordConfirmation");
        if (password == null || "".equals(password.trim())) {
            return redisplayFormWithErrorMessage("submitNewPassword",
                    ctx.getMessage("label.registerForm.validation.password"),
                    formData);
        }
        if (passwordConfirmation == null
                || "".equals(passwordConfirmation.trim())) {
            return redisplayFormWithErrorMessage(
                    "submitNewPassword",
                    ctx.getMessage("label.registerForm.validation.passwordconfirmation"),
                    formData);
        }
        password = password.trim();
        passwordConfirmation = passwordConfirmation.trim();
        if (!password.equals(passwordConfirmation)) {
            return redisplayFormWithErrorMessage(
                    "submitNewPassword",
                    ctx.getMessage("label.registerForm.validation.passwordvalidation"),
                    formData);
        }

        SetNewPasswordUnrestricted runner = new SetNewPasswordUnrestricted(
                getDefaultRepositoryName(), password, passwordKey);
        runner.runUnrestricted();
        Response response = runner.getResponse();
        if (response != null) {
            return response;
        }
        String errorMessage = runner.getErrorMessage();
        if (errorMessage != null) {
            return redisplayFormWithErrorMessage("submitNewPassword",
                    ctx.getMessage(errorMessage), formData).arg("key",
                    passwordKey);
        } else {
            return redisplayFormWithInfoMessage("submitNewPassword",
                    ctx.getMessage("label.submitNewPassword.saved"), formData).arg(
                    "key", passwordKey);
        }
    }

The form submitted from submitNewPassword is handled by the submitNewPassword method of my WebEngine module. As we did previously for the email, the form validation is run on the server side. I’m just ensuring that the passwords are not empty and identical. If the password is OK, we can jump to the SetNewPasswordUnrestricted runner. The goal of this runner is to check again if the key is still valid, and if true, change the password using the UserManager.

And that’s it, now we have a working forgotten password module. There is, of course, still room for improvements, but I feel like I can use it. So I’m going to show you how to package it for the Nuxeo Marketplace.

Create the Marketplace package

My final package is a simple zip containing only three files.
- /install/bundles/nuxeo-userpassword-reset-5.5.jar, that contains the code of my module.
- /install.xml, containing the installation instructions
- /package.xml, containing my package metadata.

Our install file will be really simple, since all we have to do is copy the jar in the nxserver/bundles folder. The following code copies the content of the folder install/bundles of my package into the bundles folder of the server. You can read more about those scripting commands in our wiki.

The package file has a lot more tags since it contains all its metadata. Most of them will be displayed in the update center. I let you read them, they’re self-explanatory. And you can read all the details in our documentation.


  Nuxeo Platform User Password Reset
  
    Nuxeo Platform User Password Reset adds a forgotten password link to Nuxeo's home page. The user clicks on the link and fill in his email address. He will receive an email shortly after with a one-day valid link. This link gets him to a simple form to reset his forgotten password.
  
  https://github.com/ldoguin/nuxeo-userpassword-reset
  Nuxeo
  
  
  false
  nuxeo_certified
  testing
  true
  
    cap-5.5
  
  LGPL
  http://www.gnu.org/licenses/lgpl.html

We can build this zip file easily using Maven and nuxeo-distribution assembly. All we have to do is zip three files so it should be easy :) This is basically a set of ant tasks. You can read the comments to understand what each task does:

This assembly file is processed by a nuxeo-distribution-tools Maven plugin. You can find the related documentation here.

  
    
      
        org.nuxeo.build
        nuxeo-distribution-tools
        
          
            ${basedir}/src/main/assemble/assembly.xml

So if you type mvn install, you will have your Marketplace package in the target folder. As you can see, creating a simple marketplace package doesn’t require too much efforts :-)

I’ve added the source code on Github. Let me know if you have any questions through the comments or on answers.nuxeo.com. See ya’ on Friday!

[Q&A Friday] How do I import a document in Nuxeo with version 12 as initial version?

Laurent Doguin — Fri, 18 May 2012 11:31:36 +0000

How do I import a document in Nuxeo with version 12 as initial version?

Today we have a question from maxr who asks how to import a document and put it in Nuxeo with version 12 as the initial version.

There are different options for this. The easiest one is to setup a custom versioning rule during the import.

Every document created at that time will be in version 12.0. Just remove the import-versioning-contrib.xml once the import is done. This will only work if you do a one-shot import and nobody creates new documents during the import.

All you need to do is deploy an import-versioning-contrib.xml file containing for instance the following code:

Now let’s say my import is done continuously. Every five minutes, the importer looks into a specific folder on a server and if it finds a file, it imports it. Our previous solution won’t work. We have to override the VersioningService. Don’t worry, it doesn’t hurt. I did a small project to showcase this.

Starting with a simple unit test to make sure we’re on the right track:

public class TestImportDocCreation extends SQLRepositoryTestCase {

	@Override
	public void setUp() throws Exception {
		super.setUp();
		deployBundle("custom-versioningservice");
		openSession();
	}

	public void testDocumentCreation() throws Exception {
		DocumentModel doc = session.createDocumentModel("/", "test", "File");
		doc.putContextData("comesFromImport", true);
		doc = session.createDocument(doc);
		assertEquals("12.0+", doc.getVersionLabel());
		doc = session.createDocumentModel("/", "test2", "File");
		doc = session.createDocument(doc);
		assertEquals("0.0", doc.getVersionLabel());
	}

	@Override
	public void tearDown() throws Exception {
		super.tearDown();
		closeSession();
	}
}

As you can see we have to put the comesFromImport boolean in the contextMap. This means we’ll have to do this in the code of your importer.

The first thing to do as usual is to run the Nuxeo Plugin project wizard in Nuxeo IDE. We need to contribute a new VersioningService so we need a new class. Here’s the code:

package org.nuxeo.sample.versioning;

import java.io.Serializable;
import java.util.Map;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nuxeo.ecm.core.api.DocumentException;
import org.nuxeo.ecm.core.model.Document;
import org.nuxeo.ecm.core.versioning.StandardVersioningService;

public class CustomVersioningService extends StandardVersioningService {

    private static final Log log = LogFactory.getLog(CustomVersioningService.class);

	@Override
	public void doPostCreate(Document doc, Map options) {
		if (doc.isVersion() || doc.isProxy()) {
			return;
		}
		try {
			Boolean comesFromImport = (Boolean) options.get("comesFromImport");
			if (comesFromImport != null && comesFromImport) {
				setVersion(doc, 12, 0);
			} else {
				setInitialVersion(doc);
			}
		} catch (DocumentException e) {
			// ignore, should not happen
			log.warn("Issue while setting the initial document version", e);
		}
	}
}

It simply extends the default VersioningService and overrides the doPostCreate method. This method has access to the document context map. So we look for a Boolean comeFromImport in this map. If it’s true, we know we come from the importer and we can set the version to 12.0. If not we just keep with the usual implementation.

Now we need the contribution to the right extension point so that Nuxeo knows the VersioningService to use is CustomVersioningService.

The source code of this project is on my Github. That’s it for today, see ya’ next Monday :-)

[Monday Dev Heaven] Add a Forgotten Password Functionality to Nuxeo, Part 1/2

Laurent Doguin — Mon, 14 May 2012 20:05:54 +0000

Password Reset

This question is sometimes asked on answers or in the forum. It’s a method to handle password reset for users. So I’m going to show you how I would do it. This is going to be a two part blog. Today I’ll write mostly about the WebEngine module handling the password reset functionality. Next week I’ll show you how to package it for Nuxeo’s Marketplace.

How does it work?

Starting with something simple, we’ll add a ‘forgotten password’ link on Nuxeo’s home page. It will redirect the user to an open (i.e. no authentication needed) page asking for an email address. Once the user submits the form, we’ll look in the user directory to see if the email has a corresponding user. If there’s no user, we’ll simply render the page again with an error message saying there’s no user associated with that email address. If we do find a user, we generate a temporary link and send it to the user by email. This link has to exist for only a short period of time, for security reasons. When the user clicks on the link, he ends up on a form asking for his new password.

That’s it for the simple, short user story. We’ll see the details along the way. Now let’s get to it :)

Ask for the reset

The first thing I did was to run the Nuxeo WebEngine project wizard with Nuxeo IDE. This gives me an empty project. I’m already able to code :) My next step is to create the form to retrieve the user email and make it available to an open URL.

This is my form:

<@extends src="./base.ftl">
<@block name="title">
 ${Context.getMessage('label.askResetPassForm.title')}

<@block name="content">



 
  <#if err??>
    
  <#if info??>
    
    
      
        ${Context.getMessage('label.registerForm.email')}
      
      
        
      
    
    
      
      
        
      
    

      
        
          ${Context.getMessage("label.connect.trial.form.errvalidation")}
          ${err}
        
      
    
  
      
        
          ${info}

One of the cool features that comes with WebEngine is its templating model. It gives us the ability to extend an existing Freemarker template. This way you can override only the part of the template you need. For instance, here we’re extending the base.ftl template (that’s because of the extends markup). This template defines at least two blocks named ‘title’ and ‘content’. So we can redefine the content of these two using the block markup.

And this is the contribution to the openUrl extension point. It’s needed to make my form available without user authentication.


  
    
      ${org.nuxeo.ecm.contextPath}/site/resetPassword/
    
    
      ${org.nuxeo.ecm.contextPath}/site/resetPassword/sendPasswordMail
    
    
      ${org.nuxeo.ecm.contextPath}/site/resetPassword/enterNewPassword/.*
    
    
      ${org.nuxeo.ecm.contextPath}/site/resetPassword/submitNewPassword
    
    
      ${org.nuxeo.ecm.contextPath}/site/skin/resetPassword/.*

Now let’s get to the Java part. The doGet method will render the page I’ve just defined, while the sendPasswordMail method will handle the form submit. In the latter, we will do the email validation, look if we have an existing user with the given address, and if this is the case, we’ll send him an email.

The validation is really simple here — we just check if the given parameter is not null nor empty. Then if we have an email address, we go through the CreatePasswordResetLinkUnrestricted. This is the class where we look for the user, build a reset password link if the user exists, or render our page with an error message. I’ve tried to internationalize the email a little, but you still have to fork the code to modify the templates and subjects… I’ll try to enhance that later.

    @GET
    public Object doGet() {
        Map data = new HashMap();
        return getView("newPasswordRequest").arg("data", data);
    }

    @POST
    @Path("sendPasswordMail")
    @Produces("text/html")
    public Object sendPasswordMail() throws ClientException {
        FormData formData = getContext().getForm();
        String email = formData.getString("EmailAddress");
        if (email == null || "".equals(email.trim())) {
            return redisplayFormWithErrorMessage("newPasswordRequest",
                    ctx.getMessage("label.registerForm.validation.email"),
                    formData);
        }
        email = email.trim();
        CreatePasswordResetLinkUnrestricted runner = new CreatePasswordResetLinkUnrestricted(
                getDefaultRepositoryName(), email);
        runner.runUnrestricted();

        String errorMessage = runner.getErrorMessage();
        if (errorMessage != null) {
            return redisplayFormWithErrorMessage("newPasswordRequest",
                    ctx.getMessage(errorMessage), formData);
        } else {
            String passwordResetLink = runner.getPasswordResetLink();
            String subject;
            Template template;
            if (ctx.getLocale().equals(Locale.FRENCH)) {
                template = getView("mail/passwordForgotten_fr");
                subject = "Nuxeo - Votre nouveau mot de passe";
            } else {
                template = getView("mail/passwordForgotten");
                subject = "Nuxeo - Your new password";
            }
            String message = template.arg("passwordResetLink",
                    passwordResetLink).render();
            try {
                sendEmail(email, subject, message);
            } catch (MessagingException e) {
                // issue while sending the mail
                log.error("Sending Registration E-Mail Error", e);
                return Response.status(500).build();
            }
            return redisplayFormWithInfoMessage("newPasswordRequest",
                    ctx.getMessage("label.sendPasswordMail.emailSent"),
                    formData);
        }
    }

    protected Template redisplayFormWithMessage(String messageType,
            String formName, String message, FormData data) {
        Map savedData = new HashMap();
        for (String key : data.getKeys()) {
            savedData.put(key, data.getString(key));
        }
        return getView(formName).arg("data", savedData).arg(messageType,
                message);
    }

    protected Template redisplayFormWithInfoMessage(String formName,
            String message, FormData data) {
        return redisplayFormWithMessage("info", formName, message, data);
    }

    protected Template redisplayFormWithErrorMessage(String formName,
            String message, FormData data) {
        return redisplayFormWithMessage("err", formName, message, data);
    }

    public void sendEmail(String email, String subject, String message)
            throws MessagingException {
        Composer cp = new Composer();
        Mailer mailer = cp.getMailer();
        Mailer.Message msg = mailer.newMessage();
        msg.setFrom(MAIL_FROM);
        msg.setSubject(subject);
        msg.setRecipient(RecipientType.TO, new InternetAddress(email));
        msg.setContent(message, "text/html");
        msg.send();
    }

Manage the keys

Now we’re able to retrieve and email address, find the corresponding user and send the email. Under the hood, the CreatePasswordResetLinkUnrestricted generates a unique key, stored in a directory along with the user email address and the current date. A directory is a good fit to store our temporary keys. I will delete every one-day-old key using Nuxeo’s event system.

Let’s add a contribution to the scheduler service. It will raise the cleanResetPassKeys event every day at 1am.

  
    
      Administrator
      cleanResetPassKeys
      default
      0 0 1 * * ?

So what we need to do now is add a listener for the cleanResetPassKeys event.

Here’s the code of my listener. It’s straightforward. The simpleDate String is the previous day’s date, formatted the same way we stored it in the directory. We use it as a directory filter. This way we can retrieve all keys created the day before and delete them. What I’d like to do in the future is make this configurable in the Admin Center. That way, the administrator could choose the time to live for the key.

public class CleanForgottenPasswordKeysListener implements EventListener {

	public static final Log log = LogFactory
			.getLog(CleanForgottenPasswordKeysListener.class);

    @Override
    public void handleEvent(Event event) throws ClientException {
		SimpleDateFormat sdf = new SimpleDateFormat("yyMMdd");
		Calendar yesterday = Calendar.getInstance();
		yesterday.add(Calendar.DATE, -1);
		String simpleDate = sdf.format(yesterday.getTime());
		DirectoryService ds;
		try {
			ds = Framework.getService(DirectoryService.class);
		} catch (Exception e) {
			throw new RuntimeException("Could not find DirectoryService", e);
		}
		Session session = ds.open("resetPasswordKeys");
		Map filter = new HashMap();
		filter.put("creationDate", simpleDate);
		DocumentModelList keysToRemove = session.query(filter);
		for (DocumentModel key : keysToRemove) {
			session.deleteEntry(key);
		}
		session.close();
    }
}

That’s it for today. In the second part I’ll tell you how to actually reset the password. Or if you are curious you can already checkout the source code on Github. I will also show you how to make a Marketplace package of this. See ya’ on Friday :)

[Q&A Friday] How to Clear UI Selected Documents in Studio

Laurent Doguin — Fri, 11 May 2012 13:21:41 +0000

Today we have a question from pibou, who asks how he can refresh the UI using content automation in Studio.
There is indeed a Refresh UI operation, but what it does is invalidate the different query caches. This will not empty the selected documents list, for instance. And that is just what pibou needs. Unfortunately we have no operation available for this by default on 5.5. So here’s a workaround, until the operation is available for 5.6.

Clear selected documents list operation

This part is simple. You need Nuxeo IDE with a SDK setup. Create a new project or use an existing one, and run the operation wizard.

Here’s what my wizard looks like:

And here’s the code of my operation:

@Operation(id = ClearSelectedDocuments.ID, category = Constants.CAT_UI, requires = Constants.SEAM_CONTEXT, label = "Clear Selected Documents", description = "Clear the default list of selected documents")
public class ClearSelectedDocuments {

	public static final String ID = "Seam.ClearSelectedDocuments";

	@OperationMethod
	public void run() {
            OperationHelper.getDocumentListManager().resetWorkingList(
                DocumentsListsManager.CURRENT_DOCUMENT_SELECTION);
	}

}

The operationHelper can give you access to some useful Seam components. Here, it gives us the DocumentListManager, which handles the different selection lists like the clipboard, the working list or the selected documents.

Now we need to make Studio aware of that operation. If you use Nuxeo IDE and have configured your Studio account, it’s dead easy. When you’re on the Nuxeo Studio tab, there’s an ‘Export operations’ button. It will first ask you to select which projects you want to scan. On the same screen, you can select the Studio project where you want to export the operations, if you have many. Click on next and you get the list of operations, it found. Select the one one you need and simply click on finish. That’s it, your operation is available in your Studio project.

What it does under the hood is simply generate a Json signature of the operation and paste it on the Studio operation registry:

So if you have other questions about Studio and operations, ask them on answers.nuxeo.com.

[Monday Dev Heaven] Create Your Own Documents on File Drag and Drop

Laurent Doguin — Mon, 07 May 2012 20:33:49 +0000

If you follow this blog you’ll remember I’ve been writing a lot about file import recently. And I have a new trick for you on this matter. When I created the import factory, I took an existing Nuxeo XML export as example. But this could also work with single files. In this case, the importer uses the FileMangerService plugin. The role of this plugin is to create Documents in Nuxeo using a given file.

When the file is imported, Nuxeo goes through each plugin following their processes. If the mime type matches, then it tries to create the document. If it returns null instead of a DocumentModel, the next plugin with a matching mime type is used, and so on. Here is a simple plugin contribution as an example:

  

    
      application/zip
    

    
      application/zip
    

    
      .*

Take a simple zip file as an example. The first plugin used will be the ExportedArchivePlugin. It will return null because the zip file is not a Nuxeo export; it doesn’t contain a .nuxeo-archive file. The next plugin will be the CSVArchivePlugin. Since the zip doesn’t contain a meta-data.csv file, the plugin returns null. The next one to be used will be the DefaultFileImporter, which will create a simple File document with the zip file as main attachment.

When should you use plugins?

Plugins are a good fit for two things. The first one is creating several documents from a single file. With the ExportedArchivePlugin, you can create as many documents as you want using the content of this archive. You could also have a big XML file or maybe a GEDCOM file.

The other good fit is choosing the right DocType for a specific file. Maybe you have defined an OfficeFile document type that would be better then the usual File for all your office files.

Sure, you could use it to add business code like metadata extraction, specific property updates, file transformation, etc., but this would be better in a listener. This way, your code is called when you create a document from a creation form or from the import. And you can choose to do this synchronously or asynchronously, which is always good for big imports or file conversions.

Creating a new plugin

So now I’m going to write a plugin that creates people and links them together from a GEDCOM file. A GEDCOM file represents a genealogical tree. You can get information about individuals, and meta data linking them together. That’s a perfect example for a FileImporter plugin. Let’s get to it!

Here is my XML contribution. It’s really simple — you need to indicate the Java class implementing your import logic, give it an order, a name and a list of mime types. GEDCOM files are text, so you just need the ‘text/plain’ mime type. I’ve chosen 9 as the order to be sure this plugin is the first to be used. If my GEDCOM parser does not recognize the file as a GEDCOM, my plugin will simply return null and the FileManagerService will give the file to the next plugin.

  
      
      text/plain

This is my Java Class which extends the AbstractFileImporter (which itself implements the FileImporter Interface). I’ve found a nice library to do the GEDCOM parsing. It’s called gedcom4j and is available on Google code. It’s open source and the project is still active.

This is a really simple and basic example. It creates a folder named as the original file, then creates documents of type Individual, adding some metadata and then linking those documents together with relations.

public class GEDCOMFileManagerPlugin extends AbstractFileImporter {

	public static final String SPOUSE_OF_PREDICATE = "http://purl.org/vocab/relationship/spouseOf";

	public static final String CHILD_OF_PREDICATE = "http://purl.org/vocab/relationship/childOf";

	private static final long serialVersionUID = 1876876876L;

	private static final Log log = LogFactory
			.getLog(GEDCOMFileManagerPlugin.class);

	protected RelationManager relationManager;

	protected DocumentModel treeContainerDoc;

	public DocumentModel create(CoreSession session, Blob content, String path,
			boolean overwrite, String filename, TypeManager typeService)
			throws ClientException, IOException {

		GedcomParser parser = new GedcomParser();
		try {
			parser.load(content.getStream());
		} catch (GedcomParserException e) {
			log.warn("Not a gedcom file", e);
			return null;
		}
		Gedcom gedcom = parser.gedcom;

		// create tree container
		treeContainerDoc = session
				.createDocumentModel(path, filename, "Folder");
		treeContainerDoc.setPropertyValue("dc:title", filename);
		session.createDocument(treeContainerDoc);

		// create every individual in the tree
		Collection everybody = gedcom.individuals.values();
		for (Individual individual : everybody) {
			DocumentModel docInd = session.createDocumentModel(
					treeContainerDoc.getPathAsString(), individual.xref,
					"Individual");
			docInd.setPropertyValue("dc:title", individual.formattedName());
			docInd.setPropertyValue("idv:xref", individual.xref);
			docInd.setPropertyValue("idv:name", individual.formattedName());
			docInd.setPropertyValue("idv:gender", individual.sex);
			session.createDocument(docInd);
		}
		// add spouseOf relations
		for (Individual individual : everybody) {
			for (FamilySpouse spouse : individual.familiesWhereSpouse) {
				if (spouse.family.husband == individual) {
					if (spouse.family.wife != null) {
						addIndividualsRelation(individual.xref,
								SPOUSE_OF_PREDICATE, spouse.family.wife.xref,
								session);
					}
				} else {
					if (spouse.family.husband != null) {
						addIndividualsRelation(individual.xref,
								SPOUSE_OF_PREDICATE,
								spouse.family.husband.xref, session);
					}
				}

			}
			// add childOf relations
			for (FamilyChild f : individual.familiesWhereChild) {

				if (f.family.wife != null) {
					addIndividualsRelation(individual.xref, CHILD_OF_PREDICATE,
							f.family.wife.xref, session);
				}
				if (f.family.husband != null) {
					addIndividualsRelation(individual.xref, CHILD_OF_PREDICATE,
							f.family.husband.xref, session);
				}
			}
		}

		return treeContainerDoc;
	}

	private RelationManager getRelationManager() {
		if (relationManager == null) {
			try {
				relationManager = Framework.getService(RelationManager.class);
			} catch (Exception e) {
				throw new RuntimeException(e);
			}
		}
		return relationManager;
	}

	private void addIndividualsRelation(String subjectXRef, String predicat,
			String objectXRef, CoreSession session) throws ClientException {
		Resource documentResource = getDocumentResource(getIndDoc(subjectXRef,
				treeContainerDoc.getRef(), session));
		Resource predicate = new ResourceImpl(predicat);

		Resource objectResource = getDocumentResource(getIndDoc(objectXRef,
				treeContainerDoc.getRef(), session));

		Statement stmt = new StatementImpl(documentResource, predicate,
				objectResource);
		Graph graph = getRelationManager().getGraphByName(
				RelationConstants.GRAPH_NAME);
		graph.add(stmt);
	}

	public DocumentModel getIndDoc(String xref, DocumentRef parentRef,
			CoreSession session) throws ClientException {
		return session.getChild(parentRef, xref);
	}

	public QNameResource getDocumentResource(DocumentModel document)
			throws ClientException {
		QNameResource documentResource = null;
		if (document != null) {
			documentResource = (QNameResource) getRelationManager()
					.getResource(RelationConstants.DOCUMENT_NAMESPACE,
							document, null);
		}
		return documentResource;
	}

}

That’s it for today — see you on Friday!

[Q&A Friday] How does the Seam.PushDocument operation work?

Laurent Doguin — Fri, 04 May 2012 12:57:36 +0000

How does Seam.PushDocument work?

A new question by Michael Bell: How does Seam.PushDocument work? Well, it does not navigate to a document, as Clément said:

If you just want to navigate to your newly created Document, you should use the Seam.NavigateTo operation.
The Seam.PushDocument operation pushes just your Document in the Seam Context.

For those of you who don’t know Seam, it’s the framework we use to write Nuxeo’s Web interface. It can be easily extended with Nuxeo Studio, hence the presence of Seam in Studio.

Seam.PushDocument adds a document to a Seam context: session, conversation, page or event. This can be useful if you think the user will click on different buttons, which is to say launch different operation chains, during his conversation or session. This way you can share documents between independent chains. So once you have stored your document, to retrieve it, you need the Seam.FetchDocument operation. It will restore the document as input for the next operation.

This can be useful if you manage your navigation with buttons. Let’s say I am currently viewing a Quality Report document. I’ve added a button called “Navigate to Incident Library.” What it does is push the current document into the Seam context and then navigates to the “Incident Library” document. When I’m inside such a document, I have a button called “Back to Report.” The only thing that button does is retrieve the document from the Seam context and then navigate to the document, using the Seam.NavigateTo operation.

[Q&A Friday] Will Nuxeo upgrade its technical Java Stack?

Laurent Doguin — Fri, 27 Apr 2012 15:46:57 +0000

CDI? Tomcat7?

Nelson Silva asked us two questions: If we plan to replace Seam in the future and is Tomcat 7 support planned?

About Seam, we will use CDI instead, mostly because it’s close to Seam concepts and because it’s a JSR (JSR-299). We try to use standards as much as we can in Nuxeo.

We already have a code sample available on Github. It builds a nuxeo-cdi-distribution, which is a coreserver distribution customized to run CDI/JSF2 components in nuxeo-cdi-sample.

About Tomcat 7, the answer here is not as straightforward as the previous one. We’d be happy to do it, but it’s not part of our priorities. So as Florent said, we’ll start the work when it is a higher priority, and there is more demand for it. This might be accelerated if we have customer requests, but this is not yet the case.

I’ve chosen these two questions today because it’s the perfect opportunity to tell you about the upcoming webinar I’ll be doing with our CTO, Thierry Delprat. Simply entitled ‘An Hour with the CTO and the Community Liaison of Nuxeo’, we’ll talk about some of the features that will be in the Nuxeo Platform version 5.6, and tell you a bit more about the roadmap and where we’re heading technically. We want to make this as interactive as possible, so don’t hesitate to come and ask your questions. If you cannot attend the webinar, feel free to ask questions in the comment section of this blog or on answers.nuxeo.com.

Next Nuxeo Code Sprint – June 21-22, 2012

Laurent Doguin — Thu, 26 Apr 2012 15:38:11 +0000

Hi guys, I wanted to let you know that we have planned the next Nuxeo code sprint. It’s scheduled for June 21-22, 2012, and will be held at Nuxeo’s office in Paris. All the details are on our wiki.

You are all more than welcome to participate. The goal of this sprint, which will occur shortly after the Nuxeo Platform 5.6 code freeze, is to produce addons for the platform. There is no particular theme, as long as it’s related to Nuxeo, of course. I strongly encourage participants to discuss their subject on the wiki prior to the sprint. It’s always good to exchange information, especially on how you plan to implement it, so that we can give you suggestions.

And even if you don’t plan on coming, don’t hesitate to add your thoughts to the wiki page, and discuss features you’d like to see. You might inspire a team … Read more

[Monday Dev Heaven] Nuxeo @ First Devoxx France – 2012 Edition

Laurent Doguin — Mon, 23 Apr 2012 19:13:13 +0000

Part of the Nuxeo team attended Devoxx France last week. If you don’t know about Devoxx, It’s an independent Java developer conference. This was the first French edition and I must say it went amazingly well for a first try, so kudos to the 20-person organizing team for pulling this off so smoothly.

We attended many, many different and interesting sessions. There’s a lot to say so I’ll try to be short. And all the sessions will be available on Parleys anyway :)

I’ll start with a very inspiring talk given by Alexandre Bertails: Linked Data – Big Data at Web scale. The web of data is here, and vendors have to step up. Nuxeo is already engaged in it through the Apache Stanbol project. This talk made me want to look more into RDFa, WebID and WebACLs.

There was a lot of interests in new languages. This is not new and reflects what’s been going on for a while on the Internet. So I went to the Ceylon and the Kotlin talks. It’s funny how those two, as well as many new languages, want to address the same issues, like Java verbosity and null pointer safety. Most Java developers write defensive code, with the sole purpose of handling null objects, making the code less clear than it should be. New languages also have to be compatible with Java. Kotlin does a great job at this. Seamless debugging with Java and Kotlin in intellij was quite impressive.

If I would have to choose, I think I’d go for Celyon. I like their approach, summed up by a simple tagline ‘say more, more clearly’. This is a very important factor for an enterprise language, and a requirement for an open source software vendor, like Nuxeo. Our code has to be easy to read/understand.

You could really see an interest in Java7. There were talks about JVM bytecode and invokedynamic, which are in a sense linked to the new language trend, and also some talks about the new stuff in Java7, like project coin or NIO2. I really liked the one by Jean-Michel Doudoux, who did a small demo every time he introduced a new feature of NIO2. It was very instructive.

There were also some talks about client/server architecture. I saw the one from James Ward. He basically said that the client is now Javascript + HTML + CSS. It’s more than a trend, it’s already here. I’ll try to show you how it can be done with WebEngine in a future blog post. This will be the time to test Webjars, a tool that he presented during his talk. It’s a Maven repo of web libraries wrapped into JAR files.

The last talk I saw was really unique — it was a live episode of Les Cast Codeurs, the French Java Posse. We had a lot of fun. You can listen to the episode here to learn more about Devoxx France 2012. Thanks to Atlassian for providing the beer :-D

So this was a really interesting week for me, because I attended both the Jenkins User Conference and Devoxx France. I now have a list of things I need to try or look into. Here are some of them:

JaCoCo
Ceylon
JBoss Byteman
Java7 features (mostly NIO2)
Webjars
WebID, WebACLs

Now I will go back to my usual blog posting pace ;-) See you on Friday!

Paris Jenkins User Conference 2012

Laurent Doguin — Wed, 18 Apr 2012 18:39:47 +0000

Update:

Julien’s video and slides are online on techtoc.tv

Yesterday I was at the Paris Jenkins User Conference 2012 with Julien Carsique. Julien was talking about how we use Jenkins at Nuxeo. For those of you who don’t know Jenkins, it’s a wonderful piece of software used to run and automate continuous integration jobs. We previously wrote a blog about this.

So about Julien’s presentation, you can check out the slides on nuxeo.com or right here:

He explained how Nuxeo has been using Jenkins for continuous integration for the past five years. We started small and added more and more jobs. At first it was for default platform tests only, and it evolved to include tests on different OS, JDK or Databases, automatic release process, code coverage tools etc.. Then he went on the different issues we had because of the ever increasing number of jobs and how we tried to solve them using for instance Jenkviz. It’s a tool that crawls a jenkins build and reports stats and graphs about the build flow. It was pretty cool to get attention the attention of the creator of the Jenkins CI server on this subject , thanks Kohsuke!

@kohsukekawa: I’m quite impressed at the degree of sophistication that Nuxeo setup is at. We need a super #JenkinsCI admin award for him!

Looks like attendees were interested in what we had to say. Some also looked scared seeing our Jenkins dashboard :-) . It’s true that it can look impressive but keep in mind that we started using Jenkins five years ago.

We also attended to some pretty cool talks, starting with a nice keynote from Kohsuke. Then we listened to Nicolas De Loof and Mathieu Ancelin who presented their Build-Flow Plugin. It was really interesting. They showed us how to manage jobs pipeline using a groovy DSL. The syntax is simple and straightforward. It looks easy and efficient. Only drawback when using this system is that it replaces the existing triggers. So we won’t be able to use it with our current build setup.

Another talk got my attention. Xavier Seignard from Pod Programming and Mickael Istria from JBoss presented Tycho, Jenkins & Sonar: The Eclipse Build Dream Team. It was nice to learn more about Tycho and to see that Eclipse (RCP/OSGI) apps works well with Jenkins and Sonar. And this was another good point about their presentation: they motivated us to test Sonar with JaCoCo, a Java Code Coverage Library. It looked so simple to setup and use, we definitely must try it at Nuxeo! Then I had a small chat with them, it was nice meeting you guys :)

Overall we had a great time, it was cool to see that much people into Jenkins. Hope there will be even more attendees next year. Congrats to Cloudbees for the organization! Next conference is Devoxx France tomorrow and Friday, maybe we’ll see you there !

${Context.getMessage('label.registerForm.email')}

${Context.getMessage("label.connect.trial.form.errvalidation")} ${err}
${info}