Version 9.6	SEARCH   CONTENTS   |   PDF BOOKS   |   HOME   UP   PREV   NEXT

The following topics are discussed in this document:

• Introduction to Bean Mapping

• Standard Mappings

• Generating Beans with the Command Line

Introduction to Bean Mapping

The beans are mapped to registry objects using Java5 Annotations.

Each bean from the application bean model has to extend or implement the RegistryBean (com.softwareag.centrasite.appl.framework.beans.RegistryBean) interface. If an interface extends the RegistryBean interface, an implementation must be provided and specified using the @Bean annotation:

@RegistryObject(objectTypeName="{http://namespaces.CentraSite.com/csaf}Item") 
@Bean(implementationClass = "...")
public interface Item extends RegistryBean{
...
}

The table below describes the annotations currently supported by the CentraSite Application framework.

Example:

/**
 * Java bean interface representing JAXR-based registry objects of type  ServiceInterfaceVersion.
 */
@RegistryObject(objectTypeName = "{http://namespaces.CentraSite.com/csaf}ServiceInterfaceVersion")
@Bean(implementationClass = "com.softwareag.centrasite.appl.framework.persistence.beanmodel.impl.ServiceInterfaceVersionImpl")
public interface ServiceInterfaceVersion extends RegistryBean{

    @Property(target = "name")
    public String getName();
    public void setName(String name); 

    /**
     * Returns the description
     */
    @Property(target = "description")
    public String getDescription(); 

    /**
     * Sets the description
     */
    public void setDescription(String description); 

    /**
     * Returns the attachments
     */
    @ExternalLink(type = com.softwareag.centrasite.appl.framework.persistence.beanmodel.ExternalLink.class)
    public List<com.softwareag.centrasite.appl.framework.persistence.beanmodel.ExternalLink> getAttachments(); 

    /**
     * Sets the attachments
     */
    public void setAttachments(
    List<com.softwareag.centrasite.appl.framework.persistence.beanmodel.ExternalLink> attachments);

    /**
     * Returns the short name of the interface version. Maps to {http://namespaces.CentraSite.com/csaf}shortName slot.
     */
     @Slot(name = "{http://namespaces.CentraSite.com/csaf}shortName")
     String getShortName();   

    /**
     * Sets the short name property of the interface version.
     */
    void setShortName(String shortName);   

    /**
     * Returns.
     */
    @Association(type = "HasReviewRequest", targetType = ReviewRequestOutcome.class, cascadeStype = CascadeStyle.DELETE)
    List<ReviewRequestOutcome> getReviewRequestOutcomes(); 

    /**
     * @param list
     */
    public void setReviewRequestOutcomes(List<ReviewRequestOutcome> list);   

    /**
     * Returns the findings, which are attached to the bean.
     */
    @Classification(classificationScheme = "CSAF -Taxonomy", conceptPath = "/ClassificationInstances/Finding", targetType = Finding.class)
    List<Finding> getFindings(); 

    /**
     *
     * @param pFindings
     */
    public void setFindings(List<Finding> pFindings);
 

    @Slots(targetType = SlotBean.class)
    public Collection<SlotBean> getSlots();
   
    public void setSlots(Collection<SlotBean> slots); 
} 

/**
 * Implementation of the {@link ServiceInterfaceVersion} bean interface.
 */
public class ServiceInterfaceVersionImpl extends DynamicRegistryBean implements
ServiceInterfaceVersion {

    private String _shortName;
    private List<ReviewRequestOutcome> _reviewRequestOutcomes;
    private Collection<SlotBean> slots;
    private String _instanceSlotName;
    private List<Finding> findings;
    private List<ExternalLink> externalLinks; 
   
    /**
     * {@inheritDoc}
     */
    public String getShortName() {
        return _shortName;
    }

    /**
     * {@inheritDoc}
     *
     * The setter is annotated that modifies the object and it needs to be
     * updated in the JAXR-based registry.
     */
    public void setShortName(String shortName) {
        _shortName = shortName;
    } 

    public List<ReviewRequestOutcome> getReviewRequestOutcomes() {
        return _reviewRequestOutcomes;
    }

    public void setReviewRequestOutcomes(List<ReviewRequestOutcome> list) {
        _reviewRequestOutcomes = list;
    } 

    public Collection<SlotBean> getSlots() {
        return slots;
    }

    public void setSlots(Collection<SlotBean> slots) {
        this.slots = slots;
    } 

    public String getInstanceSlotName() {
        return _instanceSlotName;
    } 

    public void setInstanceSlotName(String slotName) {
        _instanceSlotName = slotName;
    } 

    public List<Finding> getFindings() {
        return findings;
    } 

    public void setFindings(List<Finding> findings) {
        this.findings = findings;
    } 

    public List<ExternalLink> getAttachments() {
        return externalLinks;
    }

    public void setAttachments(List<ExternalLink> attachments) {
        externalLinks = attachments;
    } 
}

Standard Mappings

The Standard Mappings (com.softwareag.centrasite.appl.framework.beans.standard) are RegistryBeans that represent all supported JAXR-based Registry Objects under the package com.centrasite.jaxr.infomodel. They provide the functionality to operate and manage JAXR-based RegistryObjects through the Application Framework with ease.

There are other kinds of objects that are included in this package although they are not RegistryObjects (EmailAddress, PostalAddress, Slot … etc.). The Application Framework provides a mapping for them as well. Standard Mapping instances are created by the BeanPool's create(beanClass); standard non-registry object mappings (EmailAddress, PostalAddress, Slot … etc.) are managed using the com.softwareag.centrasite.appl.framework.beans.standard.StandardMappingManager.

For more information about the methods and functionality supported by Standard Mappings API, please refer to the Javadoc of the framework.

Standard Mappings Usage Sample

//Create a com.softwareag.centrasite.appl.framework.beans.standard.Organization

com.softwareag.centrasite.appl.framework.beans.standard.Organization organization = 
    beanPool.create(com.softwareag.centrasite.appl.framework.beans.standard.Organization.class);
organization.setName("MyOrganization");

// Create StandardMappingManager for managing Standard non RegistryObjects //mappings

StandardMappingManager smm = new StandardMappingManager(registryProvider);

//Create a postal address

com.softwareag.centrasite.appl.framework.beans.standard.PostalAddress pa = 
    smm.createPostalAddress("streetNumber", "street", "city",
                            "stateOrProvince", "country", "postalCode","type");
organization.setPostalAddress(pa);

// Get existing user and add it to the organization

com.softwareag.centrasite.appl.framework.beans.standard.User user = 
    beanPool.read(com.softwareag.centrasite.appl.framework.beans.standard.User.class, USER_KEY);
Collection<User> users = new ArrayList<User>();
users.add(user);
organization.setUsers(users);

// save the changes

beanPool.flush();

Generating Beans with the Command Line

You can use a command line utility to generate registry beans.

• Under Windows

• Under Linux

• Input Parameters

Under Windows

Use the following procedure to generate registry beans under Windows:

1. Open GenerateCSAFBeans.cmd in a text editor.

2. Add the following property statement:

   <CentraSiteInstallDir>\utilities\ GenerateCSAFBeans.cmd -user <USERNAME> -pass <PASSWORD> -url <CENTRASITE-URL> -typename <TYPENAME> -interfacepackage <INTERFACEPACKAGE> -implpackage <IMPLPACKAGE> -destination <DESTINATION>

   where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Under Linux

Use the following procedure to generate registry beans under Linux:

1. Open GenerateCSAFBeans.sh in a text editor.

2. Add the following property statement:

   <CentraSiteInstallDir>/utilities/ GenerateCSAFBeans.sh -user USERNAME -pass PASSWORD -url CENTRASITE-URL -typename TYPENAME -interfacepackage INTERFACEPACKAGE -implpackage IMPLPACKAGE -destination DESTINATION

   where, <CentraSiteInstallDir> is the CentraSite installation directory. By default, this is the CentraSite folder under <SuiteInstallDir>.

Input Parameters

The following table describes the complete set of input parameters that you can use to generate the registry beans:

www.softwareag.com

Copyright © 2005-2014 Software AG, Darmstadt, Germany.

SEARCH   CONTENTS   |   PDF BOOKS   |   HOME   UP   PREV   NEXT