You are viewing a plain text version of this content. The canonical link for it is here.
Posted to muse-commits@ws.apache.org by da...@apache.org on 2006/08/28 23:55:30 UTC
svn commit: r437856 [1/2] - in /webservices/muse/trunk/modules:
muse-wsrf-api/src/org/apache/muse/ws/resource/
muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/
muse-wsrf-api/src/org/apache/muse/ws/resource/ext/
muse-wsrf-api/src/org/apache/mus...
Author: danj
Date: Mon Aug 28 14:55:27 2006
New Revision: 437856
URL: http://svn.apache.org/viewvc?rev=437856&view=rev
Log:
Updated/finished JavaDoc for WSRF API module
Modified:
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResource.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResourceCapability.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResourceCapabilityProperties.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsrfConstants.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/BaseFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/WsbfConstants.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/WsbfUtils.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/WsrfExtConstants.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/InvalidMessageFormatFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/ResourceInitializationFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/SerializationErrorFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/faults/ResourceUnavailableFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/faults/ResourceUnknownFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/ImmediateTermination.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/ScheduledTermination.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/WsrlConstants.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/ResourceNotDestroyedFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/TerminationTimeChangeRejectedFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/UnableToSetTerminationTimeFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/MetadataDescriptor.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/OpenMetadataDescriptor.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/ResourcePropertiesMetadataValidation.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/WsrmdConstants.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/faults/MetadataValidationFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/ResourcePropertyCollection.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/WsrpConstants.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetCapability.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetMultipleResourceProperties.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetResourceProperty.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetResourcePropertyDocument.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/faults/InvalidResourcePropertyQNameFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/listeners/PropertyChangeApprover.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/listeners/ResourcePropertyListeners.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryExpression.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryExpressionFactory.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryResourceProperties.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/InvalidQueryExpressionFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/QueryEvaluationErrorFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/UnknownQueryExpressionDialectFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/OpenPropertiesSchema.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/ResourcePropertiesSchema.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/ResourcePropertiesSchemaValidation.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/faults/SchemaValidationFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/PutResourcePropertyDocument.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetCapability.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetOperationFactory.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetRequest.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetRequestComponent.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetResourceProperties.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetResourcePropertiesComponents.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetResourcePropertiesPermissions.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/faults/InvalidModificationFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/faults/SetResourcePropertyRequestFailedFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/faults/UnableToModifyResourcePropertyFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/faults/UnableToPutResourcePropertyDocumentFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/sg/Entry.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/sg/MembershipContentRule.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/sg/ServiceGroup.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/sg/ServiceGroupPersistence.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/sg/ServiceGroupRegistration.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/sg/WssgConstants.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/sg/faults/AddRefusedFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/sg/faults/ContentCreationFailedFault.java
webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/sg/faults/UnsupportedMemberInterfaceFault.java
webservices/muse/trunk/modules/muse-wsrf-impl/src/org/apache/muse/ws/resource/properties/set/impl/AbstractSetRequestComponent.java
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResource.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResource.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResource.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResource.java Mon Aug 28 14:55:27 2006
@@ -35,5 +35,17 @@
public interface WsResource extends Resource
{
+ /**
+ *
+ * @return The internal WSRP state model - despite the fact that this has
+ * all of the WSRP operations available, none of them is exposed
+ * to remote clients until one or more of the WSRP capabilities
+ * is used in the resource's definition.
+ *
+ * @see org.apache.muse.ws.resource.properties.get.GetCapability
+ * @see org.apache.muse.ws.resource.properties.query.QueryCapability
+ * @see org.apache.muse.ws.resource.properties.set.SetCapability
+ *
+ */
ResourcePropertyCollection getPropertyCollection();
}
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResourceCapability.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResourceCapability.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResourceCapability.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResourceCapability.java Mon Aug 28 14:55:27 2006
@@ -36,5 +36,10 @@
public interface WsResourceCapability
extends Capability, WsResourceCapabilityProperties
{
+ /**
+ *
+ * @return The same as getResource(), cast to the WsResource type.
+ *
+ */
WsResource getWsResource();
}
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResourceCapabilityProperties.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResourceCapabilityProperties.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResourceCapabilityProperties.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsResourceCapabilityProperties.java Mon Aug 28 14:55:27 2006
@@ -36,20 +36,23 @@
*
*/
-public interface WsResourceCapabilityProperties
+interface WsResourceCapabilityProperties
{
+ void deleteProperty(QName property)
+ throws BaseFault;
+
+ Element[] getProperty(QName property)
+ throws BaseFault;
+
/**
*
+ * Concrete capability classes that define properties <b>MUST</b> override
+ * this method and provide the names of the properties.
+ *
* @return The names of the resource properties defined by this capability.
*
*/
QName[] getPropertyNames();
-
- Element[] getProperty(QName property)
- throws BaseFault;
-
- void deleteProperty(QName property)
- throws BaseFault;
void insertProperty(QName property, Element[] values)
throws BaseFault;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsrfConstants.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsrfConstants.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsrfConstants.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/WsrfConstants.java Mon Aug 28 14:55:27 2006
@@ -31,16 +31,16 @@
public class WsrfConstants
{
public static final String NAMESPACE_URI = "http://docs.oasis-open.org/wsrf/r-2";
-
- public static final String WSDL_NAMESPACE_URI = "http://docs.oasis-open.org/wsrf/rw-2";
public static final String PREFIX = "wsrf-r";
+
+ public static final String WSDL_NAMESPACE_URI = "http://docs.oasis-open.org/wsrf/rw-2";
public static final String WSDL_PREFIX = "wsrf-rw";
- public static final QName RESOURCE_UNKNOWN_QNAME =
- new QName(WSDL_NAMESPACE_URI, "ResourceUnknownFault", WSDL_PREFIX);
-
public static final QName RESOURCE_UNAVAILABLE_QNAME =
new QName(WSDL_NAMESPACE_URI, "ResourceUnavailableFault", WSDL_PREFIX);
+
+ public static final QName RESOURCE_UNKNOWN_QNAME =
+ new QName(WSDL_NAMESPACE_URI, "ResourceUnknownFault", WSDL_PREFIX);
}
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/BaseFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/BaseFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/BaseFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/BaseFault.java Mon Aug 28 14:55:27 2006
@@ -29,10 +29,10 @@
/**
*
- * SimpleBaseFault is Muse's default implementation of the WS-BaseFaults
- * SimpleBaseFault type. This can be used as a standalone class or (more commonly)
- * as a base class for more concrete fault types. WS-BF XML parsing and
- * serialization is also handled by this class.
+ * BaseFault is Muse's default implementation of the WS-BaseFaults BaseFault type.
+ * This can be used as a standalone class or (more commonly) as a base class for
+ * more concrete fault types. WS-BF XML parsing and serialization is also handled
+ * by this class.
*
* @author Dan Jemiolo (danj)
*
@@ -42,6 +42,11 @@
{
private static final long serialVersionUID = 7582724758621882686L;
+ private Element _errorCode = null;
+
+ private String _errorCodeDialect = null;
+
+ private QName _name = null;
//
// Where the fault was generated
//
@@ -52,14 +57,9 @@
//
private Date _timestamp = new Date();
- private Element _errorCode = null;
- private String _errorCodeDialect = null;
-
- private QName _name = null;
-
/**
*
- * Creates a new SimpleBaseFault by parsing the given XML according to the
+ * Creates a new BaseFault by parsing the given XML according to the
* WS-BF spec. This constructor only checks for elements and values
* defined in WS-BF and does not fail if extensions are added to the
* fault type.
@@ -68,7 +68,7 @@
* regardless of when this object is created.
*
* @param xml
- * The XML representation of a WS-BF SimpleBaseFault.
+ * The XML representation of a WS-BF BaseFault.
*
*/
public BaseFault(Element xml)
@@ -114,7 +114,7 @@
catch (Throwable error)
{
//
- // NOTE: This error occurs if the SimpleBaseFault XML had an invalid
+ // NOTE: This error occurs if the BaseFault XML had an invalid
// EPR definition for wsbf:OriginReference. Because this
// fault may be coming from an external service, we do
// not want to throw - the only thing worse than having a
@@ -154,11 +154,6 @@
_name = name;
}
- public final QName getName()
- {
- return _name;
- }
-
public final String getDescription()
{
return getMessage();
@@ -172,6 +167,11 @@
public final String getErrorCodeDialect()
{
return _errorCodeDialect;
+ }
+
+ public final QName getName()
+ {
+ return _name;
}
public final EndpointReference getOriginReference()
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/WsbfConstants.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/WsbfConstants.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/WsbfConstants.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/WsbfConstants.java Mon Aug 28 14:55:27 2006
@@ -21,16 +21,16 @@
/**
*
* WsbfConstants is a collection of properties that is useful when programming
- * against the WS-BaseFaults spec. This class uses WS-BF v1.2, draft 01.
+ * against the WS-BaseFaults spec. This class uses WS-BF v1.2.
*
* @author Dan Jemiolo (danj)
*
*/
public class WsbfConstants
-{
+{
public static final String NAMESPACE_URI = "http://docs.oasis-open.org/wsrf/bf-2";
-
+
public static final String PREFIX = "wsrf-bf";
public static final QName BASE_FAULT_QNAME =
@@ -39,17 +39,17 @@
public static final QName DESCRIPTION_QNAME =
new QName(NAMESPACE_URI, "Description", PREFIX);
+ public static final String ERROR_CODE_DIALECT = "dialect";
+
public static final QName ERROR_CODE_QNAME =
new QName(NAMESPACE_URI, "ErrorCode", PREFIX);
- public static final String ERROR_CODE_DIALECT = "dialect";
+ public static final QName FAULT_CAUSE_QNAME =
+ new QName(NAMESPACE_URI, "FaultCause", PREFIX);
public static final QName ORIGINATOR_QNAME =
new QName(NAMESPACE_URI, "OriginatorReference", PREFIX);
public static final QName TIMESTAMP_QNAME =
new QName(NAMESPACE_URI, "Timestamp", PREFIX);
-
- public static final QName FAULT_CAUSE_QNAME =
- new QName(NAMESPACE_URI, "FaultCause", PREFIX);
}
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/WsbfUtils.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/WsbfUtils.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/WsbfUtils.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/basefaults/WsbfUtils.java Mon Aug 28 14:55:27 2006
@@ -18,8 +18,25 @@
import org.apache.muse.ws.resource.faults.ResourceUnavailableFault;
+/**
+ *
+ * WsbfUtils is a set of convenience methods related to WS-BaseFaults v1.2.
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class WsbfUtils
{
+ /**
+ *
+ * @param error
+ *
+ * @return The same Throwable recast as a BaseFault, <b>or</b> - if the
+ * Throwable was not an instance of BaseFault - an instance of
+ * ResourceUnavailableFault with the argument as the cause.
+ *
+ */
public static BaseFault convertToFault(Throwable error)
{
if (error instanceof BaseFault)
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/WsrfExtConstants.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/WsrfExtConstants.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/WsrfExtConstants.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/WsrfExtConstants.java Mon Aug 28 14:55:27 2006
@@ -21,7 +21,7 @@
/**
*
* WsrfExtConstants is a collection of constants used by Muse to extend the
- * base WSRF spec. Most of the identifiers here are for common faults that
+ * base WSRF v1.2 spec. Most of the identifiers here are for common faults that
* happen frequently in the WSRP capability implementations.
*
* @author Dan Jemiolo (danj)
@@ -38,13 +38,13 @@
new QName(NAMESPACE_URI, "InvalidMessageFormat", PREFIX);
public static final QName METADATA_VALIDATION_ERROR_QNAME =
- new QName(NAMESPACE_URI, "MetadataValidationErrorFault", PREFIX);
+ new QName(NAMESPACE_URI, "MetadataValidationFault", PREFIX);
public static final QName RESOURCE_INITIALIZATION_QNAME =
new QName(NAMESPACE_URI, "ResourceInitializationFault", PREFIX);
public static final QName SCHEMA_VALIDATION_ERROR_QNAME =
- new QName(NAMESPACE_URI, "SchemaValidationErrorFault", PREFIX);
+ new QName(NAMESPACE_URI, "SchemaValidationFault", PREFIX);
public static final QName SERIALIZATION_ERROR_QNAME =
new QName(NAMESPACE_URI, "SerializationErrorFault", PREFIX);
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/InvalidMessageFormatFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/InvalidMessageFormatFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/InvalidMessageFormatFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/InvalidMessageFormatFault.java Mon Aug 28 14:55:27 2006
@@ -22,6 +22,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.ext.WsrfExtConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class InvalidMessageFormatFault extends BaseFault
{
private static final long serialVersionUID = 4874022523783312375L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/ResourceInitializationFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/ResourceInitializationFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/ResourceInitializationFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/ResourceInitializationFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.ext.WsrfExtConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class ResourceInitializationFault extends BaseFault
{
private static final long serialVersionUID = 4539155047536939584L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/SerializationErrorFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/SerializationErrorFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/SerializationErrorFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/ext/faults/SerializationErrorFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.ext.WsrfExtConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class SerializationErrorFault extends BaseFault
{
private static final long serialVersionUID = 6757289952824788179L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/faults/ResourceUnavailableFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/faults/ResourceUnavailableFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/faults/ResourceUnavailableFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/faults/ResourceUnavailableFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.WsrfConstants;
import org.apache.muse.ws.resource.basefaults.BaseFault;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class ResourceUnavailableFault extends BaseFault
{
private static final long serialVersionUID = -7569634397313256251L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/faults/ResourceUnknownFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/faults/ResourceUnknownFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/faults/ResourceUnknownFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/faults/ResourceUnknownFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.WsrfConstants;
import org.apache.muse.ws.resource.basefaults.BaseFault;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class ResourceUnknownFault extends BaseFault
{
private static final long serialVersionUID = 6896678425171432138L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/ImmediateTermination.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/ImmediateTermination.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/ImmediateTermination.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/ImmediateTermination.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
/**
*
+ * ImmediateTermination represents the WS-ResourceLifetime ImmediateResourceTermination
+ * capability, which has one method: wsrf-rl:Destroy. This capability allows
+ * remote clients to permanently remove resource instances from a system. If
+ * this capability is not used, only the internal application code will be
+ * allowed to destroy a resource instance.
+ *
* @author Dan Jemiolo (danj)
*
*/
@@ -29,15 +35,11 @@
{
/**
*
- * Makes the resource unavailable to external clients. Note that this does
- * not affect any destruction code in the Resource's destroy() operation;
- * the WS-RL destroy only pertains to the visibility of the resource instance.
- * WS-RL resources will need to remove the visibility of the resource and
- * then invoke any destruction/shutdown code that exists.
+ * Makes the resource's destruction logic available to remote clients.
*
* @throws ResourceNotDestroyedFault
* <ul>
- * <li>If the resource cannot be removed, or if a destructor
+ * <li>If the resource cannot be removed, or if a destruction
* callback fails.</li>
* </ul>
*
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/ScheduledTermination.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/ScheduledTermination.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/ScheduledTermination.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/ScheduledTermination.java Mon Aug 28 14:55:27 2006
@@ -25,6 +25,19 @@
import org.apache.muse.ws.resource.lifetime.faults.TerminationTimeChangeRejectedFault;
import org.apache.muse.ws.resource.lifetime.faults.UnableToSetTerminationTimeFault;
+/**
+ *
+ * ScheduledTermination represents the WS-ResourceLifetime ScheduledResourceTermination
+ * capability, which has two properties (wsrf-rl:CurrentTime and
+ * wsrf-rl:TerminationTime) and one method (wsrf-rl:SetTerminationTime).
+ * Implementations of this capability provide the self-destruction feature
+ * that occurs when the system's current time reaches the resource's
+ * termination time.
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public interface ScheduledTermination extends WsResourceCapability
{
QName[] PROPERTIES = new QName[]{
@@ -34,12 +47,7 @@
/**
*
- * @return The current time, according to the resource.
- *
- * @throws BaseFault
- * <ul>
- * <li>If there is a WS-RP-based error.</li>
- * </ul>
+ * @return The current time, according to the system the resource is on.
*
*/
Date getCurrentTime()
@@ -47,13 +55,8 @@
/**
*
- * @return The termination time for this resource. The method returns
- * null if the resource is not scheduled for termination.
- *
- * @throws BaseFault
- * <ul>
- * <li>If there is a WS-RP-based error.</li>
- * </ul>
+ * @return The termination time for this resource, or null if the resource
+ * is not scheduled for termination.
*
*/
Date getTerminationTime()
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/WsrlConstants.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/WsrlConstants.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/WsrlConstants.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/WsrlConstants.java Mon Aug 28 14:55:27 2006
@@ -31,9 +31,9 @@
{
public static final String NAMESPACE_URI = "http://docs.oasis-open.org/wsrf/rl-2";
- public static final String WSDL_NAMESPACE_URI = "http://docs.oasis-open.org/wsrf/rlw-2";
-
public static final String PREFIX = "wsrf-rl";
+
+ public static final String WSDL_NAMESPACE_URI = "http://docs.oasis-open.org/wsrf/rlw-2";
public static final String WSDL_PREFIX = "wsrf-rlw";
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/ResourceNotDestroyedFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/ResourceNotDestroyedFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/ResourceNotDestroyedFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/ResourceNotDestroyedFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.lifetime.WsrlConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class ResourceNotDestroyedFault extends BaseFault
{
private static final long serialVersionUID = 6866739382979399756L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/TerminationTimeChangeRejectedFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/TerminationTimeChangeRejectedFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/TerminationTimeChangeRejectedFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/TerminationTimeChangeRejectedFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.lifetime.WsrlConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class TerminationTimeChangeRejectedFault extends BaseFault
{
private static final long serialVersionUID = 5635627685023367442L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/UnableToSetTerminationTimeFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/UnableToSetTerminationTimeFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/UnableToSetTerminationTimeFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/lifetime/faults/UnableToSetTerminationTimeFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.lifetime.WsrlConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class UnableToSetTerminationTimeFault extends BaseFault
{
private static final long serialVersionUID = 7831882443947531527L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/MetadataDescriptor.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/MetadataDescriptor.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/MetadataDescriptor.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/MetadataDescriptor.java Mon Aug 28 14:55:27 2006
@@ -30,7 +30,7 @@
* actual metadata values, the interface has convenience methods for
* answering common questions ("Can I delete this property?", etc.)
* rather than requiring the user to calculate the answers based on
- * metadata values.
+ * metadata values. This interface is based on WS-RMD 1.0.
*
* @author Dan Jemiolo (danj)
*
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/OpenMetadataDescriptor.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/OpenMetadataDescriptor.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/OpenMetadataDescriptor.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/OpenMetadataDescriptor.java Mon Aug 28 14:55:27 2006
@@ -28,11 +28,10 @@
/**
*
- * OpenMetadataDescriptor is a
- * {@linkplain MetadataDescriptor MetadataDescriptor} that allows free reign
- * on all properties, since no rules or restrictions have been put in place.
- * This class is a singleton because an empty RMD is the same no matter what
- * properties are defined.
+ * OpenMetadataDescriptor is a {@linkplain MetadataDescriptor MetadataDescriptor}
+ * that allows free reign on all properties, since no rules or restrictions have
+ * been put in place. This class is a singleton because an empty RMD is the same
+ * no matter what properties are defined.
*
* @author Dan Jemiolo (danj)
*
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/ResourcePropertiesMetadataValidation.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/ResourcePropertiesMetadataValidation.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/ResourcePropertiesMetadataValidation.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/ResourcePropertiesMetadataValidation.java Mon Aug 28 14:55:27 2006
@@ -18,12 +18,21 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
+/**
+ *
+ * ResourcePropertiesMetadataValidation is a set of methods required of
+ * WSRP implementations that provide metadata validation via WS-RMD 1.0.
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public interface ResourcePropertiesMetadataValidation
{
/**
*
* Takes the RMD that has been provided through setMetadata() and creates
- * listeners that will enforce it. This method only needs to be called
+ * components that will enforce it. This method only needs to be called
* once after setMetadata() is called. After this method is called, any
* attempt to modify the WS-RP container in a way that is incompatible
* with the RMD will fail.
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/WsrmdConstants.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/WsrmdConstants.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/WsrmdConstants.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/WsrmdConstants.java Mon Aug 28 14:55:27 2006
@@ -21,7 +21,7 @@
/**
*
* WsrmdConstants is a collection of properties that are useful when programming
- * against the WS-ResourceMetadata spec. This class uses WS-RMD v1.0 CD.
+ * against the WS-ResourceMetadata spec. This class uses WS-RMD v1.0.
*
* @author Dan Jemiolo (danj)
*
@@ -31,7 +31,7 @@
{
/**
*
- * The current WS-RMD namespace URI - v1.0 CD.
+ * The current WS-RMD namespace URI - v1.0.
*
*/
public static final String NAMESPACE_URI = "http://docs.oasis-open.org/wsrf/rmd-1";
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/faults/MetadataValidationFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/faults/MetadataValidationFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/faults/MetadataValidationFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/metadata/faults/MetadataValidationFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.ext.WsrfExtConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class MetadataValidationFault extends BaseFault
{
private static final long serialVersionUID = 8481165393605262914L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/ResourcePropertyCollection.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/ResourcePropertyCollection.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/ResourcePropertyCollection.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/ResourcePropertyCollection.java Mon Aug 28 14:55:27 2006
@@ -1,72 +1,73 @@
-/*=============================================================================*
- * Copyright 2006 The Apache Software Foundation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *=============================================================================*/
-
-package org.apache.muse.ws.resource.properties;
-
-import org.apache.muse.util.xml.XmlSerializable;
-import org.apache.muse.ws.resource.metadata.ResourcePropertiesMetadataValidation;
-import org.apache.muse.ws.resource.properties.get.GetMultipleResourceProperties;
-import org.apache.muse.ws.resource.properties.get.GetResourceProperty;
-import org.apache.muse.ws.resource.properties.get.GetResourcePropertyDocument;
-import org.apache.muse.ws.resource.properties.get.ext.GetResourcePropertyExtensions;
-import org.apache.muse.ws.resource.properties.listeners.ResourcePropertyListeners;
-import org.apache.muse.ws.resource.properties.schema.ResourcePropertiesSchemaValidation;
-import org.apache.muse.ws.resource.properties.set.PutResourcePropertyDocument;
-import org.apache.muse.ws.resource.properties.set.SetResourceProperties;
-import org.apache.muse.ws.resource.properties.set.SetResourcePropertiesComponents;
-import org.apache.muse.ws.resource.properties.set.SetResourcePropertiesPermissions;
-import org.apache.muse.ws.resource.properties.set.ext.SetResourcePropertiesExtensions;
-
-/**
- *
- * ResourcePropertyCollection is the WSRP-based state model that is used by
- * all WS-resources. It does not imply or require the use of any WSRP
- * capabilities for remote clients; users must specify said capabilities
- * in muse.xml (with the <capability/> tag) if they want to do this.
- * <br><br>
- * The ResourcePropertyCollection provides a single, generic interface for
- * reading and writing resource properties that are spread across disparate
- * Capability objects. Read and write requests will be delegated to the
- * appropriate {@linkplain org.apache.muse.ws.resource.WsResourceCapability capabilities}
- * after all schema and metadata validation is done. This interface also implies
- * the use of various listeners, which allow users to hook into the read and
- * write requests at various points to respond to them with their own code.
- * The crux of the ResourcePropertyCollection's role, then, is the administrative
- * and plumbing tasks necessary to read, write, validate, and report on
- * resource properties, but not the actual storage of the properties themselves.
- *
- * @author Dan Jemiolo (danj)
- *
- */
-public interface ResourcePropertyCollection
- extends GetMultipleResourceProperties,
- GetResourceProperty,
- GetResourcePropertyExtensions,
- GetResourcePropertyDocument,
- PutResourcePropertyDocument,
- SetResourceProperties,
- SetResourcePropertiesComponents,
- SetResourcePropertiesExtensions,
- SetResourcePropertiesPermissions,
- ResourcePropertyListeners,
- ResourcePropertiesMetadataValidation,
- ResourcePropertiesSchemaValidation,
- XmlSerializable
-{
- //
- // no additional methods - this is an aggregate type
- //
-}
+/*=============================================================================*
+ * Copyright 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *=============================================================================*/
+
+package org.apache.muse.ws.resource.properties;
+
+import org.apache.muse.util.xml.XmlSerializable;
+import org.apache.muse.ws.resource.metadata.ResourcePropertiesMetadataValidation;
+import org.apache.muse.ws.resource.properties.get.GetMultipleResourceProperties;
+import org.apache.muse.ws.resource.properties.get.GetResourceProperty;
+import org.apache.muse.ws.resource.properties.get.GetResourcePropertyDocument;
+import org.apache.muse.ws.resource.properties.get.ext.GetResourcePropertyExtensions;
+import org.apache.muse.ws.resource.properties.listeners.ResourcePropertyListeners;
+import org.apache.muse.ws.resource.properties.schema.ResourcePropertiesSchemaValidation;
+import org.apache.muse.ws.resource.properties.set.PutResourcePropertyDocument;
+import org.apache.muse.ws.resource.properties.set.SetResourceProperties;
+import org.apache.muse.ws.resource.properties.set.SetResourcePropertiesComponents;
+import org.apache.muse.ws.resource.properties.set.SetResourcePropertiesPermissions;
+import org.apache.muse.ws.resource.properties.set.ext.SetResourcePropertiesExtensions;
+
+/**
+ *
+ * ResourcePropertyCollection is the WSRP-based state model that is used by
+ * all WS-resources. It does not imply or require the use of any WSRP
+ * capabilities for remote clients; users must specify said capabilities
+ * in muse.xml (with the <em>capability</em> tag) if they want to do this.
+ * <br><br>
+ * The ResourcePropertyCollection provides a single, generic interface for
+ * reading and writing resource properties that are spread across disparate
+ * Capability objects. Read and write requests will be delegated to the
+ * appropriate {@linkplain org.apache.muse.ws.resource.WsResourceCapability capabilities}
+ * after all schema and metadata validation is done. This interface also implies
+ * the use of various listeners, which allow users to hook into the read and
+ * write requests at various points to respond to them with their own code.
+ * The crux of the ResourcePropertyCollection's role, then, is the administrative
+ * and plumbing tasks necessary to read, write, validate, and report on
+ * resource properties, but not the actual storage of the properties themselves.
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
+public interface ResourcePropertyCollection
+ extends GetMultipleResourceProperties,
+ GetResourceProperty,
+ GetResourcePropertyExtensions,
+ GetResourcePropertyDocument,
+ PutResourcePropertyDocument,
+ SetResourceProperties,
+ SetResourcePropertiesComponents,
+ SetResourcePropertiesExtensions,
+ SetResourcePropertiesPermissions,
+ ResourcePropertyListeners,
+ ResourcePropertiesMetadataValidation,
+ ResourcePropertiesSchemaValidation,
+ XmlSerializable
+{
+ //
+ // no additional methods - this is an aggregate type
+ //
+}
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/WsrpConstants.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/WsrpConstants.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/WsrpConstants.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/WsrpConstants.java Mon Aug 28 14:55:27 2006
@@ -21,8 +21,7 @@
/**
*
* WsrpConstants is a collection of properties and methods that is useful when
-* programming against the WS-ResourceProperties spec. This class uses
-* WS-RP v1.2.
+* programming against the WS-ResourceProperties spec. This class uses WS-RP v1.2.
*
* @author Dan Jemiolo (danj)
*
@@ -31,10 +30,10 @@
public class WsrpConstants
{
public static final String NAMESPACE_URI = "http://docs.oasis-open.org/wsrf/rp-2";
-
- public static final String WSDL_NAMESPACE_URI = "http://docs.oasis-open.org/wsrf/rpw-2";
public static final String PREFIX = "wsrf-rp";
+
+ public static final String WSDL_NAMESPACE_URI = "http://docs.oasis-open.org/wsrf/rpw-2";
public static final String WSDL_PREFIX = "wsrf-rpw";
@@ -52,12 +51,33 @@
public static final QName DEFAULT_DOCUMENT_QNAME =
new QName(NAMESPACE_URI, "ResourceProperties", PREFIX);
+ public static final QName DELETE_QNAME =
+ new QName(NAMESPACE_URI, "Delete", PREFIX);
+
+ public static final String DIALECT = "Dialect";
+
+ public static final QName GET_DOCUMENT_QNAME =
+ new QName(NAMESPACE_URI, "GetResourcePropertyDocument", PREFIX);
+
+ public static final QName GET_DOCUMENT_RESPONSE_QNAME =
+ new QName(NAMESPACE_URI, "GetResourcePropertyDocumentResponse", PREFIX);
+
/**
*
- * The standard WS-RP TopicSpace name.
+ * The WS-A Action URI for the GetMultipleResourceProperties operation.
*
*/
- public static final String TOPIC_SPACE_NAME = "ResourcePropertiesTopicSpace";
+ public static final String GET_MULTIPLE_PROPERTIES_URI =
+ WSDL_NAMESPACE_URI + "/GetMultipleResourceProperties/GetMultipleResourcePropertiesRequest";
+
+ public static final QName GET_MULTIPLE_QNAME =
+ new QName(NAMESPACE_URI, "GetMultipleResourceProperties", PREFIX);
+
+ public static final QName GET_MULTIPLE_RESPONSE_QNAME =
+ new QName(NAMESPACE_URI, "GetMultipleResourcePropertiesResponse", PREFIX);
+
+ public static final QName GET_QNAME =
+ new QName(NAMESPACE_URI, "GetResourceProperty", PREFIX);
/**
*
@@ -66,6 +86,9 @@
*/
public static final String GET_RESOURCE_PROPERTY_URI =
WSDL_NAMESPACE_URI + "/GetResourceProperty/GetResourcePropertyRequest";
+
+ public static final QName GET_RESPONSE_QNAME =
+ new QName(NAMESPACE_URI, "GetResourcePropertyResponse", PREFIX);
/**
*
@@ -74,151 +97,122 @@
*/
public static final String GET_RP_DOCUMENT_URI =
WSDL_NAMESPACE_URI + "/GetResourcePropertyDocument/GetResourcePropertyDocumentRequest";
+
+ public static final QName INSERT_QNAME =
+ new QName(NAMESPACE_URI, "Insert", PREFIX);
+
+ public static final QName INVALID_MODIFICATION_QNAME =
+ new QName(WSDL_NAMESPACE_URI, "InvalidModificationFault", WSDL_PREFIX);
+
+ public static final QName INVALID_PROPERTY_QNAME =
+ new QName(WSDL_NAMESPACE_URI, "InvalidResourcePropertyQNameFault", WSDL_PREFIX);
- /**
- *
- * The WS-A Action URI for the PutResourcePropertyDocument operation.
- *
- */
- public static final String PUT_RP_DOCUMENT_URI =
- WSDL_NAMESPACE_URI + "/PutResourcePropertyDocument/PutResourcePropertyDocumentRequest";
+ public static final QName INVALID_QUERY_QNAME =
+ new QName(WSDL_NAMESPACE_URI, "InvalidQueryExpressionFault", WSDL_PREFIX);
/**
*
- * The WS-A Action URI for the GetMultipleResourceProperties operation.
+ * WS-RP/WS-N change notification - new value element name.
*
*/
- public static final String GET_MULTIPLE_PROPERTIES_URI =
- WSDL_NAMESPACE_URI + "/GetMultipleResourceProperties/GetMultipleResourcePropertiesRequest";
-
+ public static final QName NEW_VALUE_QNAME =
+ new QName(NAMESPACE_URI, "NewValue", PREFIX);
+
/**
*
- * The WS-A Action URI for the QueryResourceProperties operation.
+ * WS-RP/WS-N change notification - root element name.
*
*/
- public static final String QUERY_RESOURCE_PROPERTIES_URI =
- WSDL_NAMESPACE_URI + "/QueryResourceProperties/QueryResourcePropertiesRequest";
-
+ public static final QName NOTIFICATION_QNAME =
+ new QName(NAMESPACE_URI, "ResourcePropertyValueChangeNotification", PREFIX);
+
/**
*
- * The WS-A Action URI for the SetResourceProperties operation.
+ * WS-RP/WS-N change notification - old value element name.
*
*/
- public static final String SET_RESOURCE_PROPERTIES_URI =
- WSDL_NAMESPACE_URI + "/SetResourceProperties/SetResourcePropertiesRequest";
+ public static final QName OLD_VALUE_QNAME =
+ new QName(NAMESPACE_URI, "OldValue", PREFIX);
+
+ public static final QName PROPERTY_QNAME =
+ new QName(NAMESPACE_URI, "ResourceProperty", PREFIX);
+
+ public static final QName PUT_DOCUMENT_QNAME =
+ new QName(NAMESPACE_URI, "PutResourcePropertyDocument", PREFIX);
/**
*
- * The WS-RP attribute for WSDL portTypes.
+ * The WS-A Action URI for the PutResourcePropertyDocument operation.
*
*/
- public static final String RESOURCE_PROPERTIES = "ResourceProperties";
-
- public static final QName GET_QNAME =
- new QName(NAMESPACE_URI, "GetResourceProperty", PREFIX);
-
- public static final QName GET_RESPONSE_QNAME =
- new QName(NAMESPACE_URI, "GetResourcePropertyResponse", PREFIX);
-
- public static final QName INVALID_PROPERTY_QNAME =
- new QName(WSDL_NAMESPACE_URI, "InvalidResourcePropertyQNameFault", WSDL_PREFIX);
-
- public static final QName GET_MULTIPLE_QNAME =
- new QName(NAMESPACE_URI, "GetMultipleResourceProperties", PREFIX);
-
- public static final QName GET_MULTIPLE_RESPONSE_QNAME =
- new QName(NAMESPACE_URI, "GetMultipleResourcePropertiesResponse", PREFIX);
-
- public static final QName PROPERTY_QNAME =
- new QName(NAMESPACE_URI, "ResourceProperty", PREFIX);
-
- public static final QName GET_DOCUMENT_QNAME =
- new QName(NAMESPACE_URI, "GetResourcePropertyDocument", PREFIX);
+ public static final String PUT_RP_DOCUMENT_URI =
+ WSDL_NAMESPACE_URI + "/PutResourcePropertyDocument/PutResourcePropertyDocumentRequest";
- public static final QName GET_DOCUMENT_RESPONSE_QNAME =
- new QName(NAMESPACE_URI, "GetResourcePropertyDocumentResponse", PREFIX);
+ public static final QName QUERY_DIALECT_QNAME =
+ new QName(NAMESPACE_URI, "QueryExpressionDialect", PREFIX);
- public static final QName QUERY_QNAME =
- new QName(NAMESPACE_URI, "QueryResourceProperties", PREFIX);
+ public static final QName QUERY_EVALUATION_ERROR_QNAME =
+ new QName(WSDL_NAMESPACE_URI, "QueryEvaluationErrorFault", WSDL_PREFIX);
public static final QName QUERY_EXPRESSION_QNAME =
new QName(NAMESPACE_URI, "QueryExpression", PREFIX);
- public static final QName QUERY_DIALECT_QNAME =
- new QName(NAMESPACE_URI, "QueryExpressionDialect", PREFIX);
+ public static final QName QUERY_QNAME =
+ new QName(NAMESPACE_URI, "QueryResourceProperties", PREFIX);
- public static final String DIALECT = "Dialect";
+ /**
+ *
+ * The WS-A Action URI for the QueryResourceProperties operation.
+ *
+ */
+ public static final String QUERY_RESOURCE_PROPERTIES_URI =
+ WSDL_NAMESPACE_URI + "/QueryResourceProperties/QueryResourcePropertiesRequest";
public static final QName QUERY_RESPONSE_QNAME =
new QName(NAMESPACE_URI, "QueryResourcePropertiesResponse", PREFIX);
-
- public static final QName UNKNOWN_QUERY_DIALECT_QNAME =
- new QName(WSDL_NAMESPACE_URI, "UnknownQueryExpressionDialectFault", WSDL_PREFIX);
- public static final QName INVALID_QUERY_QNAME =
- new QName(WSDL_NAMESPACE_URI, "InvalidQueryExpressionFault", WSDL_PREFIX);
-
- public static final QName QUERY_EVALUATION_ERROR_QNAME =
- new QName(WSDL_NAMESPACE_URI, "QueryEvaluationErrorFault", WSDL_PREFIX);
+ /**
+ *
+ * The WS-RP attribute for WSDL portTypes.
+ *
+ */
+ public static final String RESOURCE_PROPERTIES = "ResourceProperties";
- public static final QName PUT_DOCUMENT_QNAME =
- new QName(NAMESPACE_URI, "PutResourcePropertyDocument", PREFIX);
+ public static final String RESOURCE_PROPERTY = "ResourceProperty";
public static final QName SET_QNAME =
new QName(NAMESPACE_URI, "SetResourceProperties", PREFIX);
+ /**
+ *
+ * The WS-A Action URI for the SetResourceProperties operation.
+ *
+ */
+ public static final String SET_RESOURCE_PROPERTIES_URI =
+ WSDL_NAMESPACE_URI + "/SetResourceProperties/SetResourcePropertiesRequest";
+
public static final QName SET_RESPONSE_QNAME =
new QName(NAMESPACE_URI, "SetResourcePropertiesResponse", PREFIX);
-
- public static final QName DELETE_QNAME =
- new QName(NAMESPACE_URI, "Delete", PREFIX);
-
- public static final QName INSERT_QNAME =
- new QName(NAMESPACE_URI, "Insert", PREFIX);
-
- public static final QName UPDATE_QNAME =
- new QName(NAMESPACE_URI, "Update", PREFIX);
-
- public static final String RESOURCE_PROPERTY = "ResourceProperty";
-
- public static final QName INVALID_MODIFICATION_QNAME =
- new QName(WSDL_NAMESPACE_URI, "InvalidModificationFault", WSDL_PREFIX);
-
- public static final QName UNABLE_TO_MODIFY_QNAME =
- new QName(WSDL_NAMESPACE_URI, "UnableToModifyResourcePropertyFault", WSDL_PREFIX);
public static final QName SET_RP_FAILED_QNAME =
new QName(WSDL_NAMESPACE_URI, "SetResourcePropertyRequestFailedFault", WSDL_PREFIX);
- public static final QName UNABLE_TO_PUT_RP_QNAME =
- new QName(WSDL_NAMESPACE_URI, "UnableToPutResourcePropertyDocumentFault", WSDL_PREFIX);
-
-
- //
- // below are the semi-standard WS-RP/WS-N change notification elements
- //
-
/**
*
- * WS-RP/WS-N change notification - old value element name.
+ * The standard WS-RP TopicSpace name.
*
*/
- public static final QName OLD_VALUE_QNAME =
- new QName(NAMESPACE_URI, "OldValue", PREFIX);
+ public static final String TOPIC_SPACE_NAME = "ResourcePropertiesTopicSpace";
+
+ public static final QName UNABLE_TO_MODIFY_QNAME =
+ new QName(WSDL_NAMESPACE_URI, "UnableToModifyResourcePropertyFault", WSDL_PREFIX);
+
+ public static final QName UNABLE_TO_PUT_RP_QNAME =
+ new QName(WSDL_NAMESPACE_URI, "UnableToPutResourcePropertyDocumentFault", WSDL_PREFIX);
- /**
- *
- * WS-RP/WS-N change notification - new value element name.
- *
- */
- public static final QName NEW_VALUE_QNAME =
- new QName(NAMESPACE_URI, "NewValue", PREFIX);
+ public static final QName UNKNOWN_QUERY_DIALECT_QNAME =
+ new QName(WSDL_NAMESPACE_URI, "UnknownQueryExpressionDialectFault", WSDL_PREFIX);
- /**
- *
- * WS-RP/WS-N change notification - root element name.
- *
- */
- public static final QName NOTIFICATION_QNAME =
- new QName(NAMESPACE_URI, "ResourcePropertyValueChangeNotification", PREFIX);
+ public static final QName UPDATE_QNAME =
+ new QName(NAMESPACE_URI, "Update", PREFIX);
}
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetCapability.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetCapability.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetCapability.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetCapability.java Mon Aug 28 14:55:27 2006
@@ -18,6 +18,18 @@
import org.apache.muse.ws.resource.WsResourceCapability;
+/**
+ *
+ * GetCapability allows resources to expose the "get" operations defined by
+ * WS-RP - GetMultipleResourceProperties, GetResourceProperty, and
+ * GetResourcePropertyDocument. These three operations are the "read-only"
+ * part of the WS-RP spec that do not require the support of some kind of
+ * query dialect (which usually adds the burden of processing overhead and
+ * libraries to evaluate the queries).
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
public interface GetCapability
extends WsResourceCapability,
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetMultipleResourceProperties.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetMultipleResourceProperties.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetMultipleResourceProperties.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetMultipleResourceProperties.java Mon Aug 28 14:55:27 2006
@@ -25,8 +25,6 @@
/**
*
- * GetMultipleResourceProperties is ...
- *
* @author Dan Jemiolo (danj)
*
*/
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetResourceProperty.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetResourceProperty.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetResourceProperty.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetResourceProperty.java Mon Aug 28 14:55:27 2006
@@ -25,8 +25,6 @@
/**
*
- * GetResourceProperty is ...
- *
* @author Dan Jemiolo (danj)
*
*/
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetResourcePropertyDocument.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetResourcePropertyDocument.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetResourcePropertyDocument.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/GetResourcePropertyDocument.java Mon Aug 28 14:55:27 2006
@@ -22,14 +22,18 @@
/**
*
- * GetResourcePropertyDocument is ...
- *
* @author Dan Jemiolo (danj)
*
*/
public interface GetResourcePropertyDocument
{
+ /**
+ *
+ * @return The resource's entire WS-RP document, with the most up-to-date
+ * values of all properties.
+ *
+ */
Element getResourcePropertyDocument()
throws BaseFault;
}
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/faults/InvalidResourcePropertyQNameFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/faults/InvalidResourcePropertyQNameFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/faults/InvalidResourcePropertyQNameFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/get/faults/InvalidResourcePropertyQNameFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.properties.WsrpConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class InvalidResourcePropertyQNameFault extends BaseFault
{
private static final long serialVersionUID = -1609554523949920531L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/listeners/PropertyChangeApprover.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/listeners/PropertyChangeApprover.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/listeners/PropertyChangeApprover.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/listeners/PropertyChangeApprover.java Mon Aug 28 14:55:27 2006
@@ -61,6 +61,18 @@
/**
*
+ * Sets the security token that will be used in all security checks
+ * via isSecure(Object).
+ *
+ * @param securityToken
+ *
+ * @see #isSecure(Object)
+ *
+ */
+ void setSecurityToken(Object securityToken);
+
+ /**
+ *
* Analyzes the property change being made and throws an exception if
* the change is invalid.
*
@@ -84,16 +96,4 @@
*/
void validateChange(Element oldValue, Element newValue, Object token)
throws BaseFault;
-
- /**
- *
- * Sets the security token that will be used in all security checks
- * via isSecure(Object).
- *
- * @param securityToken
- *
- * @see #isSecure(Object)
- *
- */
- void setSecurityToken(Object securityToken);
}
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/listeners/ResourcePropertyListeners.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/listeners/ResourcePropertyListeners.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/listeners/ResourcePropertyListeners.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/listeners/ResourcePropertyListeners.java Mon Aug 28 14:55:27 2006
@@ -22,18 +22,16 @@
/**
*
- * ResourcePropertyListeners defines operations for WS-RP documents
+ * ResourcePropertyListeners defines operations for WS-RP implementations
* that allow users to monitor activity on the document and subscribe to
* notifications about that activity. Because the concepts of validation
* and notifications are often used together, this interface also defines
- * a set of operations for applying a schema and metadata for the properties
- * document. Implementations of this interface will provide all of the
- * standard WS-RP operations plus the ability to react to asynchronous
- * events on the properties.
+ * a set of operations for applying a schema and metadata restrictions to the
+ * WS-RP document.
*
* @author Dan Jemiolo (danj)
*
- * @see org.apache.muse.ws.resource.properties.impl.SimpleResourcePropertyCollection
+ * @see org.apache.muse.ws.resource.properties.ResourcePropertyCollection
*
*/
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryExpression.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryExpression.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryExpression.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryExpression.java Mon Aug 28 14:55:27 2006
@@ -22,10 +22,38 @@
import org.apache.muse.ws.resource.properties.query.faults.InvalidQueryExpressionFault;
import org.apache.muse.ws.resource.properties.query.faults.QueryEvaluationErrorFault;
+/**
+ *
+ * QueryExpression describes components that can evaluate an XML document
+ * based on a specific query language. An example of such a query language
+ * is XPath 1.0. Evaluation of a query expression on an XML document should
+ * result in a set of DOM Nodes no matter what language is used.
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public interface QueryExpression
{
+ /**
+ *
+ * @return The URI that defines the query language for this expression.
+ *
+ */
String getDialect();
+ /**
+ *
+ * @param wsrpDoc
+ * A resource's WSRP document.
+ *
+ * @param query
+ * A query expression in the language described by getDialect().
+ *
+ * @return An array of nodes from the given document that match the
+ * query expression. The array may be empty.
+ *
+ */
Node[] evaluate(Element wsrpDoc, String query)
throws InvalidQueryExpressionFault,
QueryEvaluationErrorFault;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryExpressionFactory.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryExpressionFactory.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryExpressionFactory.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryExpressionFactory.java Mon Aug 28 14:55:27 2006
@@ -20,10 +20,36 @@
import org.apache.muse.ws.resource.properties.query.faults.UnknownQueryExpressionDialectFault;
+/**
+ *
+ * QueryExpressionFactory is a means of generating executable
+ * {@linkplain QueryExpression QueryExpressions} for a set of dialects
+ * without having to reference specific dialects or language constructs
+ * in the calling code.
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public interface QueryExpressionFactory
{
+ /**
+ *
+ * @return The URIs that represent the query dialects supported by this factory.
+ *
+ */
Collection getDialects();
+ /**
+ *
+ * @param dialect
+ *
+ * @return A QueryExpression object that can be used to evaluate queries
+ * for the given dialect.
+ *
+ * @throws UnknownQueryExpressionDialectFault
+ *
+ */
QueryExpression newInstance(String dialect)
throws UnknownQueryExpressionDialectFault;
}
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryResourceProperties.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryResourceProperties.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryResourceProperties.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/QueryResourceProperties.java Mon Aug 28 14:55:27 2006
@@ -28,8 +28,6 @@
/**
*
- * QueryResourceProperties is ...
- *
* @author Dan Jemiolo (danj)
*
*/
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/InvalidQueryExpressionFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/InvalidQueryExpressionFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/InvalidQueryExpressionFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/InvalidQueryExpressionFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.properties.WsrpConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class InvalidQueryExpressionFault extends BaseFault
{
private static final long serialVersionUID = -2208251219926993163L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/QueryEvaluationErrorFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/QueryEvaluationErrorFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/QueryEvaluationErrorFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/QueryEvaluationErrorFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.properties.WsrpConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class QueryEvaluationErrorFault extends BaseFault
{
private static final long serialVersionUID = 4578814819641364868L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/UnknownQueryExpressionDialectFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/UnknownQueryExpressionDialectFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/UnknownQueryExpressionDialectFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/query/faults/UnknownQueryExpressionDialectFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.properties.WsrpConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class UnknownQueryExpressionDialectFault extends BaseFault
{
private static final long serialVersionUID = -1479735044591291531L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/OpenPropertiesSchema.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/OpenPropertiesSchema.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/OpenPropertiesSchema.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/OpenPropertiesSchema.java Mon Aug 28 14:55:27 2006
@@ -45,6 +45,16 @@
/**
*
+ * @return The singleton instance of this class.
+ *
+ */
+ public static OpenPropertiesSchema getInstance()
+ {
+ return _SINGLETON;
+ }
+
+ /**
+ *
* Private constructor used to prevent instantiation.
*
*/
@@ -55,14 +65,14 @@
//
}
- /**
- *
- * @return The singleton instance of this class.
- *
- */
- public static OpenPropertiesSchema getInstance()
+ public WsResourceCapability getCapability(QName property)
{
- return _SINGLETON;
+ throw new UnsupportedOperationException();
+ }
+
+ public QName getElementName()
+ {
+ return WsrpConstants.DEFAULT_DOCUMENT_QNAME;
}
/**
@@ -74,7 +84,7 @@
{
return UNBOUNDED;
}
-
+
/**
*
* @return zero (0)
@@ -94,7 +104,7 @@
{
return Collections.EMPTY_LIST;
}
-
+
/**
*
* @return null
@@ -105,6 +115,11 @@
return null;
}
+ public boolean hasCapability(QName property)
+ {
+ return true;
+ }
+
/**
*
* @return true
@@ -124,7 +139,7 @@
{
return true;
}
-
+
/**
*
* @return true
@@ -135,24 +150,9 @@
return true;
}
- public WsResourceCapability getCapability(QName property)
- {
- throw new UnsupportedOperationException();
- }
-
- public boolean hasCapability(QName property)
- {
- return true;
- }
-
public void setCapability(QName property, WsResourceCapability capability)
{
throw new UnsupportedOperationException();
- }
-
- public QName getElementName()
- {
- return WsrpConstants.DEFAULT_DOCUMENT_QNAME;
}
public void setElementName(QName wsrpName)
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/ResourcePropertiesSchema.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/ResourcePropertiesSchema.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/ResourcePropertiesSchema.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/ResourcePropertiesSchema.java Mon Aug 28 14:55:27 2006
@@ -42,7 +42,17 @@
* can have unlimited instances.
*
*/
- final int UNBOUNDED = Integer.MAX_VALUE;
+ int UNBOUNDED = Integer.MAX_VALUE;
+
+ /**
+ *
+ * @param property
+ *
+ * @return The capability that defines the resource property, or null if
+ * the property does not exist.
+ *
+ */
+ WsResourceCapability getCapability(QName property);
/**
*
@@ -77,7 +87,7 @@
*
*/
Collection getPropertyNames();
-
+
/**
*
* @param property
@@ -88,7 +98,9 @@
*
*/
QName getPropertyTypeName(QName property);
-
+
+ boolean hasCapability(QName property);
+
/**
*
* @param property
@@ -117,10 +129,16 @@
*/
boolean isNillable(QName property);
- WsResourceCapability getCapability(QName property);
-
- boolean hasCapability(QName property);
-
+ /**
+ *
+ * Maps the property to the capability so that users can later determine
+ * which capability should be used for servicing read/write requests
+ * against the property.
+ *
+ * @param property
+ * @param capability
+ *
+ */
void setCapability(QName property, WsResourceCapability capability);
/**
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/ResourcePropertiesSchemaValidation.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/ResourcePropertiesSchemaValidation.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/ResourcePropertiesSchemaValidation.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/ResourcePropertiesSchemaValidation.java Mon Aug 28 14:55:27 2006
@@ -23,21 +23,52 @@
import org.apache.muse.ws.resource.WsResourceCapability;
import org.apache.muse.ws.resource.basefaults.BaseFault;
+/**
+ *
+ * ResourcePropertiesSchemaValidation is a set of methods for WSRP
+ * implementations that provide schema validation and a capability
+ * delegation model.
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
public interface ResourcePropertiesSchemaValidation
{
+ /**
+ *
+ * Registers the capability with the schema so that users of the schema
+ * can determine which capability is responsible for which resource properties.
+ *
+ * @param capability
+ *
+ */
void addCapability(WsResourceCapability capability);
+ /**
+ *
+ * @param qname
+ * The name of the resource property whose capability is being queried.
+ *
+ * @return The capability that defines the given property, or null if the
+ * property does not exist.
+ *
+ */
WsResourceCapability getCapability(QName qname);
/**
*
+ * @return All of the resource properties defined by the schema.
+ *
+ */
+ Collection getPropertyNames();
+
+ /**
+ *
* @return The XSD for this WS-RP document.
*
*/
ResourcePropertiesSchema getSchema();
-
- Collection getPropertyNames();
/**
*
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/faults/SchemaValidationFault.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/faults/SchemaValidationFault.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/faults/SchemaValidationFault.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/schema/faults/SchemaValidationFault.java Mon Aug 28 14:55:27 2006
@@ -21,6 +21,12 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
import org.apache.muse.ws.resource.ext.WsrfExtConstants;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public class SchemaValidationFault extends BaseFault
{
private static final long serialVersionUID = -6023235939977117785L;
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/PutResourcePropertyDocument.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/PutResourcePropertyDocument.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/PutResourcePropertyDocument.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/PutResourcePropertyDocument.java Mon Aug 28 14:55:27 2006
@@ -20,8 +20,27 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
+/**
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public interface PutResourcePropertyDocument
{
+ /**
+ *
+ * @param wsrpDoc
+ * The new WSRP document for the resource instance.
+ *
+ * @return If the change was a complete success, the method returns
+ * null. If any differences exist between the given WSRP document
+ * and the one that is present after the method is finished, the
+ * method returns the entire WSRP document.
+ *
+ * @throws BaseFault
+ *
+ */
Element putResourcePropertyDocument(Element wsrpDoc)
throws BaseFault;
}
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetCapability.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetCapability.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetCapability.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetCapability.java Mon Aug 28 14:55:27 2006
@@ -18,6 +18,16 @@
import org.apache.muse.ws.resource.WsResourceCapability;
+/**
+ *
+ * SetCapability is allows users to expose the WSRP "write" operations so that
+ * remote clients can modify the contents of the WSRP document. These operations
+ * include PutResourcePropertyDocument and SetResourceProperties.
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
+
public interface SetCapability
extends WsResourceCapability,
PutResourcePropertyDocument,
Modified: webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetOperationFactory.java
URL: http://svn.apache.org/viewvc/webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetOperationFactory.java?rev=437856&r1=437855&r2=437856&view=diff
==============================================================================
--- webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetOperationFactory.java (original)
+++ webservices/muse/trunk/modules/muse-wsrf-api/src/org/apache/muse/ws/resource/properties/set/SetOperationFactory.java Mon Aug 28 14:55:27 2006
@@ -22,6 +22,16 @@
import org.apache.muse.ws.resource.basefaults.BaseFault;
+/**
+ *
+ * SetOperationFactory is a component that allows users to create executable
+ * commands for a WSRP document by providing either the values of the command
+ * or an XML fragment that represents it. All commands are compliant with the
+ * WSRP v1.2 SetResourceProperties spec definition.
+ *
+ * @author Dan Jemiolo (danj)
+ *
+ */
public interface SetOperationFactory
{
/**
---------------------------------------------------------------------
To unsubscribe, e-mail: muse-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: muse-commits-help@ws.apache.org