xdi2.client.impl

Class ManipulationContext

java.lang.Object

xdi2.client.impl.ManipulationContext

All Implemented Interfaces:

Serializable

public final class ManipulationContext
extends Object
implements Serializable

Manipulators can use the ManipulationContext to store and share state. The ManipulationContext is created before a message is sent. It contains the current position in the manipulation process, and attributes associated with various stages.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static ManipulationContext	createManipulationContext()
Message	getCurrentMessage()
MessageEnvelope	getCurrentMessageEnvelope()
List<MessageEnvelope>	getCurrentMessageEnvelopes()
List<Message>	getCurrentMessages()
Operation	getCurrentOperation()
Throwable	getException()
Message	getExceptionMessage()
MessageEnvelope	getExceptionMessageEnvelope()
Object	getManipulationContextAttribute(String key)
Map<String,Object>	getManipulationContextAttributes()
Object	getMessageAttribute(String key)
Map<String,Object>	getMessageAttributes()
Object	getMessageEnvelopeAttribute(String key)
Map<String,Object>	getMessageEnvelopeAttributes()
String	getTraceBlock()
String	getTraceLine()
boolean	isTopManipulationPosition()
void	popMessage()
void	popMessageEnvelope()
Throwable	processException(Throwable ex)
void	pushMessage(Message message, String comment)
void	pushMessageEnvelope(MessageEnvelope messageEnvelope, String comment)
void	putManipulationContextAttribute(String key, Object value)
void	putMessageAttribute(String key, Object value)
void	putMessageEnvelopeAttribute(String key, Object value)
void	resetManipulationContextAttributes()
void	resetMessageAttributes()
void	resetMessageEnvelopeAttributes()
void	setManipulationContextAttributes(Map<String,Object> manipulationContextAttributes)
void	setMessageAttributes(Map<String,Object> messageAttributes)
void	setMessageEnvelopeAttributes(Map<String,Object> messageEnvelopeAttributes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createManipulationContext

public static ManipulationContext createManipulationContext()

getManipulationContextAttribute

public Object getManipulationContextAttribute(String key)

putManipulationContextAttribute

public void putManipulationContextAttribute(String key,
                                            Object value)

getManipulationContextAttributes

public Map<String,Object> getManipulationContextAttributes()

setManipulationContextAttributes

public void setManipulationContextAttributes(Map<String,Object> manipulationContextAttributes)

resetManipulationContextAttributes

public void resetManipulationContextAttributes()

getMessageEnvelopeAttribute

public Object getMessageEnvelopeAttribute(String key)

putMessageEnvelopeAttribute

public void putMessageEnvelopeAttribute(String key,
                                        Object value)

getMessageEnvelopeAttributes

public Map<String,Object> getMessageEnvelopeAttributes()

setMessageEnvelopeAttributes

public void setMessageEnvelopeAttributes(Map<String,Object> messageEnvelopeAttributes)

resetMessageEnvelopeAttributes

public void resetMessageEnvelopeAttributes()

getMessageAttribute

public Object getMessageAttribute(String key)

putMessageAttribute

public void putMessageAttribute(String key,
                                Object value)

getMessageAttributes

public Map<String,Object> getMessageAttributes()

setMessageAttributes

public void setMessageAttributes(Map<String,Object> messageAttributes)

resetMessageAttributes

public void resetMessageAttributes()

getException

public Throwable getException()

processException

public Throwable processException(Throwable ex)

pushMessageEnvelope

public void pushMessageEnvelope(MessageEnvelope messageEnvelope,
                                String comment)

pushMessage

public void pushMessage(Message message,
                        String comment)

popMessageEnvelope

public void popMessageEnvelope()

popMessage

public void popMessage()

getCurrentMessageEnvelope

public MessageEnvelope getCurrentMessageEnvelope()

getCurrentMessageEnvelopes

public List<MessageEnvelope> getCurrentMessageEnvelopes()

getCurrentMessage

public Message getCurrentMessage()

getCurrentMessages

public List<Message> getCurrentMessages()

getCurrentOperation

public Operation getCurrentOperation()

getExceptionMessageEnvelope

public MessageEnvelope getExceptionMessageEnvelope()

getExceptionMessage

public Message getExceptionMessage()

isTopManipulationPosition

public boolean isTopManipulationPosition()

getTraceLine

public String getTraceLine()

getTraceBlock

public String getTraceBlock()