001: /*******************************************************************************
002: * Licensed to the Apache Software Foundation (ASF) under one
003: * or more contributor license agreements. See the NOTICE file
004: * distributed with this work for additional information
005: * regarding copyright ownership. The ASF licenses this file
006: * to you under the Apache License, Version 2.0 (the
007: * "License"); you may not use this file except in compliance
008: * with the License. You may obtain a copy of the License at
009: *
010: * http://www.apache.org/licenses/LICENSE-2.0
011: *
012: * Unless required by applicable law or agreed to in writing,
013: * software distributed under the License is distributed on an
014: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015: * KIND, either express or implied. See the License for the
016: * specific language governing permissions and limitations
017: * under the License.
018: *******************************************************************************/package org.ofbiz.service;
019:
020: import java.util.Map;
021:
022: import org.ofbiz.base.util.Debug;
023:
024: /**
025: * Generic Result Waiter Class
026: */
027: public class GenericResultWaiter implements GenericRequester {
028:
029: public static final String module = GenericResultWaiter.class
030: .getName();
031:
032: /** Status code for a running service */
033: public static final int SERVICE_RUNNING = -1;
034: /** Status code for a failed service */
035: public static final int SERVICE_FAILED = 0;
036: /** Status code for a successful service */
037: public static final int SERVICE_FINISHED = 1;
038:
039: private boolean completed = false;
040: private int status = -1;
041: private Map result = null;
042: private Throwable t = null;
043:
044: /**
045: * @see org.ofbiz.service.GenericRequester#receiveResult(java.util.Map)
046: */
047: public synchronized void receiveResult(Map result) {
048: this .result = result;
049: completed = true;
050: status = SERVICE_FINISHED;
051: notify();
052: if (Debug.verboseOn())
053: Debug.logVerbose("Received Result (" + completed + ") -- "
054: + result, module);
055: }
056:
057: /**
058: * @see org.ofbiz.service.GenericRequester#receiveThrowable(java.lang.Throwable)
059: */
060: public synchronized void receiveThrowable(Throwable t) {
061: this .t = t;
062: completed = true;
063: status = SERVICE_FAILED;
064: notify();
065: }
066:
067: /**
068: * Returns the status of the service.
069: * @return int Status code
070: */
071: public synchronized int status() {
072: return this .status;
073: }
074:
075: /**
076: * If the service has completed return true
077: * @return boolean
078: */
079: public synchronized boolean isCompleted() {
080: return completed;
081: }
082:
083: /**
084: * Returns the exception which was thrown or null if none
085: * @return Exception
086: */
087: public synchronized Throwable getThrowable() {
088: if (!isCompleted())
089: throw new java.lang.IllegalStateException(
090: "Cannot return exception, synchronous call has not completed.");
091: return this .t;
092: }
093:
094: /**
095: * Gets the results of the service or null if none
096: * @return Map
097: */
098: public synchronized Map getResult() {
099: if (!isCompleted())
100: throw new java.lang.IllegalStateException(
101: "Cannot return result, asynchronous call has not completed.");
102: return result;
103: }
104:
105: /**
106: * Waits for the service to complete
107: * @return Map
108: */
109: public synchronized Map waitForResult() {
110: return this .waitForResult(10);
111: }
112:
113: /**
114: * Waits for the service to complete, check the status ever n milliseconds
115: * @param milliseconds
116: * @return Map
117: */
118: public synchronized Map waitForResult(long milliseconds) {
119: if (Debug.verboseOn())
120: Debug.logVerbose("Waiting for results...", module);
121: while (!isCompleted()) {
122: try {
123: this .wait(milliseconds);
124: if (Debug.verboseOn())
125: Debug.logVerbose("Waiting...", module);
126: } catch (java.lang.InterruptedException e) {
127: Debug.logError(e, module);
128: }
129: }
130: return this.getResult();
131: }
132: }
|