topic Re: Webservice SDK API Documentation in Alfresco Archive

Webservice SDK API Documentation

manmeet — Wed, 12 Jul 2006 14:33:27 GMT

I am using the Alfresco Community SDK 1.3I was loking for some documentation on the APIs but couldn't find any.Can someone direct me to it.Also am looking for sum more examples to work with the services.In the SDK Samples I only saw one Webservice Client example for creating content. Would appreciat

Re: Webservice SDK API Documentation

davidc — Wed, 12 Jul 2006 15:28:29 GMT

The readme.txt in the root of the SDK contains:

Please refer to Alfresco's on-line SDK documentation located at:

http://wiki.alfresco.com/wiki/Alfresco_SDK

That page has step-by-step instructions for setting up the SDK in Eclipse including the following reference list of Eclipse sample projects:

SDK FirstFoundationClient - use of embedded Alfresco server via the Foundation API.
SDK FirstJCRClient - use of embedded Alfresco server via the JCR API.
SDK FirstWebServiceClient - use of remote Alfresco server via the Web Services API.
SDK JCRSamples - a mixture of JCR code samples including a simple WIKI demonstration.
SDK WebServiceSamples - a mixture of Web Service samples.

SDK CustomAction - how to develop a custom Action which may be deployed to an Alfresco Repository.
SDK CustomAspect - how to develop a custom Aspect with behaviour which may be deployed to an Alfresco Repository.

SDK CustomJSP - how to develop and configure a custom JSP for the Alfresco Web Client.
SDK CustomDialog - how to develop and configure a custom Dialog for the Alfresco Web Client.
SDK CustomWizard - how to develop and configure a custom Wizard for the Alfresco Web Client.
SDK CustomLogin - example demonstrating how to override Login page of the Alfresco Web Client.
SDK TaggingSample - example demonstrating how to adding document tagging behaviour to the Alfresco Web Client (Cool!).

There are two web service sample projects (in bold above). The links to the API references are also listed in the page (for web services, also in bold above)

Re: Webservice SDK API Documentation

manmeet — Wed, 12 Jul 2006 15:38:41 GMT

Thank you very much for thespeedy reply.

I am still looking for Documnetion of the APIs in the SDK.
ie. web-service-client.jar if available online.

Else I shall have to create the java Docs for it.

Thanks,
-Manmeet

Re: Webservice SDK API Documentation

davidc — Wed, 12 Jul 2006 15:45:20 GMT

I've just checked and the pre-packaged Javadoc for web-service-client.jar is actually missing from the SDK. That's a bug - can you raise it in JIRA.

Re: Webservice SDK API Documentation

manmeet — Wed, 12 Jul 2006 16:13:18 GMT

Hi David,

I am not aware of how to raise a JIRA.

It would be nice if you could give me directions or raise it on my behalf.

____________
Thanks,
Manmeet

Re: Webservice SDK API Documentation

davidc — Wed, 12 Jul 2006 20:44:09 GMT

Go to http://www.alfresco.com, click on the developers tab and search for "Bug Tracking". It's worth your while taking the effort to do this, as you'll find JIRA a valuable tool for tracking issues and general tasks.

Re: Webservice SDK API Documentation

manmeet — Wed, 12 Jul 2006 21:41:52 GMT

Raised a JIRA request. here is the reference to the same.

http://www.alfresco.org/jira/browse/DOC-8

Typically how many days would it take for them to resolve this issue?
How will I be notified about it??

——————————
Thanks, Manmeet