|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines a basic interface through which resources are discovered, and removed. The purpose of
ResourceHome
is to interact with a collection of resources of the same type. Each resource type will
have its own custom implementation the ResourceHome
interface. The implementation is expected to provide
custom methods for creating new resources and optionally methods that act on a set of resource objects.
Method Summary | |
Resource |
find(ResourceKey key)
Retrives a resource. |
EndpointReference |
getEndpointReference(java.lang.String endpointAddress,
ResourceKey key,
java.lang.String wsAddressingURI)
Builds an EPR based on the specified endpoint address, resource key, and WS-Addressing namespace URI. |
Resource |
getInstance(ResourceContext resourceContext)
Retrieves the Resource instance that is corresponds to the id contained
in the specified ResourceContext . |
java.lang.String |
getResourceClassName()
Returns the Class of the Resource Impl. |
java.lang.String |
getResourceKeyClassName()
The resource key type. |
java.lang.String |
getResourceKeyName()
The name of the resource key. |
java.lang.String |
getServiceClassName()
Returns the name of the Service class. |
java.lang.String |
getWsdlTargetNamespace()
Returns the target namespace of the WSDL. |
void |
remove(ResourceKey key)
Removes a resource. |
void |
setResourceClassName(java.lang.String className)
Sets the classname of the Resource Impl. |
void |
setResourceKeyClassName(java.lang.String className)
Sets the Class of the ResourceKey Impl |
void |
setResourceKeyName(java.lang.String keyName)
Sets the ResourceKey QName as a String value. |
void |
setServiceClassName(java.lang.String className)
Sets the Service Impl's .Class |
void |
setWsdlTargetNamespace(java.lang.String targetNamespace)
Sets the target namespace of the WSDL of this home's service. |
Methods inherited from interface org.apache.ws.resource.ResourceCreation |
addResourceCreationListener, removeResourceCreationListener |
Methods inherited from interface org.apache.ws.resource.ResourceDestruction |
addResourceDestructionListener, removeResourceDestructionListener |
Method Detail |
public java.lang.String getResourceKeyClassName()
ResourceKey
used or passed to this ResourceHome
must have
match this type (corresponds to ResourceKey.getValue()
).
public java.lang.String getResourceKeyName()
ResourceKey
used or passed to this ResourceHome
must
have match this name (corresponds to ResourceKey.getName()
).
public void setResourceClassName(java.lang.String className)
className
- The class name of the Resource Impl.public java.lang.String getResourceClassName()
public void setResourceKeyClassName(java.lang.String className)
className
- The class name of the ResourceKey implpublic void setResourceKeyName(java.lang.String keyName)
keyName
- The QName.toString() representation of the ResourceKeypublic void setServiceClassName(java.lang.String className)
className
- String representation of the classpublic java.lang.String getServiceClassName()
public void setWsdlTargetNamespace(java.lang.String targetNamespace)
targetNamespace
- public java.lang.String getWsdlTargetNamespace()
public Resource find(ResourceKey key) throws ResourceUnknownException, InvalidResourceKeyException, ResourceException
ResourceUnknownException
- if no resource exists with the given key
InvalidResourceKeyException
- if the resource key is invalid.
ResourceException
- if any other error occurs.public void remove(ResourceKey key) throws ResourceException, ResourceUnknownException, InvalidResourceKeyException, RemoveNotSupportedException
RemoveCallback
interface, the
implementation must invoke the remove() operation on the resource itself.
ResourceUnknownException
- if no resource exists with the given key
InvalidResourceKeyException
- if the resource key is invalid.
RemoveNotSupportedException
- if remove operation is not supported.
ResourceException
- if any other error occurs.public Resource getInstance(ResourceContext resourceContext) throws ResourceContextException, ResourceUnknownException, ResourceException
Resource
instance that is corresponds to the id contained
in the specified ResourceContext
.
ResourceUnknownException
- if no resource exists with the given key
InvalidResourceKeyException
- if the resource key is invalid.
ResourceException
- if any other error occurs.
ResourceContextException
public EndpointReference getEndpointReference(java.lang.String endpointAddress, ResourceKey key, java.lang.String wsAddressingURI)
endpointAddress
- key
- wsAddressingURI
-
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |