topic Re: Creation of a Alfresco Webservice for Enterprise System in Alfresco Archive

Creation of a Alfresco Webservice for Enterprise System

rv_a_sharma — Tue, 24 Feb 2009 08:48:56 GMT

Hello All, I am totally unaware of development capabilities on Alfresco. I am looking to implement a web service in Java the interface is given to me in a WSDL file . This WSDL will be later on used provide a Enterprise System the information from Alfresco systems. Questions :1. What is the developm

Re: Creation of a Alfresco Webservice for Enterprise System

openpj — Tue, 24 Feb 2009 10:26:08 GMT

1. If you would like to use Web Services to invoke Alfresco methods to get or store contents you don't need to implement a web service client in Java.
You can download Alfresco Web Service Client (jar), include it in your Java application classpath and you can invoke methods directly from it.
You can download Alfresco Web Service Client here:
http://wiki.alfresco.com/wiki/Labs_3_Final_download_files

Here you can see all the Web Services methods and services exposed in Alfresco:
http://wiki.alfresco.com/wiki/Alfresco_Content_Management_Web_Services

3. If you want to implement your own web service client you can download WSDL for each Alfresco service here:
http://svn.alfresco.com/repos/alfresco-open-mirror/alfresco/HEAD/root/projects/remote-api/source/wsdl/

Hope this helps.

Re: Creation of a Alfresco Webservice for Enterprise System

rv_a_sharma — Wed, 25 Feb 2009 09:16:01 GMT

Hello,

Thanks for your post.

There is a little difference in understanding here. We already have a Client which is an Enterprise System. Which can accept data coming in from any of system. It expects us to provide a webservice based integration with the Alfresco.

This webservice interface which it exposes is available in the form of WSDL file. This webservice should be implemented by from Alfresco end. This is called the webservice based connector integration. So we have to write a connector from Alfresco end.

Now we have a Alfresco running on Tomcat 6.0 . I understand when we import the webservice WSDL, the Eclipse / any other IDE will give us the skeleton Java Bean which will implement the interface. And we have to provide the implementation from Alfresco end using Alfresco API's.

Kindly suggest what should we do in this regard.

Regards,
Ravi Sharma

Re: Creation of a Alfresco Webservice for Enterprise System

mrogers — Wed, 25 Feb 2009 23:29:41 GMT

Yours is an unusual requirement, what you would normally do is for your enterprise system to call one of Alfresco's remote interfaces rather than putting your own web service interface into alfresco.

However you can do what you are asking and need to become familiar with Web Service development tools.

You have a choice of putting your web service into the alfresco WAR in which case you will have to use the same runtime as alfresco or having a remote process that adapts your enterprise interface to one (or more) of alfresco's remote APIs.

What you should do is generate an implementation of the web service expected by your Enterprise system. You do this in Java, .Net, or by hand whatever you are comfortable with. I've used Visual Studio and Rational Software Architect to do this in the past but grew to dislike web services because of the clunky tooling

Your web service will then need to delegate to alfresco's methods over one of Alfresco's API's. You will need to analyse your requirements and work out the mappings between your interface and Alfresco's.

Re: Creation of a Alfresco Webservice for Enterprise System

rv_a_sharma — Thu, 26 Feb 2009 05:31:54 GMT

Hello,
Thanks again for your inputs.

It's nice to know that Technically the solution which I thought is possible.

Now the next doubt is Alfresco Running on Tomcat 6.0 ? Will it be able to support a EJB Bean (which will be implementing the WSDL interface) ?

Another doubt is related to configuration of the Webservice . We don't want to re autenticate the Webservice Access to the Alfresco . Some how the Alfresco should be configured to accept the incoming request to this Webservice as a Pre authenticated one.

Kindly Suggest what should be done in this case ?

Regards,
Ravi Sharma

Re: Creation of a Alfresco Webservice for Enterprise System

mrogers — Thu, 26 Feb 2009 09:41:16 GMT

No Tomcat will not run EJBs. To do that you would need to run Alfresco on an Application Server that supports the EJB specification such as JBOSS, WebSphere or WebLogic.

You will have to pass your authentication details through your web service, alfresco will support many enterprise SSO solutions it rather depends on your infrastructure, but this will probably be tricky and time consuming.

Re: Creation of a Alfresco Webservice for Enterprise System

rv_a_sharma — Thu, 26 Feb 2009 11:33:10 GMT

Hello,

Thats what my understanding was . But I got to know that the Alfresco runs Spring Beans ?
What is Spring Beans ? Can it also run the Java Beans ? This Tomcat 6.0 ?

We have to do an external LDAP mapping . Can Alfresco accept X.509 certificates ?
We are going to use SAP Enterprise system for this integration.
Not just Alfresco but Clearspace will also be integrated with SAP ES

Regards,
Ravi Sharma

Re: Creation of a Alfresco Webservice for Enterprise System

openpj — Fri, 27 Feb 2009 08:55:04 GMT

Alfresco is based on Spring Framework to manage all resources.
Spring is used to wire resources (Spring Beans).
A Spring Bean is a singleton that will be instantiated by Spring.
Spring is an implementation of Inversion-Of-Control pattern (IoC).

I suggest you to read Spring Reference manual for more info:
http://www.springsource.org/documentation

Spring has many sub-frameworks to manage other Enterprise aspects.

Alfresco can be integrated with LDAP and SSL:
http://wiki.alfresco.com/wiki/Ldap_over_SSL

Hope this helps.

Re: Creation of a Alfresco Webservice for Enterprise System

rv_a_sharma — Mon, 02 Mar 2009 11:17:11 GMT

Hello all,

I am currently looking to find out the Metadata about the document storage in Alfresco.

My ultimate Aim is to integrate the Alfresco with Enterprise System and make all the files in Alfresco downloadable from the Enterprise Search System. So that it can download all the files stored in alfresco and form a Centralized content indexing.

It can be done in 2 steps using the Webservices.
1. Get the details of the Alfresco Metadata ( document storage information required from Alfresco)
2. Get the details of the Actual Files. ( it will be stored in the metadata model defined in step 1)

In order to implement the first step I need to find out how the alfresco stores the document, its properties, autorization details , document URL's etc ?

Any help in this regard will be greatly appriciated.
Regards,
Ravi Sharma

Re: Creation of a Alfresco Webservice for Enterprise System

openpj — Tue, 03 Mar 2009 08:05:28 GMT

You can see the wiki to know more about Alfresco Web Services:
http://wiki.alfresco.com/wiki/Web_Services_Reference_Documentation

If you want to query a content with its own metadata (as parameters) via Web Services, you must use Repository Service and you must use a Lucene query to get this content from repository.

The steps to follow for Alfresco Web Services interface are:

1. Authentication (openSession);
2. Lucene Query;
3. Iteration on results;
4. Authentication (closeSession).

Hope this helps.

Re: Creation of a Alfresco Webservice for Enterprise System

rv_a_sharma — Tue, 03 Mar 2009 09:50:50 GMT

Thanks for your support.

I have written following code. To browse through the nodes to find out the properties.
It was given in the Samples .

But now the problem is : This runtime error.
Which says no Bean named JCR.Repository found.

How to solve this problem now ???

Now in the Application-context.xml -> import of JCR-API-Context.xml is done and in JCR-API-Context.xml the following code is written :

 
 <?xml version="1.0" encoding="UTF-8" ?> 
  <!DOCTYPE beans (View Source for full doctype…)> 
- <beans default-lazy-init="false" default-autowire="no" default-dependency-check="none">
- <bean id="JCR.Repository" class="org.alfresco.jcr.repository.RepositoryImpl" init-method="init" lazy-init="default" autowire="default" dependency-check="default">
- <property name="serviceRegistry">
  <ref bean="ServiceRegistry" /> 
  </property>
- <property name="importerComponent">
  <ref bean="importerComponent" /> 
  </property>
- <property name="defaultWorkspace">
  <value>SpacesStore</value> 
  </property>
  </bean>
- <bean id="JCR.DictionaryBootstrap" parent="dictionaryModelBootstrap" depends-on="dictionaryBootstrap" lazy-init="default" autowire="default" dependency-check="default">
- <property name="models">
- <list>
  <value>alfresco/model/jcrModel.xml</value> 
  </list>
  </property>
  </bean>
  </beans>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Exception in thread "main" org.springframework.beans.factory.NoSuchBeanDefinitionException: No bean named 'JCR.Repository' is defined
   at org.springframework.beans.factory.support.DefaultListableBeanFactory.getBeanDefinition(DefaultListableBeanFactory.java:356)
   at org.springframework.beans.factory.support.AbstractBeanFactory.getMergedBeanDefinition(AbstractBeanFactory.java:916)
   at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:243)
   at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:160)
   at org.springframework.context.support.AbstractApplicationContext.getBean(AbstractApplicationContext.java:733)
   at com.sap.alfresco.AlfrescoMetaModel.main(AlfrescoMetaModel.java:34)
‍‍‍‍‍‍‍‍

/**
*
*/
package com.sap.alfresco;
import javax.jcr.Node;
import javax.jcr.NodeIterator;
import javax.jcr.Property;
import javax.jcr.PropertyIterator;
import javax.jcr.Repository;
import javax.jcr.Session;
import javax.jcr.SimpleCredentials;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
* Simple Example that demonstrates login and retrieval of top-level Spaces
* under Company Home.
*
* @author David Caruana
*/
public class AlfrescoMetaModel
{

    public static void main(String[] args)
        throws Exception
    {
        // Setup Spring and Transaction Service
        ApplicationContext context = new ClassPathXmlApplicationContext("classpath*:alfresco/application-context.xml");

        // Retrieve Repository
        Repository repository = (Repository)context.getBean("JCR.Repository");

        // Login to workspace
        // Note: Default workspace is the one used by Alfresco Web Client which contains all the Spaces
        //       and their documents
        Session session = repository.login(new SimpleCredentials("admin", "admin".toCharArray()));

        try
        {
            // Retrieve Company Home
            Node root = session.getRootNode();
            Node companyHome = root.getNode("app:company_home");

            // Iterator through children of Company Home
            NodeIterator iterator = companyHome.getNodes();
            while(iterator.hasNext())
            {
                Node child = iterator.nextNode();
                System.out.println(child.getName());

                PropertyIterator propIterator = child.getProperties();
                while(propIterator.hasNext())
                {
                    Property prop = propIterator.nextProperty();
                    if (!prop.getDefinition().isMultiple())
                    {
                        System.out.println(" " + prop.getName() + " = " + prop.getString());
                    }
                }
            }
        }
        finally
        {
            session.logout();
            System.exit(0);
        }

    }

}

Re: Creation of a Alfresco Webservice for Enterprise System

openpj — Tue, 03 Mar 2009 10:07:20 GMT

Maybe in your class you have used inversion of control.
If you have added as a property JCR.Repository in your Spring context in this way:


<bean id="myBean" class="myBeanImplementation">
  <property name="JCRRepository"><ref bean="JCR.Repository"/></property>
  …
</bean>
‍‍‍‍‍‍

You must add a public setter method in your class to get this resource, in this way:


public void setJCRRepository(Repository repository)
   {
      this.repository = repository; 
   }
‍‍‍‍‍‍

Hope this helps.

Re: Creation of a Alfresco Webservice for Enterprise System

rv_a_sharma — Tue, 03 Mar 2009 10:48:20 GMT

I have not created any bean I am using the one provide in alfresco-repository.jar file .

Kindly suggest.

Regards,
Ravi Sharma

Re: Creation of a Alfresco Webservice for Enterprise System

openpj — Tue, 03 Mar 2009 11:03:51 GMT

Maybe there is a problem with Spring initialization.
What type of application is this app?
Is a War, a Jar or an Ear.

I think it could be a problem with Spring context listener

Re: Creation of a Alfresco Webservice for Enterprise System

rv_a_sharma — Tue, 03 Mar 2009 11:14:57 GMT

At the moment this is a Plain Java File . But our goal is to put the code in a Bean which will be part of EAR .

Regards,
Ravi Sharma

Re: Creation of a Alfresco Webservice for Enterprise System

openpj — Tue, 03 Mar 2009 11:30:40 GMT

To deploy JCR you must have a packaged application with Alfresco classes and xml configuration files.

If you want a lightweight way you can use Alfresco Web Service client and you can use it in your application:
http://wiki.alfresco.com/wiki/Alfresco_Content_Management_Web_Services

Alfresco Web Service client:
http://wiki.alfresco.com/wiki/Labs_3_Final_download_files#Alfresco_Web_Service_Client

Here you can see a Java example of how use it in your application:
http://wiki.alfresco.com/wiki/Web_Service_Samples_for_Java

Re: Creation of a Alfresco Webservice for Enterprise System

rv_a_sharma — Tue, 03 Mar 2009 11:47:41 GMT

Alright … Thanks for the help. Credit given to you for the effort

But I don't understand if I am just trying the SampleExample.java file distributed along with the Alfresco content.

Its a plain java file and trying to get the Application context.
I can get it like .

 
// Setup Spring and Transaction Service
       ApplicationContext context = new ClassPathXmlApplicationContext("classpath*:alfresco/application-context.xml");
‍‍‍‍

Now using this context I want to get he handle on Repository . This is done in the sample code.
But how come its not accepting it . At compile time i have defined that this is going to be the dependency.

But how can i define at the run time that one has to use a class which is available in the package


public class RepositoryImpl implements Repository
‍‍‍

I dont understand now what should i do to make this standalone sample java run ?

Regards,
Ravi Sharma