org.apache.ws.resource
Interface ResourceCapability

All Known Subinterfaces:

ResourceDefinition

public interface ResourceCapability

A WSRF resource capability (i.e. set of operations and properties).

Author:

Ian Springer

Method Summary

java.util.Map	getAllOperations() Returns a Map containing the OperationInfos for all operations exposed in the wsdl.
javax.xml.namespace.QName	getBindingName() Returns the Binding QName associated with the current porttype
java.lang.String[]	getCustomOperationNames()
javax.xml.namespace.QName[]	getCustomPropertyNames()
javax.wsdl.Definition	getDefinition() Returns the JWSDL Definition for this WS-Resource capability.
java.util.Map	getImplementedResourceCapabilities()
java.lang.String	getMetadataDescriptorLocation() Returns the location of the WS-RMD metadata definitions document, as specified by the wsrmd:MetadataDescriptorLocation attribute on the portType, or null if this resource does not define a metadata descriptor.
javax.xml.namespace.QName	getMetadataDescriptorName() Returns the name of the WS-RMD metadata descriptor, as specified by the wsrmd:MetadataDescriptor attribute on the portType, or null if this resource does not define a metadata descriptor.
javax.wsdl.PortType	getPortType() Returns the JWSDL PortType corresponding to this WS-Resource capability.
javax.xml.namespace.QName	getPropertiesDocumentName() Returns the name of the resource properties document element, as specified by the wsrf-rp:ResourceProperties attribute on the portType, or null if this resource does not define a properties document.
javax.xml.namespace.QName[]	getPropertyNames() Returns a list of the QNames of the resource properties that are defined for the specified portType, or null if the portType does not have any associated resource properties.
boolean	hasProperties()
boolean	implementsResourceCapability(javax.xml.namespace.QName capabilityName)

Method Detail

getAllOperations

public java.util.Map getAllOperations()

Returns a Map containing the OperationInfos for all operations exposed in the wsdl.

Returns:

A Map of all operations as OperationInfos

getBindingName

public javax.xml.namespace.QName getBindingName()

Returns the Binding QName associated with the current porttype

Returns:

Binding QName

getCustomOperationNames

public java.lang.String[] getCustomOperationNames()

Returns:

the names of all custom operations (i.e. operations that are not derived from a "base" ResourceDefinition)

getCustomPropertyNames

public javax.xml.namespace.QName[] getCustomPropertyNames()

Returns:

the names of all custom properties (i.e. proeprties that are not derived from a "base" ResourceDefinition)

getDefinition

public javax.wsdl.Definition getDefinition()

Returns the JWSDL Definition for this WS-Resource capability.

Returns:

getImplementedResourceCapabilities

public java.util.Map getImplementedResourceCapabilities()

Returns:

a map of any other ResourceCapabilitys that this capability implements; the map's keys are the QNames of the capability portTypes, and the values are the ResourceCapabilitys.

getMetadataDescriptorLocation

public java.lang.String getMetadataDescriptorLocation()

Returns the location of the WS-RMD metadata definitions document, as specified by the wsrmd:MetadataDescriptorLocation attribute on the portType, or null if this resource does not define a metadata descriptor.

Returns:

getMetadataDescriptorName

public javax.xml.namespace.QName getMetadataDescriptorName()

Returns the name of the WS-RMD metadata descriptor, as specified by the wsrmd:MetadataDescriptor attribute on the portType, or null if this resource does not define a metadata descriptor.

Returns:

getPortType

public javax.wsdl.PortType getPortType()

Returns the JWSDL PortType corresponding to this WS-Resource capability.

Returns:

getPropertiesDocumentName

public javax.xml.namespace.QName getPropertiesDocumentName()

Returns the name of the resource properties document element, as specified by the wsrf-rp:ResourceProperties attribute on the portType, or null if this resource does not define a properties document.

Returns:

getPropertyNames

public javax.xml.namespace.QName[] getPropertyNames()

Returns a list of the QNames of the resource properties that are defined for the specified portType, or null if the portType does not have any associated resource properties.

Returns:

the QNames of the resource properties defined for the specified portType

hasProperties

public boolean hasProperties()

Returns:

true if this resource defines a resource properties document, or false if it does not

implementsResourceCapability

public boolean implementsResourceCapability(javax.xml.namespace.QName capabilityName)

Parameters:

capabilityName -

Returns: