01: /*
02: * Copyright 2001-2007 Geert Bevin <gbevin[remove] at uwyn dot com>
03: * Distributed under the terms of either:
04: * - the common development and distribution license (CDDL), v1.0; or
05: * - the GNU Lesser General Public License, v2.1 or later
06: * $Id: ElementService.java 3634 2007-01-08 21:42:24Z gbevin $
07: */
08: package com.uwyn.rife.engine;
09:
10: /**
11: * This interface allows web service objects to gain access to the element
12: * context during their invocation.
13: * <p>All web service back-ends that are integrated in RIFE will detect the
14: * implementation of this interface for their service objects. They will call
15: * the {@link #setRequestElement} method and provide the {@link ElementSupport}
16: * instance that they are using before invoking the service. This is handy
17: * when you have to retrieve authentication information from within the web
18: * service, for instance.
19: *
20: * @author Geert Bevin (gbevin[remove] at uwyn dot com)
21: * @version $Revision: 3634 $
22: * @since 1.0
23: */
24: public interface ElementService {
25: /**
26: * This method will be called by the web service back-end integration
27: * element before invoking the actual web service.
28: *
29: * @param elementSupport the current <code>ElementSupport</code> instance
30: * @since 1.0
31: */
32: public void setRequestElement(ElementSupport elementSupport);
33: }
|