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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package javax.xml.rpc;
import java.net.URL;
import java.rmi.Remote;
import java.util.Iterator;
import javax.xml.namespace.QName;
import javax.xml.rpc.encoding.TypeMappingRegistry;
import javax.xml.rpc.handler.HandlerRegistry;
/** Service class acts as a factory for:
* <ul>
* <li>Dynamic proxy for the target service endpoint.
* <li>Instance of the type javax.xml.rpc.Call for the dynamic invocation of a remote operation on the target service endpoint.
* <li>Instance of a generated stub class
* </ul>
*
* @author Scott.Stark@jboss.org
* @author Thomas.Diesler@jboss.org
* @version $Revision: 2897 $
*/
public interface Service
{
/**
* The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy.
* A service client uses this dynamic proxy to invoke operations on the target service endpoint.
* The serviceEndpointInterface specifies the service endpoint interface that is supported by the created dynamic proxy or stub instance.
*
* @param portName Qualified name of the service endpoint in the WSDL service descr
* @param seiClass Service endpoint interface supported by the dynamic proxy or stub instance
* @return Stub instance or dynamic proxy that supports the specified service endpoint interface
* @throws ServiceException This exception is thrown in the following cases:
* <ul>
* <li>If there is an error in creation of the dynamic proxy or stub instance
* <li>If there is any missing WSDL metadata as required by this method
* <li>Optionally, if an illegal serviceEndpointInterface or portName is specified
* </ul>
*/
public Remote getPort(QName portName, Class seiClass) throws ServiceException;
/**
* The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy.
* The parameter serviceEndpointInterface specifies the service endpoint interface that is supported by the returned stub or proxy.
* In the implementation of this method, the JAX-RPC runtime system takes the responsibility of selecting a protocol binding (and a port)
* and configuring the stub accordingly. The returned Stub instance should not be reconfigured by the client.
*/
public Remote getPort(Class seiClass) throws ServiceException;
/** Gets an array of preconfigured Call objects for invoking operations on the specified port.
* There is one Call object per operation that can be invoked on the specified port.
* Each Call object is pre-configured and does not need to be configured using the setter methods on Call interface.
*
* Each invocation of the getCalls method returns a new array of preconfigured Call objects
*
* This method requires the Service implementation class to have access to the WSDL related metadata.
*
* @param portName Qualified name for the target service endpoint
* @return Call[] Array of pre-configured Call objects
* @throws ServiceException If this Service class does not have access to the required WSDL metadata or if an illegal portName is specified.
*/
public Call[] getCalls(QName portName) throws ServiceException;
/** Creates a Call instance.
*
* @param portName Qualified name for the target service endpoint
* @return Call instance
* @throws ServiceException If any error in the creation of the Call object
*/
public Call createCall(QName portName) throws ServiceException;
/** Creates a Call instance.
*
* @param portName Qualified name for the target service endpoint
* @param operationName Qualified name of the operation for which this Call object is to be created.
* @return Call instance
* @throws ServiceException If any error in the creation of the Call object
*/
public Call createCall(QName portName, QName operationName) throws ServiceException;
/** Creates a Call instance.
*
* @param portName Qualified name for the target service endpoint
* @param operationName Name of the operation for which this Call object is to be created.
* @return Call instance
* @throws ServiceException If any error in the creation of the Call object
*/
public Call createCall(QName portName, String operationName) throws ServiceException;
/**
* Creates a Call object not associated with specific operation or target service endpoint.
* This Call object needs to be configured using the setter methods on the Call interface.
*
* @return Call object
* @throws ServiceException If any error in the creation of the Call object
*/
public Call createCall() throws ServiceException;
/** Gets the name of this service.
* @return Qualified name of this service
*/
public QName getServiceName();
/** Returns an Iterator for the list of QNames of service endpoints grouped by this service
*
* @return Returns java.util.Iterator with elements of type javax.xml.namespace.QName
* @throws ServiceException If this Service class does not have access to the required WSDL metadata
*/
public Iterator getPorts() throws ServiceException;
/** Gets the location of the WSDL document for this Service.
*
* @return URL for the location of the WSDL document for this service
*/
public URL getWSDLDocumentLocation();
/** Gets the TypeMappingRegistry for this Service object. The returned TypeMappingRegistry instance is pre-configured
* to support the standard type mapping between XML and Java types types as required by the JAX-RPC specification.
*
* @return The TypeMappingRegistry for this Service object.
* @throws java.lang.UnsupportedOperationException if the Service class does not support the configuration of TypeMappingRegistry.
*/
public TypeMappingRegistry getTypeMappingRegistry();
/** Returns the configured HandlerRegistry instance for this Service instance.
*
* @return HandlerRegistry
* @throws java.lang.UnsupportedOperationException if the Service class does not support the configuration of a HandlerRegistry
*/
public HandlerRegistry getHandlerRegistry();
}
|
