org.universAAL.middleware.service

Class ServiceResponse

java.lang.Object

org.universAAL.middleware.rdf.Resource

org.universAAL.middleware.rdf.FinalizedResource

org.universAAL.middleware.rdf.ScopedResource

org.universAAL.middleware.service.ServiceResponse

All Implemented Interfaces:

Response, UtilityReply

Direct Known Subclasses:

AapiServiceResponse, MultiServiceResponse

public class ServiceResponse
extends ScopedResource
implements Response, UtilityReply

A class that represents a service response resource, which is produced by the ServiceCallee-s when handling calls, and are delivered to the ServiceCaller-s as a result of their requests.

Author:

mtazari - Saied Tazari, Carsten Stockloew

Field Summary

Fields

Modifier and Type	Field and Description
static String	MY_URI A resource URI that specifies the resource as a service response.
static String	PROP_SERVICE_CALL_STATUS A property key for the property where the status of the call is stored.
static String	PROP_SERVICE_HAS_OUTPUT A property key for the property where the service outputs are stored.
static String	PROP_SERVICE_SPECIFIC_ERROR A property key for the property where any errors occurred during the service invocation are stored.
static String	PROP_UNBOUND_OUTPUT_ALLOWED A key of property indicating that not bound output is allowed.

Fields inherited from class org.universAAL.middleware.rdf.ScopedResource

ONLY_LOCAL_SCOPE, PROP_ORIG_SCOPE, PROP_SCOPES

Fields inherited from class org.universAAL.middleware.rdf.Resource

ANON_URI_PREFIX, blockAddingTypes, isXMLLiteral, NAMESPACE_PREFIX, ns_delim_index, PROP_INVOLVED_HUMAN_USER, PROP_RDF_FIRST, PROP_RDF_REST, PROP_RDF_TYPE, PROP_RDFS_COMMENT, PROP_RDFS_LABEL, PROP_SERIALIZATION_FULL, PROP_SERIALIZATION_OPTIONAL, PROP_SERIALIZATION_REDUCED, PROP_SERIALIZATION_UNDEFINED, props, RDF_EMPTY_LIST, RDF_NAMESPACE, RDFS_NAMESPACE, SERVICE_NAMESPACE, TYPE_RDF_LIST, TYPE_RDFS_CLASS, uri, VOCABULARY_NAMESPACE

Constructor Summary

Constructors

Constructor and Description
ServiceResponse() Default constructor for the class.
ServiceResponse(CallStatus status) Constructor which besides the URI, sets the status of the call.
ServiceResponse(String uri) Constructor for the class.

Method Summary

Modifier and Type	Method and Description
void	addOutput(ProcessOutput output) Adds output payload to this object.
void	addOutput(String uri, Object value) Adds output payload to this object.
protected void	allowUnboundOutput()
protected void	disallowUnboundOutput()
CallStatus	getCallStatus() Retrieves the call status.
List<Object>	getOutput(String paramURI) Returns all value objects returned for a required output with the given paramURI.
List	getOutput(String paramURI, boolean asMergedList) Deprecated. The parameter asMergedList is not used anymore since MultiServiceResponse was introduced. Use getOutput(String) instead.
List<ProcessOutput>	getOutputs() Retrieves all of the service outputs as a raw List without any rearranging.
Map<String,List<Object>>	getOutputsMap() Get all outputs.
Resource	getProvider() Get the provider of the requested service.
boolean	isUnboundOutputAllowed()
boolean	isWellFormed() Tests the object for correctness by verifying the presence of PROP_SERVICE_CALL_STATUS property.
boolean	setProperty(String propURI, Object value) This method inherits the superclass behavior, but performs some additional checks for correctness of the property values, specific for the ServiceResponse.

Methods inherited from class org.universAAL.middleware.rdf.ScopedResource

addScope, clearScopes, getOriginScope, getScopes, isScoped, isSerializableTo, setOriginScope, setScope

Methods inherited from class org.universAAL.middleware.rdf.FinalizedResource

addType, getLocalName, getNamespace, getProperty, getPropertyURIs, getType, getTypes, getURI, hasQualifiedName, isAnon, numberOfProperties

Methods inherited from class org.universAAL.middleware.rdf.Resource

addMultiLangProp, asList, asList, asRDFList, changeProperty, copy, deepCopy, equals, generateAnonURI, getDefaultLang, getFilename, getMultiLangProp, getOrConstructLabel, getOrConstructLabel, getPropSerializationType, getResource, getResourceComment, getResourceLabel, getResourceLabel, getStaticFieldValue, hashCode, hasProperty, isAnon, isBlockingAddingTypes, isClosedCollection, isQualifiedName, literal, representsQualifiedURI, serializesAsXMLLiteral, setPropertyPath, setPropertyPath, setPropertyPathFromOffset, setResourceComment, setResourceLabel, toString, toStringRecursive, toStringRecursive, unliteral

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MY_URI

public static final String MY_URI

A resource URI that specifies the resource as a service response.

See Also:

Constant Field Values

PROP_SERVICE_CALL_STATUS

public static final String PROP_SERVICE_CALL_STATUS

A property key for the property where the status of the call is stored.

See Also:

Constant Field Values

PROP_SERVICE_HAS_OUTPUT

public static final String PROP_SERVICE_HAS_OUTPUT

A property key for the property where the service outputs are stored. The service output is either a list of ProcessOutputs or a list of ServiceResponses in case of a MultiServiceResponse.

See Also:

Constant Field Values

PROP_SERVICE_SPECIFIC_ERROR

public static final String PROP_SERVICE_SPECIFIC_ERROR

A property key for the property where any errors occurred during the service invocation are stored.

See Also:

Constant Field Values

PROP_UNBOUND_OUTPUT_ALLOWED

public static final String PROP_UNBOUND_OUTPUT_ALLOWED

A key of property indicating that not bound output is allowed.

See Also:

Constant Field Values

Constructor Detail

ServiceResponse

public ServiceResponse()

Default constructor for the class. Only sets the class URI of the Resource to MY_URI.

ServiceResponse

public ServiceResponse(String uri)

Constructor for the class.

ServiceResponse

public ServiceResponse(CallStatus status)

Constructor which besides the URI, sets the status of the call.

Parameters:

status - the current status of the call.

Method Detail

allowUnboundOutput

protected void allowUnboundOutput()

disallowUnboundOutput

protected void disallowUnboundOutput()

isUnboundOutputAllowed

public boolean isUnboundOutputAllowed()

addOutput

public void addOutput(ProcessOutput output)

Adds output payload to this object. Keeps any output payload that was previously added.

Parameters:

output - the ouput that needs to be added.

addOutput

public void addOutput(String uri,
                      Object value)

Adds output payload to this object. Keeps any output payload that was previously added.

Parameters:

uri - the URI that identifies the output.

value - the output value.

getCallStatus

public CallStatus getCallStatus()

Retrieves the call status.

Returns:

the current call status.

getOutput

public List<Object> getOutput(String paramURI)

Returns all value objects returned for a required output with the given paramURI. Since the original request might have been responded by several different service components, the responses are merged and returned into one list. A return value of null indicates that there are no outputs in the response. If an empty list is returned by this method, it indicates that there are no output related to the given paramURI. Otherwise, the return value is always a list even if there is only one value object in that list.

Parameters:

paramURI - the URI of the required output.

Returns:

the output with the specified URI.

getOutput

@Deprecated
public List getOutput(String paramURI,
                                  boolean asMergedList)

Deprecated. The parameter asMergedList is not used anymore since MultiServiceResponse was introduced. Use getOutput(String) instead.

Returns all value objects returned for a required output with the given paramURI. Since the original request might have been responded by several different service components, asMergedList decides if those responses are returned separately or merged into one list. A return value of null indicates that there are no outputs in the response. If an empty list is returned by this method, it indicates that there are no output related to the given paramURI. Otherwise, the return value is always a list even if there is only one value object in that list.

Parameters:

paramURI - the URI of the required output.

asMergedList - specifies if the outputs of the separate services are merged. This parameter is not available at the moment and should be set to true

Returns:

the output with the specified URI.

getOutputsMap

public Map<String,List<Object>> getOutputsMap()

Get all outputs. This method is similar to getOutput(String) but instead of providing the output of one parameter, it provides the outputs of all parameters. The URI of the parameter is the key of the returned map.

Returns:

the non-null map of all outputs of the service.

getOutputs

public List<ProcessOutput> getOutputs()

Retrieves all of the service outputs as a raw List without any rearranging.

Returns:

the outputs that the invoked services produced. May be null. If this object is a MultiServiceResponse then the list can contain more than one ProcessOutput with the same URI; those outputs then come from different responses.

isWellFormed

public boolean isWellFormed()

Tests the object for correctness by verifying the presence of PROP_SERVICE_CALL_STATUS property.

Overrides:

isWellFormed in class Resource

See Also:

Resource.isWellFormed()

getProvider

public Resource getProvider()

Get the provider of the requested service. The provider is the URI of the bus member (the ServiceCallee).

Returns:

The URI of the service provider.

setProperty

public boolean setProperty(String propURI,
                           Object value)

This method inherits the superclass behavior, but performs some additional checks for correctness of the property values, specific for the ServiceResponse.

Overrides:

setProperty in class Resource

Returns:

true if the property changed as a result of the call

See Also:

Resource.setProperty(java.lang.String, java.lang.Object)