Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-02

weblogic.management.configuration
Interface WebServiceLogicalStoreMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface WebServiceLogicalStoreMBean
extends ConfigurationMBean

Represents a logical store for web services.


Field Summary
static String IN_MEMORY
          Any state stored will be in-memory only, and will be accessible only from the local VM.
static String LOCAL_ACCESS_ONLY
          Any state stored will be accessible only from the local machine/server.
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 String getCleanerInterval()
          Get the interval at which the persistent store will be cleaned
 String getDefaultMaximumObjectLifetime()
          Get the default max time an object can remain in the store.
 String getName()
          Get the name of this logical store.
 String getPersistenceStrategy()
          Get the persistence strategy in use by this logical store.
 String getPhysicalStoreName()
          Get the name of the physical store to be used by this logical store.
 String getRequestBufferingQueueJndiName()
          Get the JNDI name of the buffering queue that web services should use.
 String getResponseBufferingQueueJndiName()
          Get the JNDI name of the response buffering queue that web services should use.
 void setCleanerInterval(String interval)
          Set the interval at which the persistent store will be cleaned
 void setDefaultMaximumObjectLifetime(String duration)
          Set the default max time an object can remain in the store.
 void setName(String name)
          Set the name of this logical store to a new name.
 void setPersistenceStrategy(String strategy)
          Set the persistence strategy to use for this logical store.
 void setPhysicalStoreName(String storeName)
          Set the name of the physical store to be used by this logical store.
 void setRequestBufferingQueueJndiName(String jndiName)
          Set the JNDI name of the buffering queue that web services should use.
 void setResponseBufferingQueueJndiName(String jndiName)
          Set the JNDI name of the response buffering queue that web services should use.
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setNotes, setPersistenceEnabled, unSet
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent
 
Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes
 
Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 
Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 
Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
 

Field Detail

LOCAL_ACCESS_ONLY

static final String LOCAL_ACCESS_ONLY
Any state stored will be accessible only from the local machine/server. Any physical store associated with this logical store must be a WLS store.

See Also:
Constant Field Values

IN_MEMORY

static final String IN_MEMORY
Any state stored will be in-memory only, and will be accessible only from the local VM. Using this strategy causes any buffering queue or physical store names configured on this logical store to be ignored.

See Also:
Constant Field Values
Method Detail

getName

String getName()
Get the name of this logical store.

Specified by:
getName in interface ConfigurationMBean
Specified by:
getName in interface WebLogicMBean

setName

void setName(String name)
             throws InvalidAttributeValueException,
                    ManagementException
Set the name of this logical store to a new name.

Specified by:
setName in interface ConfigurationMBean
Parameters:
name - New name to give the logical store. If this store is the default logical store for this server, you must also change the name given in WebServicePersistenceMBean.getDefaultLogicalStoreName.
Throws:
InvalidAttributeValueException
ManagementException

getPersistenceStrategy

String getPersistenceStrategy()
Get the persistence strategy in use by this logical store. Any physical store configured for use with this logical store should support this strategy.

Default Value:
WebServiceLogicalStoreMBean.LOCAL_ACCESS_ONLY
Valid Values:
WebServiceLogicalStoreMBean.LOCAL_ACCESS_ONLY, WebServiceLogicalStoreMBean.IN_MEMORY

setPersistenceStrategy

void setPersistenceStrategy(String strategy)
Set the persistence strategy to use for this logical store. Any physical store configured for use with this logical store should support this strategy.


setCleanerInterval

void setCleanerInterval(String interval)
Set the interval at which the persistent store will be cleaned

Parameters:
interval - Interval of time in javax.xml.datatype.Duration format

getCleanerInterval

String getCleanerInterval()
Get the interval at which the persistent store will be cleaned

Returns:
Interval of time in javax.xml.datatype.Duration format. Defaults to PT10M 10 minutes), and will never be returned null.
Default Value:
"PT10M"

setDefaultMaximumObjectLifetime

void setDefaultMaximumObjectLifetime(String duration)
Set the default max time an object can remain in the store. This can be overridden on individual objects placed in the store (internally, but not via this API).

Parameters:
duration - Time duration in javax.xml.datatype.Duration format

getDefaultMaximumObjectLifetime

String getDefaultMaximumObjectLifetime()
Get the default max time an object can remain in the store. This can be overridden on individual objects placed in the store (internally, but not via this API).

Returns:
duration Time duration in javax.xml.datatype.Duration format. Defaults to P1D (1 day). This value will never be returned null.
Default Value:
"P1D"

setRequestBufferingQueueJndiName

void setRequestBufferingQueueJndiName(String jndiName)
Set the JNDI name of the buffering queue that web services should use. Web services used this queue both to hold buffered messages when required but also to find the physical store for this logical store. Use of buffering queue JNDI name is the preferred method of indicating the physical store as this makes it easier for customers to meet the recommendation that all WSEE storage matches the storage used by the buffering queue (and thus allows for single-resource transactions at runtime). This setting takes precedence over any physical store name set using setPhysicalStoreName.

This property is ignored if persistence strategy is IN_MEMORY.

See Also:
WebServiceLogicalStoreMBean.setPhysicalStoreName(java.lang.String)

getRequestBufferingQueueJndiName

String getRequestBufferingQueueJndiName()
Get the JNDI name of the buffering queue that web services should use. (Both for buffering and to find the physical store for this logical store). Defaults to "" to indicate the PhysicalStoreName property should be used.

This property is ignored if persistence strategy is IN_MEMORY.

See Also:
WebServiceLogicalStoreMBean.setRequestBufferingQueueJndiName(String)
Default Value:
""

setResponseBufferingQueueJndiName

void setResponseBufferingQueueJndiName(String jndiName)
Set the JNDI name of the response buffering queue that web services should use. If this is null, web services will use any queue configured for request buffering.

See Also:
WebServiceLogicalStoreMBean.setRequestBufferingQueueJndiName(String)

getResponseBufferingQueueJndiName

String getResponseBufferingQueueJndiName()
Get the JNDI name of the response buffering queue that web services should use. If this is null, the request buffering queue is used.

See Also:
WebServiceLogicalStoreMBean.getRequestBufferingQueueJndiName()

setPhysicalStoreName

void setPhysicalStoreName(String storeName)
Set the name of the physical store to be used by this logical store. This property is recommended for use only when running off server or in other cases where a buffering queue JNDI name cannot be set via setBufferingQueueJndiName. If a buffering queue JNDI name is set to a non-null/non-empty value, this property is ignored.

This property is ignored if persistence strategy is IN_MEMORY.

Parameters:
storeName - Name of a valid physical store, as configured via the WebLogic Server admin console, WLST, or other mechanism.
See Also:
WebServiceLogicalStoreMBean.setRequestBufferingQueueJndiName(String)

getPhysicalStoreName

String getPhysicalStoreName()
Get the name of the physical store to be used by this logical store. This property is recommended for use only when running off server or in other cases where a buffering queue JNDI name cannot be set via setBufferingQueueJndiName. If a buffering queue JNDI name is set to a non-null/non-empty value, this property is ignored. Defaults to "" to indicate the default WLS file store should be used.

This property is ignored if persistence strategy is IN_MEMORY.

See Also:
WebServiceLogicalStoreMBean.setRequestBufferingQueueJndiName(String)
Default Value:
""

Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.2)

Part Number E27170-02