com.sapportals.portal.prt.service.soap
Interface ISOAPService

All Superinterfaces:

IService

public interface ISOAPService

extends IService

Central Definition of the SOAP Framwework using support of Portal Service layer

Field Summary

static java.lang.String

KEY

Method Summary

IPRTSOAPMessage	call(javax.xml.soap.SOAPMessage msg, java.lang.String url, IServiceDescriptor descriptor) Call a distant Web Service using invokation provide by the SOAP Framework
IPRTSOAPMessage	call(javax.xml.soap.SOAPMessage msg, java.lang.String url, IServiceDescriptor descriptor, IUserContext user, java.lang.String systemAlias) Call a distant Web Service using invokation provide by the SOAP Framework with security infos
IConfigurationSOAPService	getConfigurationSOAPService() Return the configuration oif the SOAP service for the central configuration
com.sapportals.portal.prt.connection.servlet.IServletConnection	getConnection() Get the Connection registered to the central dispatcher Portal Runtime
java.lang.String	getDefaultBaseURL_PRToutside() Get the default URL for the Central instance of the SOAP Servcie
ISOAPLogger	getlogger() Get the SOAP looger.
javax.xml.soap.MessageFactory	getMsgFactory() Get the SOAP Message factory attached to the SOAP Service Framework
IPRTSOAPResponse	getNewSOAPResponseInstance(IPRTSOAPMessage message) Allow to create new instance of IPRTSOAPResponse element
IPRTSOAPProxy	getProxyInstance(java.lang.String url, java.lang.String serviceName, java.lang.String namespaceURI) Get a Proxy instance, used to communicate between instance of PRT
ISOAPSecurityManager	getSecurityManager() Get the Security Manager of the SOAP Service
IPRTSOAPSerializator	getSerializator() Get the current Serializator from SOAP Framework
IPRTSOAPCall	getSOAPCallInstance(java.util.HashMap httpheaders, java.lang.String url, java.lang.String serviceName, java.lang.String namespaceURI)
IPRTSOAPCall	getSOAPCallInstance(java.lang.String url, java.lang.String serviceName, java.lang.String namespaceURI) Get SOAP Call instance
javax.wsdl.xml.WSDLReader	getWSDLReader() Gets the WSDL Reader
javax.wsdl.xml.WSDLWriter	getWSDLWriter() Gets the WSDl Writer
ISOAPServiceProcessor	registerSOAPServiceProcessor(java.lang.String key, ISOAPServiceProcessor processor) register the given processor in the list of SOAP Message processor
ISOAPServiceProcessor	unregisterSOAPServiceProcessor(java.lang.String key) unregister the specified processor in the list of SOAP Message processor

Methods inherited from interface com.sapportals.portal.prt.service.IService

afterInit, configure, destroy, getContext, getKey, init, release

Field Detail

KEY

public static final java.lang.String KEY

Method Detail

getConnection

public com.sapportals.portal.prt.connection.servlet.IServletConnection getConnection()

Get the Connection registered to the central dispatcher Portal Runtime

Returns:

the servlet Connection

getMsgFactory

public javax.xml.soap.MessageFactory getMsgFactory()

Get the SOAP Message factory attached to the SOAP Service Framework

Returns:

call

public IPRTSOAPMessage call(javax.xml.soap.SOAPMessage msg,
                            java.lang.String url,
                            IServiceDescriptor descriptor)

Call a distant Web Service using invokation provide by the SOAP Framework

Parameters:

msg - the SOAP Message to transmit

url - the url to send the SOAP message

descriptor - The IServiceDescriptor link to the current call

Returns:

the response receive from the distant Web Service

call

public IPRTSOAPMessage call(javax.xml.soap.SOAPMessage msg,
                            java.lang.String url,
                            IServiceDescriptor descriptor,
                            IUserContext user,
                            java.lang.String systemAlias)

Call a distant Web Service using invokation provide by the SOAP Framework with security infos

Parameters:

msg - msg the SOAP Message to transmit

url - url the url to send the SOAP message

descriptor - descriptor The IServiceDescriptor link to the current call

user - the User attched to the current call

Returns:

the response receive from the distant Web Service

getSerializator

public IPRTSOAPSerializator getSerializator()

Get the current Serializator from SOAP Framework

Returns:

the serializator instance

getDefaultBaseURL_PRToutside

public java.lang.String getDefaultBaseURL_PRToutside()

Get the default URL for the Central instance of the SOAP Servcie

Returns:

the central URL.

getProxyInstance

public IPRTSOAPProxy getProxyInstance(java.lang.String url,
                                      java.lang.String serviceName,
                                      java.lang.String namespaceURI)

Get a Proxy instance, used to communicate between instance of PRT

Parameters:

url - the url to target

serviceName - the name of the service to calls

namespaceURI - the namespaceuri attached to the call

Returns:

the proxy on the service

getSecurityManager

public ISOAPSecurityManager getSecurityManager()

Get the Security Manager of the SOAP Service

Returns:

the security manager

getSOAPCallInstance

public IPRTSOAPCall getSOAPCallInstance(java.lang.String url,
                                        java.lang.String serviceName,
                                        java.lang.String namespaceURI)

Get SOAP Call instance

Parameters:

url - the url for the call

serviceName - the name of the service

namespaceURI - the namespaceuri attached to the call

Returns:

the SOAP Call instance

getSOAPCallInstance

public IPRTSOAPCall getSOAPCallInstance(java.util.HashMap httpheaders,
                                        java.lang.String url,
                                        java.lang.String serviceName,
                                        java.lang.String namespaceURI)

Parameters:

httpheaders - HttpHeaders link to the SOAP Message to send

url - the url for the call

serviceName - the name of the service to call

namespaceURI - the namespaceuri attached to the call

Returns:

the SOAP Call instance

getConfigurationSOAPService

public IConfigurationSOAPService getConfigurationSOAPService()

Return the configuration oif the SOAP service for the central configuration

Returns:

the configuration

getlogger

public ISOAPLogger getlogger()

Get the SOAP looger.

Returns:

the logger

getWSDLReader

public javax.wsdl.xml.WSDLReader getWSDLReader()
                                        throws javax.wsdl.WSDLException

Gets the WSDL Reader

Returns:

the reader

Throws:

javax.wsdl.WSDLException -

getWSDLWriter

public javax.wsdl.xml.WSDLWriter getWSDLWriter()
                                        throws javax.wsdl.WSDLException

Gets the WSDl Writer

Returns:

the writer

Throws:

javax.wsdl.WSDLException -

registerSOAPServiceProcessor

public ISOAPServiceProcessor registerSOAPServiceProcessor(java.lang.String key,
                                                          ISOAPServiceProcessor processor)

register the given processor in the list of SOAP Message processor

Parameters:

key - key of the processor to register

processor - SOAP Service processor to register

Returns:

the previous value of the specified key in the processor list, or null if it did not have one

unregisterSOAPServiceProcessor

public ISOAPServiceProcessor unregisterSOAPServiceProcessor(java.lang.String key)

unregister the specified processor in the list of SOAP Message processor

Parameters:

key - key of the processor to unregister

Returns:

the value to which the key had been mapped in the process list, or null if the key did not have a processor.

getNewSOAPResponseInstance

public IPRTSOAPResponse getNewSOAPResponseInstance(IPRTSOAPMessage message)

Allow to create new instance of IPRTSOAPResponse element

Parameters:

message - the based PRT SOAP message

Returns:

IPRTSOAPResponse