1 /*
2 * Copyright (c) 2005-2011, Fraunhofer-Gesellschaft
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * (1) Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the disclaimer at the end.
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
14 * distribution.
15 *
16 * (2) Neither the name of Fraunhofer nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * DISCLAIMER
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 */
35 package org.ogf.graap.wsag.server.actions;
36
37 import org.ogf.graap.wsag.api.AgreementFactoryContext;
38 import org.ogf.graap.wsag.server.api.WsagSession;
39 import org.ogf.graap.wsag4j.types.configuration.ImplementationConfigurationType;
40
41 /**
42 * <!-- begin-UML-doc -->
43 * <p>
44 * An action handler context contains information about the environment in which a specific action handler is
45 * excecuted.
46 * </p>
47 * <!-- end-UML-doc -->
48 *
49 * @author Oliver Waeldrich
50 * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
51 */
52 public interface IActionHandlerContext
53 {
54 /**
55 * <!-- begin-UML-doc --> This is the shared context of the agreement factory. All action handler executed
56 * in a specific factory have access to this context. The agreement factory may store shared objects at
57 * initialization time in this context. <!-- end-UML-doc -->
58 *
59 * @return the agreement factory context
60 *
61 * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
62 */
63 AgreementFactoryContext getFactoryContext();
64
65 /**
66 * <!-- begin-UML-doc --> This is the configuration of the handler instance. The handler configuration is
67 * part of the engine configuration and may contain additional information that is required by the handler
68 * to function properly, e.g. in that way additional configuration information can be provided to
69 * initialize the handler properly. <!-- end-UML-doc -->
70 *
71 * @return the action handler configuration
72 *
73 * @generated "UML to Java (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransform)"
74 */
75 ImplementationConfigurationType getHandlerConfiguration();
76
77 /**
78 * Returns the current WSAG4J session object when used, otherwise null.
79 *
80 * @return the session object
81 *
82 * @deprecated
83 */
84 @Deprecated
85 WsagSession getSession();
86
87 /**
88 * Sets the WSAG4J session object when available, otherwise null.
89 *
90 * @param session
91 * the session object
92 *
93 * @deprecated
94 */
95 @Deprecated
96 void setSession( WsagSession session );
97 }