org.gcube.common.core.scope
Interface GCUBEScopeManager

All Known Implementing Classes:

GCUBEScopeManagerImpl, GCUBEServiceContext

public interface GCUBEScopeManager

The interface of managers of scope information within service implementations.

Author:

Fabio Simeoni (University of Strathclyde)

Nested Class Summary

static class

GCUBEScopeManager.IllegalScopeException

Field Summary

static String	CLASS_HEADER_NAME Name of the service class call header.
static GCUBEScopeManager	DEFAULT Deprecated. as to 1.5.1, use ScopeProvider.instance instead.
static String	NAME_HEADER_NAME Name of the service name call header.
static String	SCOPE_HEADER_NAME Name of the scope call header.
static String	SCOPE_NS Namespace of scope-related headers

Method Summary

GCUBEScope	getScope() Gets the scope for outgoing calls in the current thread.
void	prepareCall(Remote remote, String clazz, String name, GCUBEScope... scope) Sets the scope for an outgoing call to a target gCube service.
void	setScope(GCUBEScope scope) Sets the scope of outgoing calls in the current thread.
void	setScope(Thread thread, GCUBEScope... scope) Deprecated. as to 1.5.1 refactor in term of ScopeProvider.instance

Field Detail

DEFAULT

static final GCUBEScopeManager DEFAULT

Deprecated. as to 1.5.1, use ScopeProvider.instance instead.

Shared GCUBEScopeManager

CLASS_HEADER_NAME

static final String CLASS_HEADER_NAME

Name of the service class call header.

See Also:

Constant Field Values

NAME_HEADER_NAME

static final String NAME_HEADER_NAME

Name of the service name call header.

See Also:

Constant Field Values

SCOPE_HEADER_NAME

static final String SCOPE_HEADER_NAME

Name of the scope call header.

See Also:

Constant Field Values

SCOPE_NS

static final String SCOPE_NS

Namespace of scope-related headers

See Also:

Constant Field Values

Method Detail

setScope

void setScope(GCUBEScope scope)
              throws GCUBEScopeManager.IllegalScopeException

Sets the scope of outgoing calls in the current thread.

Parameters:

scope - the scope.

Throws:

GCUBEScopeManager.IllegalScopeException

setScope

@Deprecated
void setScope(Thread thread,
                         GCUBEScope... scope)

Deprecated. as to 1.5.1 refactor in term of ScopeProvider.instance

Sets the scope of outgoing calls in a given thread.

Parameters:

thread - the thread.

scope - (optional) the scope. If omitted, it defaults to the scope of the current thread.

getScope

GCUBEScope getScope()

Gets the scope for outgoing calls in the current thread.

Returns:

the scope;

prepareCall

void prepareCall(Remote remote,
                 String clazz,
                 String name,
                 GCUBEScope... scope)

Sets the scope for an outgoing call to a target gCube service.

Parameters:

remote - the stub of the target port-type.

clazz - the gCube class of the target service.

name - the gCube name of the target service.

scope - (optional) the scope of the call. If omitted, the scope associated with the current thread will be used.

See Also:

GCUBERemotePortTypeContext.getProxy(Remote, org.gcube.common.core.contexts.GCUBEServiceContext), GCUBERemotePortTypeContext.getProxy(Remote, GCUBEScope, org.gcube.common.core.security.GCUBESecurityManager...), GCUBERemotePortTypeContext.getProxy(Remote, GCUBEScopeManager, org.gcube.common.core.security.GCUBESecurityManager...)