org.apache.ws.resource
Interface ResourceContext

All Known Implementing Classes:

org.apache.ws.resource.impl.ResourceContextImpl

public interface ResourceContext

Context information pertaining to a specific request being processed by the WSRF resource invocation framework. Provides methods for obtaining the ResourceHome and Resource objects associated with the request. Also provides access to some service related information such as the service endpoint URL.

Method Summary

boolean	containsProperty(java.lang.String name)
java.lang.Object	getProperty(java.lang.String name)
java.util.Iterator	getPropertyNames()
java.lang.String	getRequestAction() Returns the value of the request's wsa:Action header element.
Resource	getResource() Returns the resource instance that was targeted by the request associated with this context.
ResourceHome	getResourceHome() Gets ResourceHome associated with the service.
java.lang.String	getServiceName() Gets name of the service.
java.net.URL	getServiceURL() Gets the endpoint URL of the service.
javax.xml.soap.SOAPMessage	getSOAPMessage() DOCUMENT_ME
void	removeProperty(java.lang.String name)
void	setProperty(java.lang.String name, java.lang.Object value)
void	setResponseAction(java.net.URI action) Sets the value that should be used for the response's wsa:Action header element.

Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String name)

See Also:

MessageContext.getProperty(String)

getPropertyNames

public java.util.Iterator getPropertyNames()

See Also:

MessageContext.getPropertyNames()

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

See Also:

MessageContext.setProperty(String, Object)

getRequestAction

public java.lang.String getRequestAction()

Returns the value of the request's wsa:Action header element.

Returns:

the value of the request's wsa:Action header element

getResource

public Resource getResource()
                     throws ResourceException

Returns the resource instance that was targeted by the request associated with this context.

Returns:

the resource instance that was targeted by the request associated with this context

Throws:

ResourceException - upon failure to lookup a resource instance from the home

getResourceHome

public ResourceHome getResourceHome()

Gets ResourceHome associated with the service.

Returns:

ResourceHome associated with the service. Cannot be null.

setResponseAction

public void setResponseAction(java.net.URI action)

Sets the value that should be used for the response's wsa:Action header element.

Parameters:

action - the value that should be used for the response's wsa:Action header element; if null, a default value will be generated by the resource invocation framework

getSOAPMessage

public javax.xml.soap.SOAPMessage getSOAPMessage()

DOCUMENT_ME

Returns:

DOCUMENT_ME

getServiceName

public java.lang.String getServiceName()

Gets name of the service.

Returns:

The name of the service.

getServiceURL

public java.net.URL getServiceURL()

Gets the endpoint URL of the service.

Returns:

The endpoint URL of the service

containsProperty

public boolean containsProperty(java.lang.String name)

See Also:

MessageContext.containsProperty(String)

removeProperty

public void removeProperty(java.lang.String name)

See Also:

MessageContext.removeProperty(String)