summaryrefslogtreecommitdiffstats
path: root/branches/sca-java-1.1/modules/binding-jms/src/main/java/org/apache/tuscany/sca/binding/jms/JMSBinding.java
blob: 291ce4b0816aacb1a0d6a0cc8c28519dc63ea4b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.    
 */

package org.apache.tuscany.sca.binding.jms;

import org.apache.tuscany.sca.assembly.Binding;
import org.apache.tuscany.sca.assembly.Extensible;

/**
 * This is the generic JMS binding type. The type is extensible so that JMS binding implementers can add additional JMS
 * provider-specific attributes and elements although such extensions are not guaranteed to be portable across runtimes.
 * 
 * @version $Rev$ $Date$
 */
public interface JMSBinding extends Binding, Extensible {
    /**
     * Identifies the correlation scheme used when sending reply or callback messages. Valid values are
     * "RequestMsgIDToCorrelID" (the default), "RequestCorrelIDToCorrelID", and "None".
     * 
     * @return
     */
    CorrelationScheme getCorrelationScheme();

    void setCorrelationScheme(CorrelationScheme correlationScheme);

    /**
     * the name of the JNDI initial context factory
     * 
     * @return
     */
    String getInitialContextFactory();

    void setInitialContextFactory(String initialContextFactory);

    /**
     * The URL for the JNDI provider
     * 
     * @return
     */
    String getJndiURL();

    void setJndiURL(String jndiURL);

    /**
     * identifies a binding.jms element that is present in a definition document, whose destination, connectionFactory,
     * activationSpec and resourceAdapter children are used to define the values for this binding. In this case the
     * corresponding elements must not be present within this binding element
     * 
     * @return
     */
    ConnectionInfo getRequestConnection();

    void setRequestConnection(ConnectionInfo requestConnection);

    /**
     * identifies a binding.jms element that is present in a definition document, whose response child element is used
     * to define the values for this binding. In this case no response element must be present within this binding
     * element
     * 
     * @return
     */
    ConnectionInfo getResponseConnection();

    void setResponseConnection(ConnectionInfo responseConnection);

    /**
     * identifies a binding.jms element that is present in a definition document, whose operationProperties children are
     * used to define the values for this binding. In this case no operationProperties elements must be present within
     * this binding element
     * 
     * @return
     */
    OperationProperties getOperationProperties();

    void setOperationProperties(OperationProperties operationProperties);

}