com.sssw.jbroker.web.portable
Interface Delegate

All Superinterfaces:

Serializable

public interface Delegate

extends Serializable

The Stub delegates certain methods to the Delegate.

Method Summary

QName	getOperationName() get the Operation Name
Map	getProperties() Get a map with properties
Object	getProperty(String name) Get a property from the delegate.
Iterator	getPropertyNames() Get an iterator over all property names
ClientResponse	invoke(ClientRequest request) Invoke a method and get the input stream for unmarshaling results.
ClientResponse	invoke(ClientRequest request, boolean headerExpected) Invoke a method and get the input stream for unmarshaling results.
void	releaseResponse(ClientResponse response) Release a client response.
ClientRequest	request(String method, boolean responseExpected, String encoding, boolean isDocument, String action) Get the output stream for marshaling arguments
ClientRequest	request(String method, boolean responseExpected, String encoding, boolean isDocument, String action, Properties mimeHeaders) Get the output stream for mime request
ClientRequest	request(String method, boolean responseExpected, String encoding, boolean isDocument, String action, Properties mimeHeaders, String soapURI) Get the output stream for marshalling arguments.
ClientRequest	request(String method, boolean responseExpected, String encoding, boolean isDocument, String action, Properties mimeHeaders, String soapURI, boolean headerExpected) Get the output stream for marshalling arguments.
ClientRequest	request(String method, boolean responseExpected, String encoding, boolean isDocument, String action, String soapURI) Get the output stream for marshaling arguments
ClientRequest	request(String method, boolean responseExpected, String encoding, boolean isDocument, String action, String soapURI, boolean headerExpected) Get the output stream for marshaling arguments
void	setCurrentBinding(Binding binding) Set a new binding on the delegate.
void	setHandlerChain(HandlerChain handlerChain) Set the HandlerChain
void	setProperty(String name, Object value) Set a property on the delegate
String	setProperty(String name, String value) Deprecated. As of jBroker Web 2.0, replaced by void setProperty(String, Object)
void	setStub(Stub stub) Set the stub for this delegate object

Method Detail

setStub

public void setStub(Stub stub)
             throws MalformedURLException

Set the stub for this delegate object

Parameters:

stub - the portable stub object

Throws:

MalformedURLException

request

public ClientRequest request(String method,
                             boolean responseExpected,
                             String encoding,
                             boolean isDocument,
                             String action)
                      throws ServiceException

Get the output stream for marshaling arguments

Parameters:

method - the method for which this request is targeted

responseExpected - whether or not a response is expected

encoding - the encoding URL for the request

isDocument - whether or not this is a document oriented request

action - the soap action (if any)

Returns:

a newly created client request output stream positioned for parameter marshaling

Throws:

ServiceException - if the request object could not be created

request

public ClientRequest request(String method,
                             boolean responseExpected,
                             String encoding,
                             boolean isDocument,
                             String action,
                             String soapURI)
                      throws ServiceException

Get the output stream for marshaling arguments

Parameters:

method - the method for which this request is targeted

responseExpected - whether or not a response is expected

encoding - the encoding URL for the request

isDocument - whether or not this is a document oriented request

action - the soap action (if any)

soapURI - URI of the SOAP Envelope

Returns:

a newly created client request output stream positioned for parameter marshaling

Throws:

ServiceException - if the request object could not be created

request

public ClientRequest request(String method,
                             boolean responseExpected,
                             String encoding,
                             boolean isDocument,
                             String action,
                             String soapURI,
                             boolean headerExpected)
                      throws ServiceException

Get the output stream for marshaling arguments

Parameters:

method - the method for which this request is targeted

responseExpected - whether or not a response is expected

encoding - the encoding URL for the request

isDocument - whether or not this is a document oriented request

action - the soap action (if any)

soapURI - URI of the SOAP Envelope

headerExpected - true if request contains header elements

Returns:

a newly created client request output stream positioned for parameter marshaling

Throws:

ServiceException - if the request object could not be created

request

public ClientRequest request(String method,
                             boolean responseExpected,
                             String encoding,
                             boolean isDocument,
                             String action,
                             Properties mimeHeaders)
                      throws ServiceException

Get the output stream for mime request

Parameters:

method - the method for which this request is targeted

responseExpected - whether or not a response is expected

encoding - the encoding URL for the request

isDocument - whether or not this is a document oriented request

action - the soap action (if any)

mimeHeaders - mime header information for the root soap message. If null then the request is NON-MIME.

Returns:

a newly created client request output stream positioned for parameter marshaling

Throws:

ServiceException - if the request object could not be created

request

public ClientRequest request(String method,
                             boolean responseExpected,
                             String encoding,
                             boolean isDocument,
                             String action,
                             Properties mimeHeaders,
                             String soapURI)
                      throws ServiceException

Get the output stream for marshalling arguments. Can be used to create a SOAP 1.2 request.

Parameters:

method - the method for which this request is targeted

responseExpected - whether or not a response is expected

encoding - the encoding URL for the request

isDocument - whether or not this is a document oriented request

action - the soap action (if any)

mimeHeaders - mime header information for the root soap message. If null then the request is NON-MIME.

soapURI - URI of the SOAP Envelope.

Returns:

a newly created client request output stream positioned for parameter marshaling

Throws:

ServiceException - if the request object could not be created

request

public ClientRequest request(String method,
                             boolean responseExpected,
                             String encoding,
                             boolean isDocument,
                             String action,
                             Properties mimeHeaders,
                             String soapURI,
                             boolean headerExpected)
                      throws ServiceException

Get the output stream for marshalling arguments. Can be used to create a SOAP 1.2 request.

Parameters:

method - the method for which this request is targeted

responseExpected - whether or not a response is expected

encoding - the encoding URL for the request

isDocument - whether or not this is a document oriented request

action - the soap action (if any)

mimeHeaders - mime header information for the root soap message. If null then the request is NON-MIME.

soapURI - URI of the SOAP Envelope.

headerExpected - true if request contains header elements

Returns:

a newly created client request output stream positioned for parameter marshaling

Throws:

ServiceException - if the request object could not be created

invoke

public ClientResponse invoke(ClientRequest request)
                      throws ApplicationException

Invoke a method and get the input stream for unmarshaling results. The output stream is created using the

_request

method.

Parameters:

request - the client request input stream

Returns:

a client response positioned for reading output parameters

Throws:

ApplicationException - if an application occurred

See Also:

request(java.lang.String, boolean, java.lang.String, boolean, java.lang.String)

invoke

public ClientResponse invoke(ClientRequest request,
                             boolean headerExpected)
                      throws ApplicationException

Invoke a method and get the input stream for unmarshaling results. The output stream is created using the

_request

method.

Parameters:

request - the client request input stream

headerExpected - true if the response contains header elements

Returns:

a client response positioned for reading output parameters

Throws:

ApplicationException - if an application occurred

Since:

jBroker Web 2.1

See Also:

request(java.lang.String, boolean, java.lang.String, boolean, java.lang.String)

releaseResponse

public void releaseResponse(ClientResponse response)

Release a client response.

Parameters:

response - the client response input stream

setCurrentBinding

public void setCurrentBinding(Binding binding)
                       throws MalformedURLException

Set a new binding on the delegate.

Parameters:

binding - the new binding object

Throws:

MalformedURLException - if the binding if malformed

setProperty

public String setProperty(String name,
                          String value)

Deprecated. As of jBroker Web 2.0, replaced by void setProperty(String, Object)

Set a property on the delegate

Parameters:

name - the property name

value - the property value

Returns:

the old property value if any

setProperty

public void setProperty(String name,
                        Object value)

Set a property on the delegate

Parameters:

name - the property name

value - the property value

Returns:

the old property value if any

Since:

jBroker Web 2.0

getProperty

public Object getProperty(String name)

Get a property from the delegate.

Parameters:

name - the property name

Returns:

the property value

getPropertyNames

public Iterator getPropertyNames()

Get an iterator over all property names

Returns:

a property name iterartor

getProperties

public Map getProperties()

Get a map with properties

Returns:

a Map with the delegate's properties

Since:

jBroker Web 2.0

setHandlerChain

public void setHandlerChain(HandlerChain handlerChain)

Set the HandlerChain

Since:

jBroker Web 2.0

getOperationName

public QName getOperationName()

get the Operation Name

Since:

jBroker Web 1.1