xcp: Custom Java Function To Access DFC IDfSession

Transcription

1 White Paper xcp: Custom Java Function To Access DFC IDfSession Writing a custom java function that can access DFC IDfSession Abstract This white paper explains writing a custom Java Function that can access DFC IDfSession in xcp Application. December 2014

2 Copyright 2014 EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. VMware is a registered trademarks of VMware, Inc. in the United States and/or other jurisdictions. All other trademarks used herein are the property of their respective owners. Part Number h

3 Table of Contents Executive summary... 4 Audience... 4 Writing Custom Java Function to access DFC IDfSession... 4 Adding Custom Java Function to the application... 6 References

4 Executive summary This preliminary white paper provides detailed explanation to add custom java code to access DFC IDfSession as a function that can be invoked from expression. Audience This white paper is intended for application designers who design applications using xcp Designer. It assumes that reader possess basic knowledge of xcp. Writing Custom Java Function to access DFC IDfSession From xcp 2.1, custom java function that can access to DFC IDfSession can be added to the application. The Custom function class can contain one or more static methods that could be manifested as function(s) in xcp Designer and available during runtime. For a java class to be a custom function class, it has to Implement the interface com.emc.xcp.expressions.functions.functionclass. Have static methods with the As part of this annotation one could override the name of the function visible in the xcp Designer and also specify the category under which it shows up in the xcp Designer. This above interface FunctionClass and the annotation class XcpFunction is available in jar xcp-java-extensions-functions.jar. Note: Expression evaluation framework manages DFC IDfSession lifecycle, so no explicit logic is required to maintain session. Example package com.emc.samples.javafunction; import com.documentum.fc.client.idfsession; import com.documentum.fc.client.idfsysobject; import com.documentum.fc.common.dfexception; import com.documentum.fc.common.dfid; import com.emc.xcp.expressions.functionclass; import com.emc.xcp.expressions.xcpfunction; import com.emc.xcp.expressions.runtime.impl.expressionexecutioncontext; public class PolicyFunctions implements FunctionClass { 4

5 1$ private static final String CATEGORY_BUSINESS_POLICY = "Business Policy"; = CATEGORY_BUSINESS_POLICY) public static boolean ispolicyattached(string sysobjid, String policyname) { String attachedpolicyname = getattachedpolicyname(sysobjid); if (attachedpolicyname == null attachedpolicyname.trim().length() == 0) { return false; return = CATEGORY_BUSINESS_POLICY) public static String getpolicyname(string sysobjid) { return getattachedpolicyname(sysobjid); private static String getattachedpolicyname(string sysobjid) { IDfSession session = getsession(); try { IDfSysObject obj = (IDfSysObject) session.getobject(new DfId(sysObjId)); return obj.getpolicyname(); catch (DfException e) { throw new RuntimeException("Could not get the attached business policy for the object "+ sysobjid, e); private static IDfSession getsession() { return (IDfSession) ExpressionExecutionContext.getContext(ExpressionExecutionContext.SESSION); 5

6 Adding Custom Java Function to the application This custom function class should include all the code required within itself or specify dependent jars needed for it to compile and run. Create a Java Extension Artifact policycustomfunctions.javamodule with: com.emc.samples.javafunction.customjavafunction.jar (in which the above compiled class exists) as implementation jar and com.emc.samples.javafunction.policyfunctions as primary class. com.emc.xcp.expressions.functionclass as interface class name. For the above example,.javamodule would look like <?xml version="1.0" encoding="utf-8"?> <nsjavamodule:javamodule xmlns:nsjavamodule=" urn="urn:xcp:com.emc.xcp.artifact.javamodule.category:artifacts/java Modules/policycustomfunctions.javamodule" categoryid="com.emc.xcp.artifact.javamodule.category" name="policycustomfunctions" label="policyfunctions" implementationclass="com.emc.samples.javafunction.policyfunctions"> <interfaceclassnames>com.emc.xcp.expressions.functionclass</interfaceclassnames> <implementationjars contentpath="content/modules/com.emc.samples.javafunction.customjavafunction.jar"/> </nsjavamodule:javamodule> The functions ispolicyattached and "getpolicyname" shows up in the xcp Designer for consumption in server side expressions (e.g. in Business Object Event conditions, Process activity transitional conditions, etc.) under the category Business Policy. Once the application containing this Java Extension Artifact is deployed, the functions are available during runtime. 6

7 References xcp Designer Help xcp Developer Guide xcelerated Composition Platform Extension Points White Paper 7