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

Field Detail

INSTANCE_PREFIX

public static final java.lang.String INSTANCE_PREFIX
See Also:
Constant Field Values

PORT

public static final java.lang.String PORT
See Also:
Constant Field Values

CONFIG_PATH

public static final java.lang.String CONFIG_PATH
See Also:
Constant Field Values

PROTOCOL

public static final java.lang.String PROTOCOL
See Also:
Constant Field Values

FACTORY

public static final java.lang.String FACTORY
See Also:
Constant Field Values

WSDL

public static final java.lang.String WSDL
See Also:
Constant Field Values

INSTANCE_WSDL

public static final java.lang.String INSTANCE_WSDL
See Also:
Constant Field Values

SCHEMA_LOCATION

public static final java.lang.String SCHEMA_LOCATION
See Also:
Constant Field Values

HANDLE

public static final java.lang.String HANDLE
See Also:
Constant Field Values

FACTORY_HANDLE

public static final java.lang.String FACTORY_HANDLE
See Also:
Constant Field Values

ENDPOINT

public static final java.lang.String ENDPOINT
See Also:
Constant Field Values

DESTRUCTION_SKELETON

public static final java.lang.String DESTRUCTION_SKELETON
See Also:
Constant Field Values

TIMEOUT

public static final java.lang.String TIMEOUT
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values

SERVICE_DATA

public static final java.lang.String SERVICE_DATA
See Also:
Constant Field Values

NOTIFICATION_SOURCE

public static final java.lang.String NOTIFICATION_SOURCE
See Also:
Constant Field Values

GSR_DESCRIPTION

public static final java.lang.String GSR_DESCRIPTION
See Also:
Constant Field Values

INSTANCE_GSR_DESCRIPTION

public static final java.lang.String INSTANCE_GSR_DESCRIPTION
See Also:
Constant Field Values

PERSISTENT_PROPERTIES

public static final java.lang.String PERSISTENT_PROPERTIES
See Also:
Constant Field Values

SERVICE_DEPLOYMENT

public static final java.lang.String SERVICE_DEPLOYMENT
See Also:
Constant Field Values

DEACTIVATED_PERSISTENT

public static final java.lang.String DEACTIVATED_PERSISTENT
See Also:
Constant Field Values

DEACTIVATED_TRANSIENT

public static final java.lang.String DEACTIVATED_TRANSIENT
See Also:
Constant Field Values

SINK_ID

public static final java.lang.String SINK_ID
See Also:
Constant Field Values

INVOCATION_ID

public static final java.lang.String INVOCATION_ID
See Also:
Constant Field Values

ROUTER_HEADER

public static final java.lang.String ROUTER_HEADER
See Also:
Constant Field Values

ROUTER_VIA

public static final java.lang.String ROUTER_VIA
See Also:
Constant Field Values

CONTAINS_REFERENCE

public static final java.lang.String CONTAINS_REFERENCE
See Also:
Constant Field Values

DEACTIVATED_STATE

public static final java.lang.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 java.lang.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 java.lang.String CUSTOM_EXTENSIBILITY_SERIALIZER
See Also:
Constant Field Values

CUSTOM_EXTENSIBILITY_DESERIALIZER

public static final java.lang.String CUSTOM_EXTENSIBILITY_DESERIALIZER
See Also:
Constant Field Values

CUSTOM_MAPPING_REGISTERED

public static final java.lang.String CUSTOM_MAPPING_REGISTERED
See Also:
Constant Field Values

TIMESTAMP

public static final java.lang.String TIMESTAMP
See Also:
Constant Field Values

ACTIVATION

public static final java.lang.String ACTIVATION
See Also:
Constant Field Values

LIFECYCLE_MONITOR

public static final java.lang.String LIFECYCLE_MONITOR
See Also:
Constant Field Values

QUERY_ENGINE

public static final java.lang.String QUERY_ENGINE
See Also:
Constant Field Values

NOTIFICATION_ENGINE

public static final java.lang.String NOTIFICATION_ENGINE
See Also:
Constant Field Values

REDIRECT_RESOLVER

public static final java.lang.String REDIRECT_RESOLVER
See Also:
Constant Field Values

DESTROY_LISTENER

public static final java.lang.String DESTROY_LISTENER
See Also:
Constant Field Values

SERVICE_GROUP_PROVIDER

public static final java.lang.String SERVICE_GROUP_PROVIDER
See Also:
Constant Field Values

SERVICE_GROUP_ENTRY

public static final java.lang.String SERVICE_GROUP_ENTRY
See Also:
Constant Field Values

LAZY_CREATION

public static final java.lang.String LAZY_CREATION
See Also:
Constant Field Values

FACTORY_PROVIDER

public static final java.lang.String FACTORY_PROVIDER
See Also:
Constant Field Values

SCHEMA_PATH

public static final java.lang.String SCHEMA_PATH
See Also:
Constant Field Values

INSTANCE_SCHEMA_PATH

public static final java.lang.String INSTANCE_SCHEMA_PATH
See Also:
Constant Field Values

LIFECYCLE

public static final java.lang.String LIFECYCLE
See Also:
Constant Field Values

INSTANCE_LIFECYCLE

public static final java.lang.String INSTANCE_LIFECYCLE
See Also:
Constant Field Values

SERVICE_PATH

public static final java.lang.String SERVICE_PATH
See Also:
Constant Field Values

SERVICE_NODE

public static final java.lang.String SERVICE_NODE
See Also:
Constant Field Values

REGISTRY

public static final java.lang.String REGISTRY
See Also:
Constant Field Values

INSTANCE_REGISTRY

public static final java.lang.String INSTANCE_REGISTRY
See Also:
Constant Field Values

HANDLE_PROTOCOL

public static final java.lang.String HANDLE_PROTOCOL
See Also:
Constant Field Values

HANDLE_PORT

public static final java.lang.String HANDLE_PORT
See Also:
Constant Field Values

PORT_TYPE

public static final java.lang.String PORT_TYPE
See Also:
Constant Field Values

INSTANCE_PORT_TYPE

public static final java.lang.String INSTANCE_PORT_TYPE
See Also:
Constant Field Values

PORT_TYPE_NS

public static final java.lang.String PORT_TYPE_NS
See Also:
Constant Field Values

INSTANCE_PORT_TYPE_NS

public static final java.lang.String INSTANCE_PORT_TYPE_NS
See Also:
Constant Field Values

WEBSTART_URL

public static final java.lang.String WEBSTART_URL
See Also:
Constant Field Values

WEBSTART_PANEL_NAME

public static final java.lang.String WEBSTART_PANEL_NAME
See Also:
Constant Field Values

SERVICE_ACTIVATOR

public static final java.lang.String SERVICE_ACTIVATOR
See Also:
Constant Field Values

SERVICE_LOADER

public static final java.lang.String SERVICE_LOADER
See Also:
Constant Field Values

NOTIFICATION_FACTORY

public static final java.lang.String NOTIFICATION_FACTORY
See Also:
Constant Field Values

ACTIVATE_ON_STARTUP

public static final java.lang.String ACTIVATE_ON_STARTUP
See Also:
Constant Field Values

BOOTSTRAP

public static final java.lang.String BOOTSTRAP
See Also:
Constant Field Values

PRIMARY_KEY

public static final java.lang.String PRIMARY_KEY
EJB use only.

See Also:
Constant Field Values

PERSISTENT

public static final java.lang.String PERSISTENT
See Also:
Constant Field Values

TRANSIENT

public static final java.lang.String TRANSIENT
See Also:
Constant Field Values

DEACTIVATION

public static final java.lang.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 java.lang.String INSTANCE_DEACTIVATION
See ServiceProperties.DEACTIVATION for details

See Also:
Constant Field Values

LIFECYCLE_MONITOR_CLASS

public static final java.lang.String LIFECYCLE_MONITOR_CLASS
See Also:
Constant Field Values

RESOLVER_CACHE

public static final java.lang.String RESOLVER_CACHE
See Also:
Constant Field Values

FACTORY_CALLBACK

public static final java.lang.String FACTORY_CALLBACK
See Also:
Constant Field Values

OPERATION_PROVIDERS

public static final java.lang.String OPERATION_PROVIDERS
See Also:
Constant Field Values

INTERFACE_CLASS_NAME

public static final java.lang.String INTERFACE_CLASS_NAME
See Also:
Constant Field Values

BASE_CLASS_NAME

public static final java.lang.String BASE_CLASS_NAME
See Also:
Constant Field Values

SWEEP_SERVICE_DATA

public static final java.lang.String SWEEP_SERVICE_DATA
See Also:
Constant Field Values

ENTRY_INSTANCE_CREATION

public static final java.lang.String ENTRY_INSTANCE_CREATION
See Also:
Constant Field Values

DISABLE_FACTORY_REGISTRY

public static final java.lang.String DISABLE_FACTORY_REGISTRY
See Also:
Constant Field Values

USER

public static final java.lang.String USER
Deprecated.  

See Also:
Constant Field Values

FACTORY_REGISTRY

public static final java.lang.String FACTORY_REGISTRY
Deprecated.  

See Also:
Constant Field Values

INSTANCE_CLASS

public static final java.lang.String INSTANCE_CLASS
Deprecated.  

See Also:
Constant Field Values

TYPE

public static final java.lang.String TYPE
Deprecated.  

See Also:
Constant Field Values

CREATION_EXTENSIBILITY

public static final java.lang.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 java.lang.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 java.lang.Object getProperty(java.lang.String name)
gets a property keyed by name

Parameters:
name - property key
Returns:
property value or null

setProperty

public void setProperty(java.lang.String name,
                        java.lang.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 java.lang.Object getPersistentProperty(java.lang.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(java.lang.String name,
                                  java.lang.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


Copyright ? 1999 University of Chicago and The University of Southern California. All Rights Reserved.