org.picketlink.trust.jbossws

Class PicketLinkDispatch.PLMessageContext

java.lang.Object

org.picketlink.trust.jbossws.PicketLinkDispatch.PLMessageContext

All Implemented Interfaces:

Map<String,Object>, MessageContext, SOAPMessageContext

Enclosing class:

PicketLinkDispatch

public static class PicketLinkDispatch.PLMessageContext
extends Object
implements MessageContext, SOAPMessageContext

Nested Class Summary

Nested classes/interfaces inherited from interface javax.xml.ws.handler.MessageContext

MessageContext.Scope

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from interface javax.xml.ws.handler.MessageContext

HTTP_REQUEST_HEADERS, HTTP_REQUEST_METHOD, HTTP_RESPONSE_CODE, HTTP_RESPONSE_HEADERS, INBOUND_MESSAGE_ATTACHMENTS, MESSAGE_OUTBOUND_PROPERTY, OUTBOUND_MESSAGE_ATTACHMENTS, PATH_INFO, QUERY_STRING, REFERENCE_PARAMETERS, SERVLET_CONTEXT, SERVLET_REQUEST, SERVLET_RESPONSE, WSDL_DESCRIPTION, WSDL_INTERFACE, WSDL_OPERATION, WSDL_PORT, WSDL_SERVICE

Constructor Summary

Constructors

Constructor and Description
PLMessageContext()

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsProperty(String name)
boolean	containsValue(Object value)
Set<Map.Entry<String,Object>>	entrySet()
Object	get(Object key)
Object[]	getHeaders(QName header, JAXBContext context, boolean allRoles) Gets headers that have a particular qualified name from the message in the message context.
SOAPMessage	getMessage() Gets the SOAPMessage from this message context.
Object	getProperty(String name)
Iterator	getPropertyNames()
Set<String>	getRoles() Gets the SOAP actor roles associated with an execution of the handler chain.
MessageContext.Scope	getScope(String name) Gets the scope of a property.
boolean	isEmpty()
Set<String>	keySet()
Object	put(String key, Object value)
void	putAll(Map<? extends String,? extends Object> m)
Object	remove(Object key)
void	removeProperty(String name)
void	setMessage(SOAPMessage message) Sets the SOAPMessage in this message context
void	setProperty(String name, Object value)
void	setScope(String name, MessageContext.Scope scope) Sets the scope of a property.
int	size()
Collection<Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

PLMessageContext

public PLMessageContext()

Method Detail

size

public int size()

Specified by:

size in interface Map<String,Object>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<String,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

put

public Object put(String key,
                  Object value)

Specified by:

put in interface Map<String,Object>

remove

public Object remove(Object key)

Specified by:

remove in interface Map<String,Object>

putAll

public void putAll(Map<? extends String,? extends Object> m)

Specified by:

putAll in interface Map<String,Object>

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

keySet

public Set<String> keySet()

Specified by:

keySet in interface Map<String,Object>

values

public Collection<Object> values()

Specified by:

values in interface Map<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

setScope

public void setScope(String name,
                     MessageContext.Scope scope)

Description copied from interface: MessageContext

Sets the scope of a property.

Specified by:

setScope in interface MessageContext

Parameters:

name - Name of the property associated with the MessageContext

scope - Desired scope of the property

getScope

public MessageContext.Scope getScope(String name)

Description copied from interface: MessageContext

Gets the scope of a property.

Specified by:

getScope in interface MessageContext

Parameters:

name - Name of the property

Returns:

Scope of the property

containsProperty

public boolean containsProperty(String name)

getProperty

public Object getProperty(String name)

getPropertyNames

public Iterator getPropertyNames()

removeProperty

public void removeProperty(String name)

setProperty

public void setProperty(String name,
                        Object value)

getMessage

public SOAPMessage getMessage()

Description copied from interface: SOAPMessageContext

Gets the SOAPMessage from this message context. Modifications to the returned SOAPMessage change the message in-place, there is no need to susequently call setMessage.

Specified by:

getMessage in interface SOAPMessageContext

Returns:

Returns the SOAPMessage; returns null if no SOAPMessage is present in this message context

setMessage

public void setMessage(SOAPMessage message)

Description copied from interface: SOAPMessageContext

Sets the SOAPMessage in this message context

Specified by:

setMessage in interface SOAPMessageContext

Parameters:

message - SOAP message

getHeaders

public Object[] getHeaders(QName header,
                           JAXBContext context,
                           boolean allRoles)

Description copied from interface: SOAPMessageContext

Gets headers that have a particular qualified name from the message in the message context. Note that a SOAP message can contain multiple headers with the same qualified name.

Specified by:

getHeaders in interface SOAPMessageContext

Parameters:

header - The XML qualified name of the SOAP header(s).

context - The JAXBContext that should be used to unmarshall the header

allRoles - If true then returns headers for all SOAP roles, if false then only returns headers targetted at the roles currently being played by this SOAP node, see getRoles.

Returns:

An array of unmarshalled headers; returns an empty array if no message is present in this message context or no headers match the supplied qualified name.

getRoles

public Set<String> getRoles()

Description copied from interface: SOAPMessageContext

Gets the SOAP actor roles associated with an execution of the handler chain. Note that SOAP actor roles apply to the SOAP node and are managed using SOAPBinding.setRoles(java.util.Set<java.lang.String>) and SOAPBinding.getRoles(). Handler instances in the handler chain use this information about the SOAP actor roles to process the SOAP header blocks. Note that the SOAP actor roles are invariant during the processing of SOAP message through the handler chain.

Specified by:

getRoles in interface SOAPMessageContext

Returns:

Array of String for SOAP actor roles