001: /*--
002:
003: Copyright (C) 2002-2005 Adrian Price.
004: All rights reserved.
005:
006: Redistribution and use in source and binary forms, with or without
007: modification, are permitted provided that the following conditions
008: are met:
009:
010: 1. Redistributions of source code must retain the above copyright
011: notice, this list of conditions, and the following disclaimer.
012:
013: 2. Redistributions in binary form must reproduce the above copyright
014: notice, this list of conditions, and the disclaimer that follows
015: these conditions in the documentation and/or other materials
016: provided with the distribution.
017:
018: 3. The names "OBE" and "Open Business Engine" must not be used to
019: endorse or promote products derived from this software without prior
020: written permission. For written permission, please contact
021: adrianprice@sourceforge.net.
022:
023: 4. Products derived from this software may not be called "OBE" or
024: "Open Business Engine", nor may "OBE" or "Open Business Engine"
025: appear in their name, without prior written permission from
026: Adrian Price (adrianprice@users.sourceforge.net).
027:
028: THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
029: WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
030: OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
031: DISCLAIMED. IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
032: INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
033: (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
034: SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
035: HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
036: STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
037: IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
038: POSSIBILITY OF SUCH DAMAGE.
039:
040: For more information on OBE, please see
041: <http://obe.sourceforge.net/>.
042:
043: */
044:
045: package org.obe.client.api.rmi;
046:
047: import org.apache.commons.logging.Log;
048: import org.apache.commons.logging.LogFactory;
049: import org.obe.client.api.WMClientFactory;
050: import org.obe.client.api.base.WorkflowEngineIntf;
051: import org.wfmc.wapi.WMConnectException;
052: import org.wfmc.wapi.WMConnectInfo;
053: import org.wfmc.wapi.WMWorkflowException;
054:
055: import javax.ejb.CreateException;
056: import javax.ejb.EJBObject;
057: import javax.naming.Context;
058: import javax.naming.NamingException;
059: import javax.rmi.PortableRemoteObject;
060: import java.security.PrivilegedExceptionAction;
061:
062: /**
063: * Class used to connect to and communicate with a workflow engine via RMI-RPC.
064: * To use this client, please ensure that JNDI is configured with the correct
065: * InitialContextFactory (set in jndi.properties, or as a system property).
066: * <p/>
067: * This interface is based on the WfMC's Interface 2 Client API specification.
068: * Some of the methods have been modified from the original specification to fit
069: * within the normal design of Java applications. For instance, the WfMC
070: * specification functions always return an error object (even for success) and
071: * uses out parameters to return values. This interface returns the value and
072: * throws an exception when an error occurs. If no error occurs then an
073: * exception is not thrown.
074: *
075: * @author Adrian Price
076: */
077: public final class J2EERemoteClient extends AbstractJ2EEClient {
078: private static final Log _logger = LogFactory
079: .getLog(J2EERemoteClient.class);
080:
081: public J2EERemoteClient() {
082: }
083:
084: protected Log getLogger() {
085: return _logger;
086: }
087:
088: public String getProtocol() {
089: return WMClientFactory.RMI;
090: }
091:
092: public synchronized void connect(WMConnectInfo connectInfo)
093: throws WMConnectException {
094: try {
095: final Context ctx = _connect(connectInfo);
096: PrivilegedExceptionAction action = new PrivilegedExceptionAction() {
097: public Object run() throws Exception {
098: try {
099: // Look up J2EEServer's remote home.
100: Object obj = ctx
101: .lookup(J2EEServerRemoteHome.JNDI_NAME);
102: J2EEServerRemoteHome home = (J2EEServerRemoteHome) PortableRemoteObject
103: .narrow(obj, J2EEServerRemoteHome.class);
104: return home.create();
105: } catch (CreateException e) {
106: throw new WMConnectException(e);
107: } finally {
108: try {
109: ctx.close();
110: } catch (NamingException e) {
111: _logger.error("Error closing JNDI context");
112: }
113: }
114: }
115: };
116: _engine = (WorkflowEngineIntf) doAsSubject(action);
117: } catch (WMConnectException e) {
118: throw e;
119: } catch (WMWorkflowException e) {
120: throw new WMConnectException(e);
121: }
122: }
123:
124: public synchronized void disconnect() throws WMConnectException {
125: try {
126: PrivilegedExceptionAction action = new PrivilegedExceptionAction() {
127: public Object run() throws Exception {
128: try {
129: ((EJBObject) _engine).remove();
130: } catch (Exception e) {
131: getLogger().error("Remove exception", e);
132: } finally {
133: J2EERemoteClient.super .disconnect();
134: }
135: return null;
136: }
137: };
138: doAsSubject(action);
139: } catch (WMConnectException e) {
140: throw e;
141: } catch (WMWorkflowException e) {
142: throw new WMConnectException(e);
143: } finally {
144: _engine = null;
145: }
146: }
147: }
|