|
||||||||||
PREV CLASS (src) NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jboss.axis.client.Service
Axis' JAXRPC Dynamic Invoation Interface implementation of the Service interface.
The Service class should be used a the starting point for access SOAP Web Services. Typically, a Service will be created with a WSDL document and along with a serviceName you can then ask for a Call object that will allow you to invoke a Web Service.
Nested Class Summary | |
protected static class |
Service.HandlerRegistryImpl (src)
|
Field Summary | |
protected static java.util.HashMap |
cachedWSDL
|
protected static boolean |
cachingWSDL
|
protected EngineConfiguration (src) |
config
|
protected AxisEngine (src) |
engine
|
protected QName (src) |
serviceName
|
protected java.lang.String |
wsdlLocation
|
protected javax.wsdl.Service |
wsdlService
|
Constructor Summary | |
Service()
Constructs a new Service object - this assumes the caller will set the appropriate fields by hand rather than getting them from the WSDL. |
|
Service(EngineConfiguration (src) config)
Constructs a new Service object as above, but also passing in the EngineConfiguration which should be used to set up the AxisClient. |
|
Service(java.io.InputStream wsdlInputStream,
QName (src) serviceName)
Constructs a new Service object for the service in the WSDL document in the wsdlInputStream and serviceName parameters. |
|
Service(Parser (src) parser,
QName (src) serviceName)
Constructs a new Service object for the service in the WSDL document |
|
Service(QName (src) serviceName)
Constructs a new Service object - this assumes the caller will set the appropriate fields by hand rather than getting them from the WSDL. |
|
Service(java.lang.String wsdlLocation,
QName (src) serviceName)
Constructs a new Service object for the service in the WSDL document pointed to by the wsdlLocation and serviceName parameters. |
|
Service(java.net.URL wsdlDoc,
QName (src) serviceName)
Constructs a new Service object for the service in the WSDL document pointed to by the wsdlDoc URL and serviceName parameters. |
Method Summary | |
Call (src) |
createCall()
Creates a new Call object with no prefilled data. |
Call (src) |
createCall(QName (src) portName)
Creates a new Call object - will prefill as much info from the WSDL as it can. |
Call (src) |
createCall(QName (src) portName,
QName (src) operationName)
Creates a new Call object - will prefill as much info from the WSDL as it can. |
Call (src) |
createCall(QName (src) portName,
java.lang.String operationName)
Creates a new Call object - will prefill as much info from the WSDL as it can. |
protected AxisClient (src) |
getAxisClient()
|
boolean |
getCacheWSDL()
Tells whether or not we're caching WSDL |
Call (src) [] |
getCalls(QName (src) portName)
Gets an array of preconfigured Call objects for invoking operations on the specified port. |
AxisEngine (src) |
getEngine()
Returns the current AxisEngine used by this Service and all of the Call objects created from this Service object. |
protected EngineConfiguration (src) |
getEngineConfiguration()
Constructs a EngineConfig if one is not available. |
protected java.rmi.Remote |
getGeneratedStub(QName (src) portName,
java.lang.Class proxyInterface)
With the proxyInterface and the service's portName, we have ALMOST enough info to find a generated stub. |
HandlerRegistry (src) |
getHandlerRegistry()
Returns the configured HandlerRegistry instance for this Service instance. |
boolean |
getMaintainSession()
If true, this service wants to track sessions. |
protected Parser (src) |
getParser()
Stub out, to give clients the cahnce to modify parser properties TDI 15-Jun-2004 |
java.rmi.Remote |
getPort(java.lang.Class proxyInterface)
Return a dynamic proxy for the given proxy interface. |
java.rmi.Remote |
getPort(QName (src) portName,
java.lang.Class proxyInterface)
Return either an instance of a generated stub, if it can be found, or a dynamic proxy for the given proxy interface. |
java.rmi.Remote |
getPort(java.lang.String endpoint,
java.lang.Class proxyInterface)
Return an object which acts as a dynamic proxy for the passed interface class. |
protected java.rmi.Remote |
getPort(java.lang.String endpoint,
QName (src) portName,
java.lang.Class proxyInterface)
|
java.util.Iterator |
getPorts()
Returns an Iterator for the list of
QName s of service endpoints grouped by this
service |
javax.naming.Reference |
getReference()
Returns a reference to this object. |
QName (src) |
getServiceName()
Returns the qualified name of the service (if one is set). |
protected java.lang.String |
getTargetEnpointAddress()
The service may provide the target endpoint address, in case the client wsdl port does not contain a valid address. |
TypeMappingRegistry (src) |
getTypeMappingRegistry()
Returns the current TypeMappingRegistry or null. |
java.net.URL |
getWSDLDocumentLocation()
Returns the location of the WSDL document used to prefill the data (if one was used at all). |
Parser (src) |
getWSDLParser()
|
protected Port |
getWSDLPort(java.lang.Class seiClass)
Get the WSDL Port for a given service endpoint interface This implementation gets the wsdl port that corresponds to the class name, if not found it just get the first one we have. |
protected javax.wsdl.Service |
getWSDLService()
|
void |
setCacheWSDL(boolean flag)
Allows users to turn caching of WSDL documents on or off. |
void |
setEngine(AxisEngine (src) engine)
Sets this Service's AxisEngine. |
void |
setEngineConfiguration(EngineConfiguration (src) config)
Set this Service's engine configuration. |
void |
setMaintainSession(boolean yesno)
Determine whether we'd like to track sessions or not. |
void |
setTypeMappingRegistry(TypeMappingRegistry (src) registry)
Defines the current Type Mappig Registry. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected transient AxisEngine (src) engine
protected transient EngineConfiguration (src) config
protected QName (src) serviceName
protected java.lang.String wsdlLocation
protected javax.wsdl.Service wsdlService
protected static java.util.HashMap cachedWSDL
protected static boolean cachingWSDL
Constructor Detail |
public Service()
public Service(QName (src) serviceName)
public Service(EngineConfiguration (src) config)
public Service(java.net.URL wsdlDoc, QName (src) serviceName) throws ServiceException (src)
wsdlDoc
- URL of the WSDL documentserviceName
- Qualified name of the desired service
ServiceException (src)
- If there's an error finding or parsing the WSDLpublic Service(Parser (src) parser, QName (src) serviceName) throws ServiceException (src)
parser
- Parser for this serviceserviceName
- Qualified name of the desired service
ServiceException (src)
- If there's an errorpublic Service(java.lang.String wsdlLocation, QName (src) serviceName) throws ServiceException (src)
wsdlLocation
- Location of the WSDL relative to the current dirserviceName
- Qualified name of the desired service
ServiceException (src)
- If there's an error finding or parsing the WSDLpublic Service(java.io.InputStream wsdlInputStream, QName (src) serviceName) throws ServiceException (src)
wsdlInputStream
- InputStream containing the WSDLserviceName
- Qualified name of the desired service
ServiceException (src)
- If there's an error finding or parsing the WSDLMethod Detail |
protected Parser (src) getParser()
protected javax.wsdl.Service getWSDLService()
public Parser (src) getWSDLParser()
protected AxisClient (src) getAxisClient()
public java.rmi.Remote getPort(QName (src) portName, java.lang.Class proxyInterface) throws ServiceException (src)
getPort
in interface Service (src)
portName
- The name of the service portproxyInterface
- The Remote object returned by this
method will also implement the given proxyInterface
ServiceException (src)
- If there's an errorprotected java.rmi.Remote getGeneratedStub(QName (src) portName, java.lang.Class proxyInterface) throws ServiceException (src)
ServiceException (src)
public java.rmi.Remote getPort(java.lang.Class proxyInterface) throws ServiceException (src)
getPort
in interface Service (src)
proxyInterface
- The Remote object returned by this
method will also implement the given proxyInterface
ServiceException (src)
- If there's an errorprotected Port getWSDLPort(java.lang.Class seiClass) throws ServiceException (src)
seiClass
- The service endpoint interface class
ServiceException (src)
- If there's an errorpublic java.rmi.Remote getPort(java.lang.String endpoint, java.lang.Class proxyInterface) throws ServiceException (src)
endpoint
- the URL which will be used as the SOAP endpointproxyInterface
- the interface class which we wish to mimic
via a dynamic proxy
ServiceException (src)
protected java.rmi.Remote getPort(java.lang.String endpoint, QName (src) portName, java.lang.Class proxyInterface) throws ServiceException (src)
ServiceException (src)
public Call (src) createCall(QName (src) portName) throws ServiceException (src)
createCall
in interface Service (src)
portName
- PortName in the WSDL doc to search for
ServiceException (src)
- If there's an errorprotected java.lang.String getTargetEnpointAddress()
public Call (src) createCall(QName (src) portName, java.lang.String operationName) throws ServiceException (src)
createCall
in interface Service (src)
portName
- PortName in the WSDL doc to search foroperationName
- Operation(method) that's going to be invoked
ServiceException (src)
- If there's an errorpublic Call (src) createCall(QName (src) portName, QName (src) operationName) throws ServiceException (src)
createCall
in interface Service (src)
portName
- PortName in the WSDL doc to search foroperationName
- Operation(method) that's going to be invoked
ServiceException (src)
- If there's an errorpublic Call (src) createCall() throws ServiceException (src)
createCall
in interface Service (src)
ServiceException (src)
- If there's an errorpublic Call (src) [] getCalls(QName (src) portName) throws ServiceException (src)
getCalls
in interface Service (src)
portName
- Qualified name for the target service endpoint
ServiceException (src)
- - If this Service class does not have access
to the required WSDL metadata or if an illegal portName is specified.public HandlerRegistry (src) getHandlerRegistry()
getHandlerRegistry
in interface Service (src)
java.lang.UnsupportedOperationException
- - if the Service
class does not support the configuration of a
HandlerRegistry.public java.net.URL getWSDLDocumentLocation()
getWSDLDocumentLocation
in interface Service (src)
public QName (src) getServiceName()
getServiceName
in interface Service (src)
public java.util.Iterator getPorts() throws ServiceException (src)
Iterator
for the list of
QName
s of service endpoints grouped by this
service
getPorts
in interface Service (src)
java.util.Iterator
with elements
of type javax.xml.namespace.QName
ServiceException (src)
- If this Service class does not
have access to the required WSDL metadatapublic void setTypeMappingRegistry(TypeMappingRegistry (src) registry) throws ServiceException (src)
registry
- The TypeMappingRegistry
ServiceException (src)
- if there's an errorpublic TypeMappingRegistry (src) getTypeMappingRegistry()
getTypeMappingRegistry
in interface Service (src)
public javax.naming.Reference getReference()
getReference
in interface javax.naming.Referenceable
public void setEngine(AxisEngine (src) engine)
engine
- Sets this Service's AxisEngine to the passed in onepublic AxisEngine (src) getEngine()
public void setEngineConfiguration(EngineConfiguration (src) config)
EngineConfiguration
, do
the following before calling the Service constructor:
AxisProperties.setProperty(EngineConfigurationFactory.SYSTEM_PROPERTY_NAME,
"classname.of.new.EngineConfigurationFactory");
Where the second parameter is the name of your new class that implements
EngineConfigurationFactory
and a
method. See
public static EngineConfigurationFactory newFactory(Object param)
EngineConfigurationFactoryDefault
for an example
of how to do this.
This way, when the Service class constructor calls
EngineConfigurationFactoryFinder.newFactory().getClientEngineConfig()
the getClientEngineConfig() of your own EngineConfigurationFactory will be
called, and your configuration will be used in the constructed Service object.Another way is to use the "discovery" method of
EngineConfigurationFactoryFinder
.
config
- the EngineConfiguration we want to use.protected EngineConfiguration (src) getEngineConfiguration()
public void setMaintainSession(boolean yesno)
yesno
- true if session state is desired, false if not.public boolean getMaintainSession()
public boolean getCacheWSDL()
public void setCacheWSDL(boolean flag)
|
||||||||||
PREV CLASS (src) NEXT CLASS (src) | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |