Is there a feature matrix for the API regarding CMA vs CDA?

Hi Guys,

we understand that on a delivery stage (using vgn-appsvcs-cda.jar) some API functionality isn't available as opposed to the management stage (using vgn-appsvcs-cma.jar). We're in the process of creating a simple restful api that would need to be split up into "generally available" functionality (running against management and delivery) and "admin only" (running against management only).

Does our model make sense?

Is there a document outlining the differences? Do the API javadocs state this on a per class/method level?

Any feedback appreciated,

Markus

Find more posts tagged with

Comments

David_Stiles

It depends on what version of the product you are using, butmany differences are identified in javadocs. Some particular differences are:

<![if !supportLists]>1) <![endif]>ContentManagementOps includes methods only useful on themanagement stage.

<![if !supportLists]>2) <![endif]>Create/Update/Delete actions are generally not supported on a deliverystage, so methods such as ManagedObject.commit()/remove() will not work there.Calling any setter methods for ManagedObject properties/attributes willgenerally be pointless on a delivery stage.

<![if !supportLists]>3) <![endif]>Certain system metadata (e.g. create date, creator, modifieddate, last modifier) is not (yet) supported on delivery stages, so relatedmethods for accessing this data are irrelevant there.

<![if !supportLists]>4) <![endif]>Security settings and authorization functionality is notsupported on delivery stages.

<![if !supportLists]>5) <![endif]>Deployment/job functionality is not supported on deliverystages.

From: eLink Entry:Discussion Group - Web Experience Management[mailto:v7webcontentmanagement@elinkkc.opentext.com]
Sent: Monday, July 04, 2011 7:50 AM
To: eLink Recipient
Subject: Is there a feature matrix for the API regarding CMA vs CDA?

Is there a feature matrix for the API regarding CMA vs CDA?

Posted by mschorer@pocketkings.ie (Schorer, Markus) On 2011/07/04 07:27

Hi Guys,

Does our model make sense?

Is there a document outlining the differences? Do the API javadocs state this on a per class/method level?

Any feedback appreciated,

Markus

[To post a comment, use the normal reply function]
Forum:	Discussion Group - Web Experience Management
Livelink Server:	knowledge-wlweb01

Markus_Schorer

Hi David,

thanks for the list.

Could you please direct me to a single javadoc and api function where the differences are highlighted? I've never seen any mention of "this is only available on the management stage" eg in the 8.x API javadoc.

What is the mechanism if some functionality isn't available? Is it a specific Exception that's thrown or does it depend on the method called?

Thanks,

Markus

David_Stiles

Hello, Markus. It certainly is not mentioned for every APIfeature, but here are some examples copied directly from the 8.0 API javadocs.Also, the results of calling an API on a delivery stage that is intended onlyfor management stage use will vary from one API to another. Some methods willfail with an exception (e.g. commit()), some will return null values (e.g. accessmethod for properties not defined on delivery stages). I think there are also certainclasses not found when client code is executed in a delivery stage environment.But unfortunately there are no errors (that I’m aware of) that will tell you specificallythat you have called a management stage only API.

Class level javadocs for ContentManagementOps:

The methods in this class can only be executed against themanagement stage and should not be executed against a delivery stage. In somecases, when executed on a delivery stage, the methods could appear to workcorrectly, however, they will internally and inadvertently be executing againstthe management stage.

Method level javadocs forManagedObject.setAcl()/setAuthorizedGroups()/clearAuthorizedGroups():

This method is only useful on the management stage.

Method level javadocs for ManagedObject.getCreator()/getCreationTime()/getLastModifier()/getLastModTime()/getLastModComment()/getLockCount()/getLockOwner()/getLockTime()/getProjectPath()/getParentProjectId():

This property is currently only available on the managementstage.

Method level javadocs forManagedObject.getReferredManagedObjects()/getReferringManagedObjects()

This method applies only for management stage invocation.

From: eLink Entry:Discussion Group - Web Experience Management[mailto:v7webcontentmanagement@elinkkc.opentext.com]
Sent: Wednesday, July 06, 2011 2:12 PM
To: eLink Recipient
Subject: RE Is there a feature matrix for the API regarding CMA vs CDA?

RE Is there a feature matrix for the API regarding CMA vs CDA?

Posted by mschorer@pocketkings.ie (Schorer, Markus) On 2011/07/06 04:45

Hi David,

thanks for the list.

What is the mechanism if some functionality isn't available? Is it a specific Exception that's thrown or does it depend on the method called?

Thanks,

Markus

[To post a comment, use the normal reply function]
Topic:	Is there a feature matrix for the API regarding CMA vs CDA?
Forum:	Discussion Group - Web Experience Management
Livelink Server:	knowledge-wlweb01

Markus_Schorer

Hi David,

thanks for pointing that out, i'll train my eyes to these markings.

May i suggest that some obvious marker visualizing the dependency on the management stage may be added to the javadocs? Both on class and method (overview and detail) level? That would be awesome!

thanks,

markus