topic Re: subscribe aspect in Alfresco Archive

subscribe aspect

xerox — Wed, 29 Mar 2006 07:08:51 GMT

I made a link by every document(in de browse page) with subscribe.the meaning of this is, that a person can subscribe himself on a document.If you click on that link, it calls browsebean.subscribe.code of browsebean.subscribepublic void Subscribe() { UserTransaction tx = null; try

Re: subscribe aspect

gavinc — Wed, 29 Mar 2006 10:31:21 GMT

Hi,

The subscribe aspect is one that doesn't have any functionality tied to it. The code you have looks fine so you'll probably find that it has in fact added the aspect to the node (you could see this through the node browser in the admin console). You would also have to add the association to a 'person', this can be done through the UI. Simply configure the "subscribedBy" association to appear for any nodes that have the "subscribable" aspect applied.

However, for something to happen when the node is "touched" will require some customisation. The other topic you posted to had some information on tying into the policy framework which could be used to accomplish this.

Re: subscribe aspect

xerox — Wed, 29 Mar 2006 12:14:15 GMT

thx…

<You would also have to add the association to a 'person', this can be done through the UI. Simply configure the "subscribedBy" association to appear for any nodes that have the "subscribable" aspect applied. >

How can I do this? can you explain a little further, because I don't get it.

Nick
thx in advance

Re: subscribe aspect

gavinc — Wed, 29 Mar 2006 13:14:03 GMT

I'm presuming you know about the web-client-config-custom.xml file, if not take a look at: http://wiki.alfresco.com/wiki/Web_Client_Configuration_Guide

Edit the web-client-config-custom.xml file and add the following config section:


<config evaluator="aspect-name" condition="subscribable">
   <property-sheet>
      <show-association name="subscribedBy" />
   </property-sheet>
</config>
‍‍‍‍‍‍‍

Then when you view and edit the properties of the node you will see the subscribedBy property listed.

Re: subscribe aspect

xerox — Thu, 30 Mar 2006 06:18:20 GMT

With which method of the nodeservice can I add associations?
I mean when a user click on the subscribe link, he needs to be add as an association of subscribe.

I tried this.but this isn't working.

String nameuser = this.authenticationService.getCurrentUserName();
NodeRef refuser = this.personService.getPerson(nameuser);

         //associate the user with it.

this.nodeService.createAssociation(getDocument().getNodeRef(),refuser,ContentModel.ASSOC_SUBSCRIBEDBY);

Nick

Re: subscribe aspect

gavinc — Thu, 30 Mar 2006 08:45:32 GMT

The code you have looks fine to me.

When you say it isn't working what do you mean? You don't see an association from the node to the user in the node browser? or are you getting an exception?

Re: subscribe aspect

xerox — Thu, 30 Mar 2006 09:20:21 GMT

I always get a null pointer exception.
I also don't see the association in de node browser.

Re: subscribe aspect

xerox — Thu, 30 Mar 2006 10:22:52 GMT

I found my mistake. the services authenticationService and personService gave the nullpointer exception.
My solution

FacesContext context = FacesContext.getCurrentInstance();
//       Obtain the ServiceRegistry
        ServiceRegistry serviceRegistry = Repository.getServiceRegistry(context);

           // Obtain the services we need from the ServiceRegistry
           authenticationService = serviceRegistry.getAuthenticationService();
           personService = serviceRegistry.getPersonService();

this is working with the authenticationservice, but not with the personservice. Because the serviceRegistry doesn't know a personservice.
How can I fix this?

Re: subscribe aspect

xerox — Fri, 31 Mar 2006 06:18:03 GMT

it workes…
Now a person can subscribe at an item.

for the personservice I needed this line

PersonService personService = (PersonService)FacesContextUtils.getRequiredWebApplicationContext(context).getBean("personService");

Now I'll try to implement a class which sends email to the subscribers.

Nick

Re: subscribe aspect

xerox — Fri, 31 Mar 2006 10:29:48 GMT

If now a person subcribe to content, It works.
But If If Checkout and than checkin that content I've always get an error

Unable to check in Content Node due to system error:null

and the error takes place when it runs the trought the follwing code
public AssociationRef createAssociation(NodeRef sourceRef, NodeRef targetRef, QName assocTypeQName)
            throws InvalidNodeRefException, AssociationExistsException
    {
        // Invoke policy behaviours
       invokeBeforeUpdateNode(sourceRef);



        Node sourceNode = getNodeNotNull(sourceRef);
        System.out.println(sourceNode);
        Node targetNode = getNodeNotNull(targetRef);
        System.out.println(targetNode);
        System.out.println(assocTypeQName);
        // see if it exists
        NodeAssoc assoc = nodeDaoService.getNodeAssoc(sourceNode, targetNode, assocTypeQName);
        if (assoc != null)
        {
            throw new AssociationExistsException(sourceRef, targetRef, assocTypeQName);
        }
        // we are sure that the association doesn't exist - make it
        assoc = nodeDaoService.newNodeAssoc(sourceNode, targetNode, assocTypeQName);
        AssociationRef assocRef = assoc.getNodeAssocRef();

      // Invoke policy behaviours
      invokeOnUpdateNode(sourceRef);
        invokeOnCreateAssociation(assocRef);

        return assocRef;
    }

Re: subscribe aspect

xerox — Mon, 03 Apr 2006 06:02:04 GMT

I've solved the error.
Now I want to implement the class I've got from another alfresco user(Ryan Berg)

This is the class:

package org.alfresco.repo.subscribable;

import org.alfresco.model.ContentModel;
import org.alfresco.repo.content.ContentServicePolicies;
import org.alfresco.repo.policy.JavaBehaviour;
import org.alfresco.repo.policy.PolicyComponent;
import org.alfresco.repo.transaction.TransactionListenerAdapter;
import org.alfresco.repo.transaction.AlfrescoTransactionSupport;
import org.alfresco.service.cmr.repository.AssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.security.AuthenticationService;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.mail.SimpleMailMessage;
import org.springframework.mail.javamail.JavaMailSender;

import java.util.ArrayList;
import java.util.List;

/**
* Aspect that enables a content item to be subscribed to.
* Upon update of the content item, all subscribers will be notified.
*
* @author Ryan Berg (rberg@tsgrp.com)
* @version 1.0
*/
public class SubscribableAspect extends TransactionListenerAdapter implements ContentServicePolicies.OnContentUpdatePolicy
{
    // Logger
    private static final Log logger = LogFactory.getLog(SubscribableAspect.class);

    private static final String SUBSCRIBERS_ADDRESSES = "SubscribableAspect.subscribersAddresses";
    private static final String NOTIFICATION_INFO = "SubscribableAspect.notificationInfo";

    // Unknown user, for when authentication has not occured
    private static final String USERNAME_UNKNOWN = "unknown";

    // Dependencies
    private NodeService nodeService;
    private AuthenticationService authenticationService;
    private PolicyComponent policyComponent;
    private JavaMailSender mailSender;

    /**
     * @param nodeService the node service to use for audit property maintenance
     */
    public void setNodeService(NodeService nodeService)
    {
        this.nodeService = nodeService;
    }

    /**
     * @param policyComponent the policy component
     */
    public void setPolicyComponent(PolicyComponent policyComponent)
    {
        this.policyComponent = policyComponent;
    }

    /**
     * @param authenticationService the authentication service
     */
    public void setAuthenticationService(AuthenticationService authenticationService)
    {
        this.authenticationService = authenticationService;
    }

    /**
     * @param mailSender The JavaMailSender to set.
     */
    public void setMailSender(JavaMailSender mailSender)
    {
        this.mailSender = mailSender;
    }

    /**
     * Initialise the Auditable Aspect
     */
    public void init()
    {
        // Bind Behaviours
        this.policyComponent.bindClassBehaviour(
                ContentServicePolicies.ON_CONTENT_UPDATE,
                ContentModel.ASPECT_SUBSCRIBABLE,
                new JavaBehaviour(this, "onContentUpdate"));
    }

    /**
     * Maintain audit properties on update of node
     *
     * @param nodeRef the updated node
     */
    public void onContentUpdate(NodeRef nodeRef, boolean isNew)
    {
        AlfrescoTransactionSupport.bindListener(this);

        List<AssociationRef> subscribers = nodeService.getTargetAssocs(nodeRef, ContentModel.ASSOC_SUBSCRIBEDBY);
        String modifier = getUsername();

        NotificationInfo info = new NotificationInfo(modifier, nodeRef);
        AlfrescoTransactionSupport.bindResource(NOTIFICATION_INFO, info);

        List<String> emailAddresses = getAddressList();

        for (AssociationRef ar : subscribers)
        {
            NodeRef subscriber = ar.getTargetRef();
            String emailAddress = (String) nodeService.getProperty(subscriber, ContentModel.PROP_EMAIL);
            emailAddresses.add(emailAddress);
        }

        if (logger.isDebugEnabled())
            logger.debug("Subscribeable node " + nodeRef + " updated [notified=" + subscribers + "]");
    }

    private List<String> getAddressList()
    {
        List<String> addresses = (List<String>)AlfrescoTransactionSupport.getResource(SUBSCRIBERS_ADDRESSES);

        if(addresses == null)
        {
            addresses = new ArrayList<String>();
            AlfrescoTransactionSupport.bindResource(SUBSCRIBERS_ADDRESSES, addresses);
        }

        return addresses;
    }

    /**
     * @return the current username (or unknown, if unknown)
     */
    private String getUsername()
    {
        String currentUserName = authenticationService.getCurrentUserName();
        if (currentUserName != null)
        {
            return currentUserName;
        }
        return USERNAME_UNKNOWN;
    }

    /**
     * Send an e-mail to a subscriber
     *
     * @param subscriber - email address of subscriber
     * @param info       - notification information
     */
    private void notifySubscriber(String subscriber, NotificationInfo info)
    {
        SimpleMailMessage simpleMailMessage = new SimpleMailMessage();
        simpleMailMessage.setTo(subscriber);
        simpleMailMessage.setSubject("*** Alfresco Subscription Alert: " + info.getName());

        StringBuilder buf = new StringBuilder(256);

        buf.append("An item you are subscribed to has been modified.\r\n\r\n");
        buf.append("PATH:        " + info.getPath() + "/" + info.getName() + "\r\n");
        buf.append("MODIFIED BY: " + info.getModifier() + "\r\n");

        simpleMailMessage.setText(buf.toString());
        simpleMailMessage.setFrom("alfresco@alfresco.org");

        try
        {
            // Send the message
            this.mailSender.send(simpleMailMessage);
        }
        catch (Throwable e)
        {
            // don't stop the action but let admins know email is not getting sent
            logger.error("Failed to send subscription alert email to " + subscriber, e);
        }
    }

    public void afterCommit()
    {
        List<String> addresses = (List<String>)AlfrescoTransactionSupport.getResource(SUBSCRIBERS_ADDRESSES);
        NotificationInfo info = (NotificationInfo)AlfrescoTransactionSupport.getResource(NOTIFICATION_INFO);

        for (String emailAddress : addresses)
        {
            notifySubscriber(emailAddress, info);
        }
    }

    /**
     * Simple class which contains the notification information.
     * Data member values are initialized by passing the node reference
     * into the constructor.
     */
    private class NotificationInfo
    {
        private String modifier;
        private String name;
        private String path;

        public NotificationInfo(String modifier, NodeRef nodeRef)
        {
            setModifier(modifier);
            setName((String) nodeService.getProperty(nodeRef, ContentModel.PROP_NAME));
            setPath((String) nodeService.getPath(nodeRef).toDisplayPath(nodeService));
        }

        private void setModifier(String modifier)
        {
            this.modifier = modifier;
        }

        public String getModifier()
        {
            return modifier;
        }

        private void setName(String name)
        {
            this.name = name;
        }

        public String getName()
        {
            return name;
        }

        private void setPath(String path)
        {
            this.path = path;
        }

        public String getPath()
        {
            return path;
        }
    }
}

but I don't know how I can 'bind' this class, so it will send these mails when content is updated.
Can anyone help me?
Nick

Re: subscribe aspect

xerox — Mon, 03 Apr 2006 07:37:39 GMT

I've made subscribe.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE beans PUBLIC '-//SPRING//DTD BEAN//EN' 'http://www.springframework.org/dtd/spring-beans.dtd'>

<beans>

    <!– Action Service –>

    <bean id="Subscribe" class="org.alfresco.repo.subscribable.Subscribe" init-method="init">
        <property name="nodeService">
            <ref bean="nodeService" />
        </property>
        <property name="policyComponent">
        <ref bean="policyComponent"/>
        </property>
        <property name="authenticationService">
            <ref bean="authenticationService" />
        </property>
       <property name="mailService">
            <ref bean="mailService" />
        </property>
    </bean>


</beans>

and placed a link in application-context.xml
<import resource="classpath:alfresco/subscribe.xml" />

but still this isn't working. the system doens't send mails when content is updated.
Do I need to programm something ele?

Nick

Re: subscribe aspect

xerox — Mon, 03 Apr 2006 08:57:21 GMT

never mind, it works
but only is I update something with the updatebutton.
with the checkinbutton, it doesn't work.