org.globus.ogsa
Interface ServiceProperties

All Known Subinterfaces:

GridServiceBase, NotificationSinkCallback, PersistentGridServiceBase

All Known Implementing Classes:

ChatPortTypePanel, GridServiceImpl, GridServicePortTypePanel, JMSAdapter.OGSAListener, NotificationSink, NotificationSinkPortTypePanel, NotificationTopicListener, OgsiLoggingPortTypePanel, PersistentGridServiceImpl, ServiceGroupEntryServiceDataPanel, ServicePropertiesImpl

public interface ServiceProperties

The ServiceProperties interface used to share properties between delegation layers. This interface also gives services access to the service specific configuration parameters provided in the deployment descriptor. Further, it also allows services to get service meta data set by the container. A ServiceProperties instance is typically associated with one service instance and can contain both transient data, as well as persistent data. Persistent properties can be checkpointed to the deployment descriptor using the flush() method.

Field Summary

static String	ACTIVATE_ON_STARTUP
static String	ACTIVATION
static String	BASE_CLASS_NAME
static String	BOOTSTRAP
static String	CONFIG_PATH
static String	CONTAINS_REFERENCE
static String	CREATION_EXTENSIBILITY Used to pass creation parameters via service properties to the newly created service instance.
static String	CREATION_EXTENSIBILITY_OUTPUT Used to pass extensibility output via service properties from the newly created service instance.
static String	CUSTOM_EXTENSIBILITY_DESERIALIZER
static String	CUSTOM_EXTENSIBILITY_SERIALIZER
static String	CUSTOM_MAPPING_REGISTERED
static String	DEACTIVATED_PERSISTENT
static String	DEACTIVATED_STATE This property is used to keep some service state in memory between service activation/deactivation.
static String	DEACTIVATED_TRANSIENT
static String	DEACTIVATION Used with DefaultServiceDeactivator lifecycle monitor class.
static String	DESTROY_LISTENER
static String	DESTRUCTION_SKELETON
static String	DISABLE_FACTORY_REGISTRY
static String	ENDPOINT
static String	ENTRY_INSTANCE_CREATION
static String	FACTORY
static String	FACTORY_CALLBACK
static String	FACTORY_HANDLE
static String	FACTORY_PROVIDER
static String	FACTORY_REGISTRY Deprecated.
static String	GSR_DESCRIPTION
static String	HANDLE
static String	HANDLE_PORT
static String	HANDLE_PROTOCOL
static String	INSTANCE_CLASS Deprecated.
static String	INSTANCE_DEACTIVATION See ServiceProperties.DEACTIVATION for details
static String	INSTANCE_GSR_DESCRIPTION
static String	INSTANCE_LIFECYCLE
static String	INSTANCE_PORT_TYPE
static String	INSTANCE_PORT_TYPE_NS
static String	INSTANCE_PREFIX
static String	INSTANCE_REGISTRY
static String	INSTANCE_SCHEMA_PATH
static String	INSTANCE_WSDL
static String	INTERFACE_CLASS_NAME
static String	INVOCATION_ID
static String	LAZY_CREATION
static String	LIFECYCLE
static String	LIFECYCLE_MONITOR
static String	LIFECYCLE_MONITOR_CLASS
static String	NAME
static String	NOTIFICATION_ENGINE
static String	NOTIFICATION_FACTORY
static String	NOTIFICATION_SOURCE
static String	OPERATION_PROVIDERS
static String	PERSISTENT
static String	PERSISTENT_PROPERTIES
static String	PORT
static String	PORT_TYPE
static String	PORT_TYPE_NS
static String	PRIMARY_KEY EJB use only.
static String	PROTOCOL
static String	QUERY_ENGINE
static String	REDIRECT_RESOLVER
static String	REGISTRY
static String	RESOLVER_CACHE
static String	ROUTER_HEADER
static String	ROUTER_VIA
static String	SCHEMA_LOCATION
static String	SCHEMA_PATH
static String	SERVICE_ACTIVATOR
static String	SERVICE_DATA
static String	SERVICE_DEPLOYMENT
static String	SERVICE_GROUP_ENTRY
static String	SERVICE_GROUP_PROVIDER
static String	SERVICE_LOADER
static String	SERVICE_NODE
static String	SERVICE_PATH
static String	SINK_ID
static String	STARTUP_STATE This property is used to get service state previously stored with DEACTIVATED_STATE property.
static String	SWEEP_SERVICE_DATA
static String	TIMEOUT
static String	TIMESTAMP
static String	TRANSIENT
static String	TYPE Deprecated.
static String	USER Deprecated.
static String	WEBSTART_PANEL_NAME
static String	WEBSTART_URL
static String	WSDL

Method Summary

void	flush() gives a hint that this property should be checkpointed to the deployment descriptor, it is however not guaranteed that the properties have been persisted when the method returns
Object	getPersistentProperty(String name) gets a persistent property (checkpointed to deployment descriptor) keyed by name
Object	getProperty(String name) gets a property keyed by name
void	setPersistentProperty(String name, Object obj) sets a persistent property (checkpointed to deployment descriptor) keyed by name
void	setProperty(String name, Object obj) sets a property keyed by name

Field Detail

INSTANCE_PREFIX

public static final String INSTANCE_PREFIX

See Also:

Constant Field Values

PORT

public static final String PORT

See Also:

Constant Field Values

CONFIG_PATH

public static final String CONFIG_PATH

See Also:

Constant Field Values

PROTOCOL

public static final String PROTOCOL

See Also:

Constant Field Values

FACTORY

public static final String FACTORY

See Also:

Constant Field Values

WSDL

public static final String WSDL

See Also:

Constant Field Values

INSTANCE_WSDL

public static final String INSTANCE_WSDL

See Also:

Constant Field Values

SCHEMA_LOCATION

public static final String SCHEMA_LOCATION

See Also:

Constant Field Values

HANDLE

public static final String HANDLE

See Also:

Constant Field Values

FACTORY_HANDLE

public static final String FACTORY_HANDLE

See Also:

Constant Field Values

ENDPOINT

public static final String ENDPOINT

See Also:

Constant Field Values

DESTRUCTION_SKELETON

public static final String DESTRUCTION_SKELETON

See Also:

Constant Field Values

TIMEOUT

public static final String TIMEOUT

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

SERVICE_DATA

public static final String SERVICE_DATA

See Also:

Constant Field Values

NOTIFICATION_SOURCE

public static final String NOTIFICATION_SOURCE

See Also:

Constant Field Values

GSR_DESCRIPTION

public static final String GSR_DESCRIPTION

See Also:

Constant Field Values

INSTANCE_GSR_DESCRIPTION

public static final String INSTANCE_GSR_DESCRIPTION

See Also:

Constant Field Values

PERSISTENT_PROPERTIES

public static final String PERSISTENT_PROPERTIES

See Also:

Constant Field Values

SERVICE_DEPLOYMENT

public static final String SERVICE_DEPLOYMENT

See Also:

Constant Field Values

DEACTIVATED_PERSISTENT

public static final String DEACTIVATED_PERSISTENT

See Also:

Constant Field Values

DEACTIVATED_TRANSIENT

public static final String DEACTIVATED_TRANSIENT

See Also:

Constant Field Values

SINK_ID

public static final String SINK_ID

See Also:

Constant Field Values

INVOCATION_ID

public static final String INVOCATION_ID

See Also:

Constant Field Values

ROUTER_HEADER

public static final String ROUTER_HEADER

See Also:

Constant Field Values

ROUTER_VIA

public static final String ROUTER_VIA

See Also:

Constant Field Values

CONTAINS_REFERENCE

public static final String CONTAINS_REFERENCE

See Also:

Constant Field Values

DEACTIVATED_STATE

public static final String DEACTIVATED_STATE

This property is used to keep some service state in memory between service activation/deactivation. The state stored in this service property will be available next time a service is activated. It works in conjunction with STARTUP_STATE property.

See Also:

Constant Field Values

STARTUP_STATE

public static final String STARTUP_STATE

This property is used to get service state previously stored with DEACTIVATED_STATE property. The service state can be retrieved from the MessageContext object embedded in the GridContext object available in activate or postCreate GridService callback methods.

See Also:

Constant Field Values

CUSTOM_EXTENSIBILITY_SERIALIZER

public static final String CUSTOM_EXTENSIBILITY_SERIALIZER

See Also:

Constant Field Values

CUSTOM_EXTENSIBILITY_DESERIALIZER

public static final String CUSTOM_EXTENSIBILITY_DESERIALIZER

See Also:

Constant Field Values

CUSTOM_MAPPING_REGISTERED

public static final String CUSTOM_MAPPING_REGISTERED

See Also:

Constant Field Values

TIMESTAMP

public static final String TIMESTAMP

See Also:

Constant Field Values

ACTIVATION

public static final String ACTIVATION

See Also:

Constant Field Values

LIFECYCLE_MONITOR

public static final String LIFECYCLE_MONITOR

See Also:

Constant Field Values

QUERY_ENGINE

public static final String QUERY_ENGINE

See Also:

Constant Field Values

NOTIFICATION_ENGINE

public static final String NOTIFICATION_ENGINE

See Also:

Constant Field Values

REDIRECT_RESOLVER

public static final String REDIRECT_RESOLVER

See Also:

Constant Field Values

DESTROY_LISTENER

public static final String DESTROY_LISTENER

See Also:

Constant Field Values

SERVICE_GROUP_PROVIDER

public static final String SERVICE_GROUP_PROVIDER

See Also:

Constant Field Values

SERVICE_GROUP_ENTRY

public static final String SERVICE_GROUP_ENTRY

See Also:

Constant Field Values

LAZY_CREATION

public static final String LAZY_CREATION

See Also:

Constant Field Values

FACTORY_PROVIDER

public static final String FACTORY_PROVIDER

See Also:

Constant Field Values

SCHEMA_PATH

public static final String SCHEMA_PATH

See Also:

Constant Field Values

INSTANCE_SCHEMA_PATH

public static final String INSTANCE_SCHEMA_PATH

See Also:

Constant Field Values

LIFECYCLE

public static final String LIFECYCLE

See Also:

Constant Field Values

INSTANCE_LIFECYCLE

public static final String INSTANCE_LIFECYCLE

See Also:

Constant Field Values

SERVICE_PATH

public static final String SERVICE_PATH

See Also:

Constant Field Values

SERVICE_NODE

public static final String SERVICE_NODE

See Also:

Constant Field Values

REGISTRY

public static final String REGISTRY

See Also:

Constant Field Values

INSTANCE_REGISTRY

public static final String INSTANCE_REGISTRY

See Also:

Constant Field Values

HANDLE_PROTOCOL

public static final String HANDLE_PROTOCOL

See Also:

Constant Field Values

HANDLE_PORT

public static final String HANDLE_PORT

See Also:

Constant Field Values

PORT_TYPE

public static final String PORT_TYPE

See Also:

Constant Field Values

INSTANCE_PORT_TYPE

public static final String INSTANCE_PORT_TYPE

See Also:

Constant Field Values

PORT_TYPE_NS

public static final String PORT_TYPE_NS

See Also:

Constant Field Values

INSTANCE_PORT_TYPE_NS

public static final String INSTANCE_PORT_TYPE_NS

See Also:

Constant Field Values

WEBSTART_URL

public static final String WEBSTART_URL

See Also:

Constant Field Values

WEBSTART_PANEL_NAME

public static final String WEBSTART_PANEL_NAME

See Also:

Constant Field Values

SERVICE_ACTIVATOR

public static final String SERVICE_ACTIVATOR

See Also:

Constant Field Values

SERVICE_LOADER

public static final String SERVICE_LOADER

See Also:

Constant Field Values

NOTIFICATION_FACTORY

public static final String NOTIFICATION_FACTORY

See Also:

Constant Field Values

ACTIVATE_ON_STARTUP

public static final String ACTIVATE_ON_STARTUP

See Also:

Constant Field Values

BOOTSTRAP

public static final String BOOTSTRAP

See Also:

Constant Field Values

PRIMARY_KEY

public static final String PRIMARY_KEY

EJB use only.

See Also:

Constant Field Values

PERSISTENT

public static final String PERSISTENT

See Also:

Constant Field Values

TRANSIENT

public static final String TRANSIENT

See Also:

Constant Field Values

DEACTIVATION

public static final String DEACTIVATION

Used with DefaultServiceDeactivator lifecycle monitor class. It indicates the idle time of the service before it gets deactivated. It is specified in milliseconds. Value can be of either String or Long type.

See Also:

Constant Field Values

INSTANCE_DEACTIVATION

public static final String INSTANCE_DEACTIVATION

See ServiceProperties.DEACTIVATION for details

See Also:

Constant Field Values

LIFECYCLE_MONITOR_CLASS

public static final String LIFECYCLE_MONITOR_CLASS

See Also:

Constant Field Values

RESOLVER_CACHE

public static final String RESOLVER_CACHE

See Also:

Constant Field Values

FACTORY_CALLBACK

public static final String FACTORY_CALLBACK

See Also:

Constant Field Values

OPERATION_PROVIDERS

public static final String OPERATION_PROVIDERS

See Also:

Constant Field Values

INTERFACE_CLASS_NAME

public static final String INTERFACE_CLASS_NAME

See Also:

Constant Field Values

BASE_CLASS_NAME

public static final String BASE_CLASS_NAME

See Also:

Constant Field Values

SWEEP_SERVICE_DATA

public static final String SWEEP_SERVICE_DATA

See Also:

Constant Field Values

ENTRY_INSTANCE_CREATION

public static final String ENTRY_INSTANCE_CREATION

See Also:

Constant Field Values

DISABLE_FACTORY_REGISTRY

public static final String DISABLE_FACTORY_REGISTRY

See Also:

Constant Field Values

USER

public static final String USER

Deprecated.

See Also:

Constant Field Values

FACTORY_REGISTRY

public static final String FACTORY_REGISTRY

Deprecated.

See Also:

Constant Field Values

INSTANCE_CLASS

public static final String INSTANCE_CLASS

Deprecated.

See Also:

Constant Field Values

TYPE

public static final String TYPE

Deprecated.

See Also:

Constant Field Values

CREATION_EXTENSIBILITY

public static final String CREATION_EXTENSIBILITY

Used to pass creation parameters via service properties to the newly created service instance. Only set when using DynamicFactoryCallbackImpl

See Also:

Constant Field Values

CREATION_EXTENSIBILITY_OUTPUT

public static final String CREATION_EXTENSIBILITY_OUTPUT

Used to pass extensibility output via service properties from the newly created service instance. Only set when using DynamicFactoryCallbackImpl

See Also:

Constant Field Values

Method Detail

getProperty

public Object getProperty(String name)

gets a property keyed by name

Parameters:

name - property key

Returns:

property value or null

setProperty

public void setProperty(String name,
                        Object obj)

sets a property keyed by name

Parameters:

name - property key

obj - property value, if null the property will be removed (if it exists)

getPersistentProperty

public Object getPersistentProperty(String name)

gets a persistent property (checkpointed to deployment descriptor) keyed by name

Parameters:

name - property key

Returns:

property value or null

setPersistentProperty

public void setPersistentProperty(String name,
                                  Object obj)

sets a persistent property (checkpointed to deployment descriptor) keyed by name

Parameters:

name - property key

obj - property value, if null the property will be removed (if it exists)

flush

public void flush()
           throws ServicePropertiesException

gives a hint that this property should be checkpointed to the deployment descriptor, it is however not guaranteed that the properties have been persisted when the method returns

Throws:

ServicePropertiesException - if the properties could not be persisted