java.io.Serializable
public interface JwsContext
extends java.io.Serializable
Modifier and Type | Method | Description |
---|---|---|
void |
finishConversation() |
Deprecated.
Marks the current conversation instance as requiring removal after
the currently executing method or event handler returns.
|
java.security.Principal |
getCallerPrincipal() |
Deprecated.
Returns the security principal associated with the current method
invocation if authentication was performed.
|
long |
getCurrentAge() |
Deprecated.
Returns the conversation's current age (in seconds).
|
long |
getCurrentIdleTime() |
Deprecated.
Gets the number of seconds since the last client request, or since
the conversation's maximum idle time was reset.
|
org.w3c.dom.Element[] |
getInputHeaders() |
Deprecated.
Returns the SOAP headers that arrived with the current
method invocation message.
|
Logger |
getLogger(java.lang.String name) |
Deprecated.
use java.util.logging
|
long |
getMaxAge() |
Deprecated.
Gets the time representing the longest the conversation
may remain active before finishing.
|
long |
getMaxIdleTime() |
Deprecated.
Gets the number of seconds that the conversation can remain idle
before finishing due to client inactivity.
|
javax.xml.rpc.handler.MessageContext |
getMessageContext() |
Deprecated.
Return the message context currently being processed.
|
Protocol |
getProtocol() |
Deprecated.
Gets the protocol of the current request.
|
ServiceHandle |
getService() |
Deprecated.
Returns a ServiceHandle instance for the currently active service
instance.
|
boolean |
getUnderstoodInputHeaders() |
Deprecated.
Returns the value most recently set by a call to
|
boolean |
isCallerInRole(java.lang.String roleName) |
Deprecated.
Returns true if the authenticated principal is within the specified
security role.
|
boolean |
isFinished() |
Deprecated.
Returns whether or not this conversation instance has had finish()
called on it (indicating that code has requested termination
of this conversation instance).
|
void |
resetIdleTime() |
Deprecated.
Resets the timer measuring the number of seconds since the
last activity for the current conversation.
|
void |
setMaxAge(java.lang.String duration) |
Deprecated.
Sets a conversation's maximum age by specifying a duration as a string.
|
void |
setMaxAge(java.util.Date date) |
Deprecated.
Sets a new maximum age for the conversation to an absolute Date.
|
void |
setMaxIdleTime(long seconds) |
Deprecated.
Sets the number of seconds that the conversation can remain idle
before finishing due to client inactivity.
|
void |
setMaxIdleTime(java.lang.String duration) |
Deprecated.
Sets the number of seconds (as a String) that the conversation can
remain idle before finishing due to client inactivity.
|
void |
setOutputHeaders(org.w3c.dom.Element[] headers) |
Deprecated.
Set the SOAP headers to be sent with outgoing messages to the client.
|
void |
setUnderstoodInputHeaders(boolean understood) |
Deprecated.
Indicates whether input headers were understood.
|
boolean isFinished()
true
if the conversation has finished;
false
if it hasn't.void finishConversation()
@conversation phase="finish"
tag.void setMaxAge(java.util.Date date) throws java.lang.IllegalStateException, java.lang.IllegalArgumentException
date
- The time after which the conversation should finish; null
to disable the age timeout.java.lang.IllegalStateException
- if the method is called from a service
instance that is not conversational.java.lang.IllegalArgumentException
- If this method has passed
an illegal or inappropriate argument.void setMaxAge(java.lang.String duration) throws java.lang.IllegalStateException, java.lang.IllegalArgumentException
duration
- The period after which the conversation will finish.java.lang.IllegalStateException
- if the method is called from a
service instance that is not conversational.java.lang.IllegalArgumentException
- If this method has passed
an illegal or inappropriate argument.long getMaxAge() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- if the method is called from a
service instance that is not conversational.long getCurrentAge() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- If the method is called
from a service instance that is not conversational.void resetIdleTime() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- if the method is called from a service
instance that is not conversational.void setMaxIdleTime(long seconds) throws java.lang.IllegalStateException, java.lang.IllegalArgumentException
setMaxIdleTime
or
setMaxIdleTime
method.
resetIdleTime
method is called.seconds
- The number of seconds the conversation can remain
idle before it will expire.java.lang.IllegalStateException
- if the method is called from a
service instance that is not conversational.java.lang.IllegalArgumentException
- If this method has passed
an illegal or inappropriate argument.void setMaxIdleTime(java.lang.String duration) throws java.lang.IllegalStateException, java.lang.IllegalArgumentException
setMaxIdleTime
or
setMaxIdleTime
method.
resetIdleTime
method is called.duration
- The number of seconds the conversation can remain
idle before it will expire.java.lang.IllegalStateException
- if the method is called from a
service instance that is not conversational.java.lang.IllegalArgumentException
- If this method has passed
an illegal or inappropriate argument.long getMaxIdleTime() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- if the method is called from a
service instance that is not conversational.long getCurrentIdleTime() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- if the method is called from a
service instance that is not conversational.java.security.Principal getCallerPrincipal()
boolean isCallerInRole(java.lang.String roleName)
roleName
- The name of the security role against which
to check the authenticated principal.true
if the principal is within the specified security
role; false
if they are not.ServiceHandle getService()
@Deprecated Logger getLogger(java.lang.String name)
name
- The name of the category by which log
messages should be grouped.org.w3c.dom.Element[] getInputHeaders()
void setUnderstoodInputHeaders(boolean understood)
true
,
then a SOAP fault will be generated.understood
- true
to indicate that "mustUnderstand"
headers were understood; false
to indicate they weren't.boolean getUnderstoodInputHeaders()
false
if
JwsContext.setUnderstoodInputHeaders() has not been called.void setOutputHeaders(org.w3c.dom.Element[] headers)
headers
- An array of org.w3c.dom.Element objects
containing valid SOAP headers.Protocol getProtocol()
javax.xml.rpc.handler.MessageContext getMessageContext()