org.universAAL.middleware.rdf

Class ScopedResource

java.lang.Object

org.universAAL.middleware.rdf.Resource

org.universAAL.middleware.rdf.FinalizedResource

org.universAAL.middleware.rdf.ScopedResource

Direct Known Subclasses:

ContextEvent, ServiceCall, ServiceRequest, ServiceResponse, UIRequest, UIResponse

public class ScopedResource
extends FinalizedResource

A ScopedResource is a Resource that may have been generated at, or be sent to, another Space. Thus it can be annotated with one or more Scopes (a.k.a tenant ID, origin Space ID).

Author:

amedrano, Carsten Stockloew

Field Summary

Fields

Modifier and Type	Field and Description
static String	ONLY_LOCAL_SCOPE A special scope indicating the Resource may not be serialized to other Spaces.
static String	PROP_ORIG_SCOPE The property URI for holding the Origin Scope.
static String	PROP_SCOPES The property URI for holding the Destination 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
ScopedResource()
ScopedResource(boolean isXMLLiteral)
ScopedResource(String uri)
ScopedResource(String uri, boolean isXMLLiteral)
ScopedResource(String uriPrefix, int numProps)

Method Summary

Modifier and Type	Method and Description
boolean	addScope(String newScope) Add a new scope to this resource.
boolean	clearScopes() Remove all scope annotations from this resource.
String	getOriginScope() Get the Scope of the original Space sender of this ScopedResource.
List	getScopes() List all scopes associated to this resource.
boolean	isScoped() Check if there is any scopes for this resource.
boolean	isSerializableTo(String destinationCandidateScope) Check whether if this ScopedResource may be sent to a destination scope Deny if the origin is the destination candidate (this will cause message loops) Deny if the destinations do contain ONLY_LOCAL_SCOPE (tenant-aware application has decided this message is only local) Deny if the destinations are not empty and do not contain the candidate destination Allow if the destinations are empty (non-tenant-aware application has generated the message) Allow if the destinations are not empty and contains the candidate destination.
void	setOriginScope(String scope) Set the Origin Scope of an incoming ScopedResource.
boolean	setScope(ScopedResource src) Copy the scope from another ScopedResource.

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, isWellFormed, literal, representsQualifiedURI, serializesAsXMLLiteral, setProperty, 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

PROP_SCOPES

public static final String PROP_SCOPES

The property URI for holding the Destination Scopes.

See Also:

Constant Field Values

PROP_ORIG_SCOPE

public static final String PROP_ORIG_SCOPE

The property URI for holding the Origin Scope. This property is to be used directly by Resource.getProperty(String) and Resource.setProperty(String, Object), only by the router artifacts.

See Also:

Constant Field Values

ONLY_LOCAL_SCOPE

public static final String ONLY_LOCAL_SCOPE

A special scope indicating the Resource may not be serialized to other Spaces.

See Also:

Constant Field Values

Constructor Detail

ScopedResource

public ScopedResource()

ScopedResource

public ScopedResource(boolean isXMLLiteral)

ScopedResource

public ScopedResource(String uri)

ScopedResource

public ScopedResource(String uri,
                      boolean isXMLLiteral)

ScopedResource

public ScopedResource(String uriPrefix,
                      int numProps)

Method Detail

isScoped

public boolean isScoped()

Check if there is any scopes for this resource. This includes ONLY_LOCAL_SCOPE.

Returns:

true if there is one or more scopes annotated for this resource.

getScopes

public final List getScopes()

List all scopes associated to this resource.

Returns:

always a list, empty if there are no scopes.

addScope

public final boolean addScope(String newScope)

Add a new scope to this resource.

Parameters:

newScope - the new scope to be added

Returns:

whether the change was successful or not.

clearScopes

public final boolean clearScopes()

Remove all scope annotations from this resource. If the Resource is being sent and the scopes are cleared it is assumed that it has to be sent to all available Scopes.

Returns:

iff the scopes have been cleared.

setScope

public final boolean setScope(ScopedResource src)

Copy the scope from another ScopedResource.

Parameters:

src - the source from which to copy the scope.

Returns:

whether the change was successful or not.

isSerializableTo

public final boolean isSerializableTo(String destinationCandidateScope)

Check whether if this ScopedResource may be sent to a destination scope

• Deny if the origin is the destination candidate (this will cause message loops)
• Deny if the destinations do contain ONLY_LOCAL_SCOPE (tenant-aware application has decided this message is only local)
• Deny if the destinations are not empty and do not contain the candidate destination
• Allow if the destinations are empty (non-tenant-aware application has generated the message)
• Allow if the destinations are not empty and contains the candidate destination.

Parameters:

destinationCandidateScope - The destination to be checked, If null returns false.

Returns:

true iff it may be sent according to origin / destination restrictions.

getOriginScope

public final String getOriginScope()

Get the Scope of the original Space sender of this ScopedResource. To be used only by Gateways!

Returns:

The scoped assiged usig setOriginScope(String).

setOriginScope

public final void setOriginScope(String scope)

Set the Origin Scope of an incoming ScopedResource. To be used by Gateways! To reset, use with scope = null.

Parameters:

scope - The Scope ID.