|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ws.resource.ResourceContext
LOG-DONE
ResourceContext
wraps around a SOAPMessageContext
and provides convenience
functions for obtaining ResourceKey
, ResourceHome
, and resource objects
associated with the given SOAP message (referenced in SOAPMessageContext
).
Constructor Summary | |
protected |
ResourceContext()
Creates a new ResourceContext object. |
Method Summary | |
abstract boolean |
containsProperty(java.lang.String name)
|
abstract java.lang.Object |
getProperty(java.lang.String name)
|
abstract java.util.Iterator |
getPropertyNames()
|
abstract Resource |
getResource()
Gets actual resource. |
static ResourceContext |
getResourceContext(javax.xml.rpc.handler.soap.SOAPMessageContext soapMsgContext)
Returns ResourceContext initialized with a specific SOAPMessageContext . |
abstract ResourceHome |
getResourceHome()
Gets ResourceHome associated with the service. |
abstract ResourceKey |
getResourceKey()
Gets ResourceKey instance using ResourceHome lookup. |
abstract ResourceKey |
getResourceKey(javax.xml.namespace.QName keyName,
java.lang.Class keyClass)
Gets ResourceKey of a given name and type. |
abstract javax.xml.soap.SOAPHeaderElement |
getResourceKeyHeader()
Gets SOAPHeaderElement that contains the resource key for the service using ResourceHome
lookup. |
abstract javax.xml.soap.SOAPHeaderElement |
getResourceKeyHeader(javax.xml.namespace.QName keyName)
Gets SOAPHeaderElement of the specified name that contains the resource key. |
abstract java.lang.String |
getServiceName()
Gets path of the service. |
abstract java.net.URL |
getServiceURL()
Gets the full URL of the service |
abstract javax.xml.soap.SOAPMessage |
getSOAPMessage()
DOCUMENT_ME |
abstract void |
removeProperty(java.lang.String name)
|
abstract void |
setProperty(java.lang.String name,
java.lang.Object value)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected ResourceContext()
ResourceContext
object.
Method Detail |
public abstract void setProperty(java.lang.String name, java.lang.Object value)
MessageContext.setProperty(String, Object)
public abstract java.lang.Object getProperty(java.lang.String name)
MessageContext.getProperty(String)
public abstract java.util.Iterator getPropertyNames()
MessageContext.getPropertyNames()
public abstract Resource getResource() throws ResourceContextException, ResourceException
NoSuchResourceException
- if resource was not specified in the request or it does not exist.
ResourceContextException
- if error occurs during resource lookup.
ResourceException
public abstract ResourceHome getResourceHome() throws ResourceContextException
ResourceHome
associated with the service.
ResourceHome
associated with the service. Cannot be null.
NoResourceHomeException
- if ResourceHome
is not configured for the specified service.
ResourceContextException
- if any other error.public abstract ResourceKey getResourceKey(javax.xml.namespace.QName keyName, java.lang.Class keyClass) throws ResourceContextException, ResoureKeyHeaderNotFoundFaultException
ResourceKey
of a given name and type.
ResourceKey
of the given type and name. Returns null if the key of the specified name was not
found in the message.
ResourceContextException
- if error occurs during lookup.
ResoureKeyHeaderNotFoundFaultException
public abstract javax.xml.soap.SOAPHeaderElement getResourceKeyHeader() throws ResourceContextException
SOAPHeaderElement
that contains the resource key for the service using ResourceHome
lookup.
SOAPHeaderElement
that contains the resource key for the service. Returns null if one not
found.
ResourceContextException
- if error occurs during lookup.getResourceHome()
public abstract javax.xml.soap.SOAPHeaderElement getResourceKeyHeader(javax.xml.namespace.QName keyName) throws ResourceContextException
SOAPHeaderElement
of the specified name that contains the resource key.
SOAPHeaderElement
that contains the resource key of the given name. Returns null if one
not found.
ResourceContextException
- if error occurs during lookup.public abstract javax.xml.soap.SOAPMessage getSOAPMessage()
public static ResourceContext getResourceContext(javax.xml.rpc.handler.soap.SOAPMessageContext soapMsgContext)
ResourceContext
initialized with a specific SOAPMessageContext
.
ResourceContext
initialized with a specific SOAPMessageContext
.public abstract ResourceKey getResourceKey() throws ResourceContextException
ResourceKey
instance using ResourceHome
lookup.
ResourceKey
of name and type associated with the target service' ResourceHome
.
Returns null if key is not found in the message.
ResourceContextException
- if error occurs during lookup.getResourceHome()
public abstract java.lang.String getServiceName()
public abstract java.net.URL getServiceURL()
public abstract boolean containsProperty(java.lang.String name)
MessageContext.containsProperty(String)
public abstract void removeProperty(java.lang.String name)
MessageContext.removeProperty(String)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |