|
BEA Systems, Inc. | |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Encapsulates the timestamp information that is associated with a Web Service security configuration.
This is a type-safe interface for a
WebLogic Server MBean, which you can import into your client
classes and access through
weblogic.management.MBeanHome
. As of 9.0, the
MBeanHome
interface and all type-safe interfaces for
WebLogic Server MBeans are deprecated. Instead, client classes that
interact with WebLogic Server MBeans should use standard JMX design
patterns in which clients use the
javax.management.MBeanServerConnection
interface to
discover MBeans, attributes, and attribute types at runtime. For
more information, see "Developing Manageable Applications with JMX"
on http://edocs.bea.com.
Field Summary |
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean |
DEFAULT_EMPTY_BYTE_ARRAY |
Method Summary | |
long |
getClockPrecision()
If clocks are synchronized, this attribute describes the accuracy of the synchronization. |
long |
getMaxProcessingDelay()
Specifies the freshness policy for received messages: the Web Serivce observes the processing delay by subtracting the Created time in the Timestamp from the current time. |
int |
getValidityPeriod()
Represents the length of time the sender wants the outbound message to be valid. |
boolean |
isClockSynchronized()
Specifies whether the Web Service assumes synchronized clocks. |
boolean |
isLaxPrecision()
This attribute allows you to relax the enforcement of clockPrecision. |
void |
setClockPrecision(long clockPrecision)
Sets the value of the ClockPrecision attribute. |
void |
setClockSynchronized(boolean b)
Sets the value of the ClockSynchronized attribute. |
void |
setLaxPrecision(boolean b)
Sets the value of the LaxPrecision attribute. |
void |
setMaxProcessingDelay(long maxProcessingDelay)
Sets the value of the maxProcessingDelay attribute. |
void |
setValidityPeriod(int validityPeriod)
Sets the value of the ValidityPeriod attribute. |
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean |
freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, 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 |
addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener |
Method Detail |
public long getClockPrecision()
If clocks are synchronized, this attribute describes the accuracy of the synchronization.
ClockPrecision is expressed in milliseconds. Clock precision is enforced by rendering all times into milliseconds since a common time 0 and dividing each time by clockPrecision. Comparisons for the purpose of policy enforcement are performed using the rounded times. This provides a mechanism for allowing for some reasonable level of clockskew. For example, if you're clocks are accurate to within 1 minute of each other, you would set your precision to 1 minute * 60 seconds * 1000 milliseconds or 60000. All times would be rounded to the nearest minute before comparison.
One significant side effect of setting clockPrecision to indicate low accuracy is that expiration periods smaller than clock precision cannot be enforced safely. As a result, if the expiration period of message is shorter than can be resolved given the system's clock precision, the message will be rejected as expired -- the only safe assumption. For example, assume your are accurate to within 1 minute of each other. If you received a message with an Expires time 10 seconds after the Created time, its clear that you would not reliably be able to enforce such an expiry -- after rounding, the Expires time is indistinguishable from the Created time. In these cases, the handler will reject the message. This behavior can be relaxed using the laxPrecision value described below.
public long getMaxProcessingDelay()
Specifies the freshness policy for received messages: the Web Serivce observes the processing delay by subtracting the Created time in the Timestamp from the current time.
If the observed processing delay is greater than maxProcessingDelay, the message is rejected as stale.
This attribute is specified in milliseconds, and is adjusted to reflect clockPrecision prior to enforcement. maxProcessingDelays smaller than clockPrecision are unenforceable and therefore rejected.
Setting maxProcessingDelay to NO_MAX_PROCESSING_DELAY disables to enforcement of the freshenss policy.
public int getValidityPeriod()
Represents the length of time the sender wants the outbound message to be valid.
When the validityPeriod is positive, the TimestampHandler inserts an Expires element into the Timestamp header. The validityPeriod is expressed in seconds: the Expires time will be that many seconds ahead of the Timestamp's Created time.
public boolean isClockSynchronized()
Specifies whether the Web Service assumes synchronized clocks.
If the clockSynchronized attribute is false, the Web Service rejects all inbound messages with that contain expirations, because this is the only safe way to ensure that the message hasn't already expired. In this case, the Web Service also does not enforce a freshness policy.
If this attribute is set to true, then the Web Service enforces expirations on inbound messages to the best of its ability and enforces an optional freshness policy (via maxProcessingDelay).
The default value of this attribute is true.
public boolean isLaxPrecision()
This attribute allows you to relax the enforcement of clockPrecision.
Specifically, setting laxPrecision to true will cause the timestamp handler to make a best effort to enforce Expires even if it is set to an increment smaller than can be reliably enforced given the clock precision. The default value is false.
public void setClockPrecision(long clockPrecision)
public void setClockSynchronized(boolean b)
b
- synchronize clock or notpublic void setLaxPrecision(boolean b)
public void setMaxProcessingDelay(long maxProcessingDelay)
public void setValidityPeriod(int validityPeriod)
validityPeriod
-
|
Documentation is available at http://e-docs.bea.com/wls/docs90 Copyright 2005 BEA Systems Inc. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |